Skip to content

added sokoban file #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
D-W-Chiang wants to merge 11 commits into
base: main
Choose a base branch
from
+375 −1
Open

added sokoban file #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
839d5c8
Add files via upload
D-W-Chiang Mar 18, 2026
2af25c1
feat: sokoban model run and puzzle setup
JesterCoding Mar 19, 2026
c64a41e
Merge branch 'main' of github.com:GamesCrafters/GamesmanPy into sp26-…
JesterCoding Mar 20, 2026
b40d993
feat: adjusted for autogui
JesterCoding Mar 20, 2026
5f1242d
refactor: change name of file to just sokoban
JesterCoding Mar 21, 2026
0f4a904
feat: changes existing hash to cover larger boards
JesterCoding Mar 21, 2026
185587d
optimizations and correction for infinity on gui side
JesterCoding Mar 31, 2026
dc62207
refactor: remove all excess code
JesterCoding Apr 22, 2026
bf1f2c8
feat: added new levels
JesterCoding Apr 22, 2026
f4e5d9b
feat: tried to add a tenth level
JesterCoding Apr 23, 2026
08af8fc
final submission before PR
JesterCoding Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ wheels/

# Virtual environments
.venv
venv

# DB files
*.db
Expand Down
2 changes: 2 additions & 0 deletions games/src/games/game_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from .pancakes import Pancakes
from .chipschallenge import ChipsChallenge
from .test import Test
from .sokoban import Sokoban
from models import *

game_list = {
Expand All @@ -11,6 +12,7 @@
"horses": Horses,
"pancakes": Pancakes,
"test": Test,
"sokoban": Sokoban
}

def validate(game_id: str, variant_id: str) -> bool:
Expand Down
370 changes: 370 additions & 0 deletions games/src/games/sokoban.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,370 @@
from models import Game, Value, StringMode
from typing import Optional
import time
import math

class Sokoban(Game):
id = 'sokoban'
variants = ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]
n_players = 1
cyclic = True

def __init__(self, variant_id: str):
"""
Define instance variables and the starting board.
"""
if variant_id not in Sokoban.variants:
raise ValueError("Variant not defined")

self._variant_id = variant_id

# Directions: Right, Down, Left, Up
self.dxdy = [(1, 0), (0, 1), (-1, 0), (0, -1)]
self.dirs = {(1, 0): "R", (0, 1): "D", (-1, 0): "L", (0, -1): "U"}

match self._variant_id:
case "1": # equivalent to Level 1 from the online Sokoban player
self.column_size = 6
self.row_size = 7
self.starting_pos = (
"## #"
".@$ #"
"## $.#"
".##$ #"
" # . #"
"$ *$$."
" . "
)
case "2":
self.column_size = 8
self.row_size = 8
self.starting_pos = (
" ### "
" # # "
" #.# "
"###$# "
"#. $@###"
"#### #"
" # #"
" #####"
)

case "3":
self.column_size = 11
self.row_size = 10
self.starting_pos = (
"########## "
"# # "
"# $$ $ # "
"# ### "
"#### # "
" # @ # "
" # $ # "
"#### ####"
"#.... #"
"###########"
)
case "4":
self.column_size = 9
self.row_size = 9
self.starting_pos = (
" ##### "
" # # "
"###$ # "
"# $ # "
"# @ ###"
"##### $ #"
" ### $ #"
" #.... #"
" #######"
)
#" "
case "5":
self.column_size = 23
self.row_size = 12
self.starting_pos = (
" ##### "
" # # "
" #$ # "
" ### $### "
" # $ $ # "
"### # ### # "
"# # ### # ######"
"# # ### ######## ..#"
"# $ $ ..#"
"##### #### #@#### ..#"
" # ### ######"
" ######### "
)

case "6":
self.column_size = 9
self.row_size = 8
self.starting_pos = (
" #### "
" # # "
"### ####"
"# +* #"
"# $.. $ #"
"### $####"
" # # "
" #### "
)

case "7":
self.column_size = 6
self.row_size = 7
self.starting_pos = (
"#### "
"#@ ###"
"# $$.#"
"# $.#"
"# $ .#"
"# # .#"
"######"
)

case "8":
self.column_size = 9
self.row_size = 8
self.starting_pos = (
" ##### "
"####. ##"
"# $.$. #"
"#@$# #$ #"
"# $. . #"
"####$#$ #"
" #. . #"
" #######"
)

case "9":
self.column_size = 9
self.row_size = 8
self.starting_pos = (
" ######"
"####. @#"
"# $$$ #"
"#.##.##.#"
"# $ #"
"# $.# ##"
"### # "
" ###### "
)

case "10":
self.column_size = 7
self.row_size = 7
self.starting_pos = (
"#######"
"#. . .#"
"# $$$ #"
"#.$@$.#"
"# $$$ #"
"#. . .#"
"#######"
)

# roughly 4 billion states
case "11":
self.column_size = 11
self.row_size = 9
self.starting_pos = (
" #########"
"### # #"
"# $. * $ #"
"# #.#.#.# #"
"# $ $@$ $ #"
"# #.#.#.# #"
"# $ * .$ #"
"# #######"
"##### "
)

# roughly 28.7 billion states
case "12":
self.column_size = 9
self.row_size = 9
self.starting_pos = (
" ####### "
"## * ##"
"# .@. . #"
"# $ * #"
"#*$$*$$*#"
"# * $ #"
"# . . . #"
"## * ##"
" ####### "
)

