Sokoban Game : Java

Sokoban aka Boxworld is a type of puzzle, in which the player pushes boxes around in a warehouse, trying to get them to designated locations. It has been developed in Java.

Rules

•      The player can move up, down, left, and right.

•      He can’t pass through walls or boxes.

•      He can push only one box at a time, not pull.

•      The puzzle is solved when all boxes are at storage locations.

 

Screenshots

 

 

Source Code

 

Sokoban.java

/* * Title : Sokoban Game * Author : Manish Kumar * Blog : www.justdocodings.blogspot.com */ import javax.swing.*; import java.awt.*; import java.awt.event.*; public class Sokoban extends JPanel implements ActionListener { static final int UNITX = 9; static final int UNITY = 9; static final int IMAGE_SIZE = 50; static final int SCREEN_WIDTH = UNITX*IMAGE_SIZE+50; static final int SCREEN_HEIGHT = UNITX*IMAGE_SIZE+100; static final int BLOCK = 1; static final int FRUIT = 2; static final int BASKET = 3; static final int HUMAN = 4; static final int HUMAN_ON_FRUIT = 5; static final int FRUIT_IN_BASKET = 6; static final int EMPTY = 0; static final int DELAY = 10; static final int MOVE_LEFT = 1; static final int MOVE_RIGHT = 2; static final int MOVE_UP = 3; static final int MOVE_DOWN = 4; Image block, fruit, basket, human, humanonfruit, fruitinbasket; Timer timer; public int[][] grid = new int[UNITX][UNITY]; public int[][] undo = new int[UNITX][UNITY]; int human_x, human_y; boolean pause =false; boolean running = false; boolean isLevelCompleted = false; int _level = 1; int score = 0; /// // menubar static JMenuBar mb; // JMenu static JMenu mnu,help; // CheckBoxMenu items static JRadioButtonMenuItem l1, l2, l3, l4, l5; static JMenuItem abt,hlp,_undo; Sokoban() { addKeyListener(new SAdapter()); setBackground(Color.white); setFocusable(true); setPreferredSize(new Dimension(SCREEN_WIDTH, SCREEN_HEIGHT)); loadImage(); startGame(); addMenu(); } public void addMenu() { // create a menubar mb = new JMenuBar(); // create a menu mnu = new JMenu("Menu"); help = new JMenu("Help"); l1 = new JRadioButtonMenuItem("Level 1",true); l2 = new JRadioButtonMenuItem("Level 2",false); l3 = new JRadioButtonMenuItem("Level 3",false); l4 = new JRadioButtonMenuItem("Level 4",false); l5 = new JRadioButtonMenuItem("Level 5",false); _undo = new JMenuItem("Undo"); hlp = new JMenuItem("View Help"); abt = new JMenuItem("About"); l1.setActionCommand("levelOne"); l2.setActionCommand("levelTwo"); l3.setActionCommand("levelThree"); l4.setActionCommand("levelFour"); l5.setActionCommand("levelFive"); _undo.setActionCommand("undogame"); hlp.setActionCommand("viewHelp"); abt.setActionCommand("about"); // Group the Radio Button Menu ButtonGroup group = new ButtonGroup(); group.add(l1); group.add(l2); group.add(l3); group.add(l4); group.add(l5); l1.addActionListener(this); l2.addActionListener(this); l3.addActionListener(this); l4.addActionListener(this); l5.addActionListener(this); hlp.addActionListener(this); abt.addActionListener(this); _undo.addActionListener(this); // add menu items to menu mnu.add(_undo); mnu.add(l1); mnu.add(l2); mnu.add(l3); mnu.add(l4); mnu.add(l5); help.add(hlp); help.add(abt); // add menu to menu bar mb.add(mnu); mb.add(help); } void level(int n) { reset(); if(n==1) { human_x = 5; human_y = 5; int block_row[]={1,2,3,4,4,4,5,6,6,6,6,7,8,8,8,7,6,5,5,5,4,3,3,3,3,2,1,1}; int block_col[]={3,3,3,3,2,1,1,1,2,3,4,4,4,5,6,6,6,6,7,8,8,8,7,6,5,5,5,4}; int fruit_row[]={2,5,7,4}; int fruit_col[]={4,2,5,7}; int basket_row[]={4,5,6,4}; int basket_col[]={4,4,5,6}; int human_row[]={5}; int human_col[]={5}; placeObject(block_row, block_col, BLOCK); placeObject(fruit_row, fruit_col, FRUIT); placeObject(basket_row, basket_col, BASKET); placeObject(human_row, human_col, HUMAN); } if(n==2) { human_x = 3; human_y = 3; int block_row[]={1,1,1,1,2,3,4,4,5,6,7,8,8,8,8,8,8,7,6,5,4,3,2,2,4,5}; int block_col[]={2,3,4,5,5,5,5,6,6,6,6,6,5,4,3,2,1,1,1,1,1,1,1,2,2,2}; int fruit_row[]={6,7,7,7}; int fruit_col[]={2,2,3,5}; int basket_row[]={3,4,5,6}; int basket_col[]={4,3,4,3}; int human_row[]={3}; int human_col[]={3}; placeObject(block_row, block_col, BLOCK); placeObject(fruit_row, fruit_col, FRUIT); placeObject(basket_row, basket_col, BASKET); placeObject(human_row, human_col, HUMAN); l2.setSelected(true); } if(n==3) { human_x = 2; human_y = 3; int block_row[]={1,2,3,4,4,5,6,7,8,8,8,8,8,8,8,8,7,6,5,4,4,3,2,2,2,1,1,1,4,5,4,5,6}; int block_col[]={2,2,2,2,1,1,1,1,1,2,3,4,5,6,7,8,8,8,8,8,7,7,7,6,5,5,4,3,3,3,5,5,6}; int fruit_row[]={5,6,7}; int fruit_col[]={2,2,2}; int basket_row[]={3,6,7}; int basket_col[]={4,3,6}; int human_row[]={2}; int human_col[]={3}; placeObject(block_row, block_col, BLOCK); placeObject(fruit_row, fruit_col, FRUIT); placeObject(basket_row, basket_col, BASKET); placeObject(human_row, human_col, HUMAN); l3.setSelected(true); } if(n==4) { human_x = 2; human_y = 6; int block_row[]={1,1,1,1,1,2,3,3,4,5,6,6,7,7,7,7,7,6,5,5,5,4,3,2,2,2}; int block_col[]={3,4,5,6,7,7,7,8,8,8,8,7,7,6,5,4,3,3,3,2,1,1,1,1,2,3}; int fruit_row[]={3,4,4}; int fruit_col[]={5,4,6}; int basket_row[]={3,4,5}; int basket_col[]={4,5,6}; int fruit_in_basket_row[]={5}; int fruit_in_basket_col[]={5}; int human_row[]={2}; int human_col[]={6}; placeObject(block_row, block_col, BLOCK); placeObject(fruit_row, fruit_col, FRUIT); placeObject(basket_row, basket_col, BASKET); placeObject(human_row, human_col, HUMAN); placeObject(fruit_in_basket_row, fruit_in_basket_col, FRUIT_IN_BASKET); l4.setSelected(true); } if(n==5) { human_x = 7; human_y = 4; int block_row[]={1,1,1,1,2,3,3,4,5,5,6,7,8,8,8,8,8,8,8,8,7,6,5,5,4,3,3,2,6}; int block_col[]={3,4,5,6,6,6,7,7,7,8,8,8,8,7,6,5,4,3,2,1,1,1,1,2,2,2,3,3,4}; int fruit_row[]={2,2,3,4}; int fruit_col[]={4,5,5,6}; int basket_row[]={4,5,6,6}; int basket_col[]={5,4,5,6}; int human_row[]={7}; int human_col[]={4}; placeObject(block_row, block_col, BLOCK); placeObject(fruit_row, fruit_col, FRUIT); placeObject(basket_row, basket_col, BASKET); placeObject(human_row, human_col, HUMAN); l5.setSelected(true); } for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; } public void startGame() { running = true; timer = new Timer(DELAY, this); timer.start(); level(_level); } public void reset() { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) { grid[i][j]=EMPTY; undo[i][j]=EMPTY; } if(running == false) { running=true; timer.start(); } } public void undoTheGame() { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) { grid[i][j]=undo[i][j]; if(undo[i][j]==HUMAN || undo[i][j]==HUMAN_ON_FRUIT) { human_x=i; human_y=j; } } } public void placeObject(int arrx[], int arry[], int objType) { for(int i=0;i<arrx.length;i++) grid[arrx[i]][arry[i]] = objType; } public void move(int dir) { int t=0,l=0; int flag=1; if(dir==MOVE_LEFT) t=-1; else if(dir==MOVE_RIGHT) t=1; else if(dir==MOVE_UP) l=-1; else if(dir==MOVE_DOWN) l=1; if(grid[human_x+t][human_y+l]==BLOCK) { } else if(grid[human_x+t][human_y+l]==EMPTY) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; grid[human_x+t][human_y+l]=HUMAN; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; human_x+=t; human_y+=l; } else if(grid[human_x+t][human_y+l]==BASKET) { if(grid[human_x+(2*t)][human_y+(2*l)]==BLOCK) { } else if(grid[human_x+(2*t)][human_y+(2*l)]==EMPTY) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; grid[human_x+(2*t)][human_y+(2*l)] = BASKET; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; human_x+=t; human_y+=l; grid[human_x][human_y] = HUMAN; } else if(grid[human_x+(2*t)][human_y+(2*l)]==BASKET) { } else if(grid[human_x+(2*t)][human_y+(2*l)]==FRUIT) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; grid[human_x+(2*t)][human_y+(2*l)] = FRUIT_IN_BASKET; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; human_x+=t; human_y+=l; grid[human_x][human_y] = HUMAN; } else if(grid[human_x+(2*t)][human_y+(2*l)]==FRUIT_IN_BASKET) { } } else if(grid[human_x+t][human_y+l]==FRUIT) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; grid[human_x+t][human_y+l] = HUMAN_ON_FRUIT; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; human_x+=t; human_y+=l; } else if(grid[human_x+t][human_y+l]==FRUIT_IN_BASKET) { if(grid[human_x+(2*t)][human_y+(2*l)]==BLOCK) { } else if(grid[human_x+(2*t)][human_y+(2*l)]==EMPTY) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; grid[human_x+t][human_y+l] = HUMAN_ON_FRUIT; grid[human_x+(2*t)][human_y+(2*l)] = BASKET; human_x+=t; human_y+=l; } else if(grid[human_x+(2*t)][human_y+(2*l)]==BASKET) { } else if(grid[human_x+(2*t)][human_y+(2*l)]==FRUIT_IN_BASKET) { } else if(grid[human_x+(2*t)][human_y+(2*l)]==FRUIT) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) undo[i][j]=grid[i][j]; grid[human_x+(2*t)][human_y+(2*l)]=FRUIT_IN_BASKET; grid[human_x+t][human_y+l]=HUMAN_ON_FRUIT; if(grid[human_x][human_y]==HUMAN) grid[human_x][human_y]=EMPTY; else if(grid[human_x][human_y]==HUMAN_ON_FRUIT) grid[human_x][human_y]=FRUIT; human_x+=t; human_y+=l; } } for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) if(grid[i][j]==FRUIT||grid[i][j]==HUMAN_ON_FRUIT) { flag=0; break; } if(flag==1) { isLevelCompleted=true; repaint(); } } public void loadImage() { ImageIcon imgblock = new ImageIcon("block.png"); block = imgblock.getImage(); ImageIcon imghuman = new ImageIcon("human.png"); human = imghuman.getImage(); ImageIcon imghumonfruit = new ImageIcon("humanonfruit.png"); humanonfruit = imghumonfruit.getImage(); ImageIcon imgfruitinbasket = new ImageIcon("fruitinbasket.png"); fruitinbasket = imgfruitinbasket.getImage(); ImageIcon imgbasket = new ImageIcon("basket.png"); basket = imgbasket.getImage(); ImageIcon imgfruit = new ImageIcon("fruit.png"); fruit = imgfruit.getImage(); } public void doDrawings(Graphics g) { if(_level<6) { for(int i=0;i<UNITX;i++) for(int j=0;j<UNITY;j++) { if(grid[i][j]==HUMAN) g.drawImage(human,i*IMAGE_SIZE,j*IMAGE_SIZE,this); if(grid[i][j]==BLOCK) g.drawImage(block,i*IMAGE_SIZE,j*IMAGE_SIZE,this); if(grid[i][j]==BASKET) g.drawImage(basket,i*IMAGE_SIZE,j*IMAGE_SIZE,this); if(grid[i][j]==FRUIT) g.drawImage(fruit,i*IMAGE_SIZE,j*IMAGE_SIZE,this); if(grid[i][j]==HUMAN_ON_FRUIT) g.drawImage(humanonfruit,i*IMAGE_SIZE,j*IMAGE_SIZE,this); if(grid[i][j]==FRUIT_IN_BASKET) g.drawImage(fruitinbasket,i*IMAGE_SIZE,j*IMAGE_SIZE,this); } showScore(g); Toolkit.getDefaultToolkit().sync(); } else { _level=1; gameWon(g); } } //@Override public void paintComponent(Graphics g) { super.paintComponent(g); doDrawings(g); } public void gameWon(Graphics g) { //Score g.setColor(Color.blue); g.setFont(new Font("Ink Free", Font.BOLD, 30)); FontMetrics metrics1 = getFontMetrics(g.getFont()); g.drawString("Score: " + score, (SCREEN_WIDTH - metrics1.stringWidth("Score: " + score)) / 2, g.getFont().getSize()+50); //Game Over text g.setColor(Color.red); g.setFont(new Font("Ink Free", Font.BOLD, 45)); FontMetrics metrics2 = getFontMetrics(g.getFont()); g.drawString("You Won", (SCREEN_WIDTH - metrics2.stringWidth("You Won")) / 2, SCREEN_HEIGHT / 2); } public void showScore(Graphics g) { //Score g.drawRect(0,SCREEN_HEIGHT,SCREEN_WIDTH,SCREEN_HEIGHT); g.setColor(Color.green); g.fillRect(0,SCREEN_HEIGHT,SCREEN_WIDTH,SCREEN_HEIGHT); g.setColor(Color.red); g.setFont(new Font("Ink Free", Font.BOLD,15)); g.drawString("Score: "+ score,10,SCREEN_HEIGHT-30); g.drawString("Level: "+ _level,SCREEN_WIDTH-100,SCREEN_HEIGHT-30); } public static void pause(int ms){ try{ Thread.sleep(ms); }catch(InterruptedException e) { Thread.currentThread().interrupt(); } } @Override public void actionPerformed(ActionEvent e) { if(isLevelCompleted==true) { pause(1000); isLevelCompleted=false; _level++; score+=10; if(_level>5) { running=false; timer.stop(); } else { level(_level); } } String s = e.getActionCommand(); if(s!=null) { switch(s) { case "levelOne" : reset(); _level=1; level(_level); score=0; break; case "levelTwo" : reset(); _level=2; level(_level); score=0; break; case "levelThree" : reset(); _level=3; level(_level); score=0; break; case "levelFour" : reset(); _level=4; level(_level); score=0; break; case "levelFive" : reset(); _level=5; level(_level); score=0; break; case "undogame" : undoTheGame(); break; case "about" : JOptionPane.showMessageDialog(this,"Title : Sokoban Game \n Author : Manish Kumar \n Blog : www.justdocodings.blopspot.com","About", JOptionPane.INFORMATION_MESSAGE); break; case "viewHelp" : JOptionPane.showMessageDialog(this,"Use arrow keys for movement, \n space key to pause game \n and Z to undo the game.","Help",JOptionPane.INFORMATION_MESSAGE); break; } } repaint(); } public class SAdapter extends KeyAdapter { @Override public void keyPressed(KeyEvent e) { switch (e.getKeyCode()) { case KeyEvent.VK_LEFT: move(MOVE_LEFT); break; case KeyEvent.VK_RIGHT: move(MOVE_RIGHT); break; case KeyEvent.VK_UP: move(MOVE_UP); break; case KeyEvent.VK_DOWN: move(MOVE_DOWN); break; case KeyEvent.VK_Z: undoTheGame(); break; case KeyEvent.VK_SPACE: if(pause==false) { timer.stop(); pause = true; } else if(pause==true) { timer.start(); pause=false; } break; } } } }

SokobanMain.java

/* * Title : Sokoban Game * Author : Manish Kumar * Blog : www.justdocodings.blogspot.com */ import javax.swing.*; public class SokobanMain extends JFrame { public SokobanMain() { add(new Sokoban()); setResizable(false); pack(); setTitle("Sokoban"); setLocationRelativeTo(null); setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); } public static void main(String[] args) { JFrame jf = new SokobanMain(); jf.setJMenuBar(Sokoban.mb); jf.setVisible(true); } }

Functionality

• To move left, press Left arrow key.

• To move right, press Right arrow key.

• To move up, press Up arrow key.

• To move down, press Down arrow key.

• To pause the game, press Space bar key.

• To undo the game press, Z key.

Downloads

Click here to view and download the source code of Sokoban Game (35 KB).

Click here to view and download the images of Sokoban Game (22KB).