By: Jeremy Nation
Roguelike Sokoban is an ASCII-based Sokoban game that has a look and feel inspired by the roguelike genre, particularly the Sokoban levels in the excellent game NetHack. You can create new maps using a regular text editor.
Please use a recent version of Python 3 when running anything in this
repository. See the Dockerfile for guidance on a specific configuration.
Run
python3 rlsokoban.py
from the root repository directory to play the default levels. To specify a
level file, use the -L option followed by the path to the level file.
There is a requirements-dev.txt file you can install with pip if you want
packages only used for development.
Roguelike Sokoban uses the
curses module for its
display. curses isn't included in the Python distribution for Windows, so
on Windows you might want to use the
Windows Subsystem for Linux or
find some other option.
You can also run this with Docker as described later.
By default, the game will use the level file levels/default-levels.txt. Also
included are many levels that have been adapted from the game
XSokoban, which has been
released into the public domain. These levels are included as
levels/xsokoban$X-$Y.txt and can be loaded with the -L option.
Note: the XSokoban levels were converted using the included
convert_xsokoban.py script and have not all been playtested. They were
originally written to use a different set of Sokoban rules than Roguelike
Sokoban uses. It is possible some of them are unwinnable from the start.
Please let me know if one of the included levels is unwinnable.
You can run the included tests with
python3 run_tests.py
By default, this will just run unit tests, but you can run manual test levels by adding the "--include-manual-tests" option.
To run this with Docker, first build the image from the base directory with:
docker build -t jeremyn/roguelike-sokoban .
Then run a container while mapping the code into it, for example:
docker run -it --rm -v ${PWD}:/workdir jeremyn/roguelike-sokoban
This will give you a Bash prompt in the container in /workdir with the code.
You can also open this project with VS Code in a container with the included devcontainer.json.
GPLv3 or later (see included LICENSE file).