#" "
#roughly 40 billion state space
case "13":
self.column_size = 14
self.row_size = 10
self.starting_pos = (
"############ "
"#.. # ###"
"#.. # $ $ #"
"#.. #$#### #"
"#.. @ ## #"
"#.. # # $ #"
"###### ##$ $ #"
" # $ $ $ $ #"
" # # #"
" ############"
)

def start(self) -> str:
"""Returns the starting position of the game."""
return self.starting_pos

def generate_moves(self, position: str) -> list[tuple]:
"""
Returns a list of only the moves that push a box: (box_idx, dx, dy)
"""
moves = []

p_idx = self.get_pos_idx(position)
px, py = p_idx % self.column_size, p_idx // self.column_size

reachable = set()
reachable.add((px, py))
queue = [(px, py)]
head = 0

while head < len(queue):
curr_x, curr_y = queue[head]
head += 1

for dx, dy in self.dxdy:
nx, ny = curr_x + dx, curr_y + dy
if 0 <= nx < self.column_size and 0 <= ny < self.row_size:
if (nx, ny) not in reachable:
n_idx = ny * self.column_size + nx
if position[n_idx] in [' ', '.']:
reachable.add((nx, ny))
queue.append((nx, ny))

for idx, char in enumerate(position):
if char in ['$', '*']:
x = idx % self.column_size
y = idx // self.column_size

for dx, dy in self.dxdy:
player_req_x, player_req_y = x - dx, y - dy
push_target_x, push_target_y = x + dx, y + dy

if (player_req_x, player_req_y) in reachable:
if 0 <= push_target_x < self.column_size and 0 <= push_target_y < self.row_size:
target_idx = push_target_y * self.column_size + push_target_x
if position[target_idx] in [' ', '.', '@', '+']:
moves.append((idx, dx, dy))

return moves

def do_move(self, position: str, move: tuple) -> str:
box_idx, dx, dy = move
pos_list = list(position)

p_idx = self.get_pos_idx(position)
pos_list[p_idx] = '.' if pos_list[p_idx] == '+' else ' '

bx = box_idx % self.column_size
by = box_idx // self.column_size
nx, ny = bx + dx, by + dy
n_idx = ny * self.column_size + nx

if pos_list[n_idx] == '.':
pos_list[n_idx] = '*'
else:
pos_list[n_idx] = '$'

if position[box_idx] == '*':
pos_list[box_idx] = '+'
else:
pos_list[box_idx] = '@'

return "".join(pos_list)

def primitive(self, position: str) -> Optional[Value]:
"""
Returns Value.Win if all boxes are on goals.
Returns Value.Lose if any box is deadlocked in a corner.
Otherwise returns None.
"""
if position.find('$') == -1:
return Value.Win

all_boxes = set()
for i, char in enumerate(position):
if char in ['$', '*']:
all_boxes.add(i)


for y in range(self.row_size):
for x in range(self.column_size):
idx = y * self.column_size + x
if position[idx] == '$':
up = (y == 0) or (position[(y - 1) * self.column_size + x] == '#')
down = (y == self.row_size - 1) or (position[(y + 1) * self.column_size + x] == '#')
left = (x == 0) or (position[y * self.column_size + (x - 1)] == '#')
right = (x == self.column_size - 1) or (position[y * self.column_size + (x + 1)] == '#')

if (up or down) and (left or right):
return Value.Loss

return None


def hash_ext(self, position: str) -> int:
"""
Returns a hash using the Combinatorial Number System (Combinadic).
Generates a dense, collision-free integer for the game state.
"""

p_idx = self.get_pos_idx(position)

box_indices = [i for i, char in enumerate(position) if char in ['$', '*']]

box_indices.sort(reverse=True)

box_rank = 0
total_boxes = len(box_indices)

for i, c in enumerate(box_indices):
k = total_boxes - i
box_rank += math.comb(c, k)

max_p_idx = self.column_size * self.row_size

hash = (box_rank * max_p_idx) + p_idx

return hash

def move_to_string(self, move: tuple, mode: StringMode) -> str:
box_idx, dx, dy = move
direction = self.dirs.get((dx, dy), "?")
if mode == StringMode.AUTOGUI:
return f"M_{box_idx}_{box_idx + dx + dy*self.column_size}_y"
return f"{box_idx}{direction}"

def to_string(self, position: str, mode: StringMode) -> str:

if mode == StringMode.TUI:
board = [position[idx * self.column_size : (idx + 1) * self.column_size] for idx in range(self.row_size)]
return "\n".join(board)
elif mode == StringMode.Readable:
return position.replace(' ', 't').replace('#', 'W').replace("@", "p").replace("$", "b").replace("*", "g").replace("+", "P")
else:
return "1_" + position.replace(' ', 't').replace('#', 'W').replace("@", "p").replace("$", "b").replace("*", "g").replace("+", "P")

def from_string(self, strposition: str) -> str:
clean_pos = strposition.replace('t', ' ').replace('W', '#').replace("p", "@").replace("b", "$").replace("g", "*").replace("P", "+")
return clean_pos.replace("\n", "").replace("\r", "")

def get_pos_idx(self, position: str):
p_idx = position.find('@')
if p_idx == -1:
p_idx = position.find('+')
return p_idx;
Loading