# Terminal Sokoban
`sokoban` is a "graphical" command line program for playing the popular sokoban game in the terminal.
> Sokoban (倉庫番, Sōko-ban, lit. 'warehouse keeper'[1]) is a puzzle video game in which the player pushes boxes around in a warehouse, trying to get them to storage locations. The game was designed in 1981 by Hiroyuki Imabayashi, and first published in December 1982. - Wikipedia: http://en.wikipedia.org/wiki/
## Installation
`sokoban` is only compatible with `python3`, and can be installed through `pip`.
```bash
pip3 install terminal-sokoban
```
You should then be ready to go.
## Play
Run `sokoban` to start playing the game.
```
sokoban
```
There are over `17,991` stages.
`sokoban` has been tested to work on Linux, Mac, and Windows computers.
### Instruction
- Use the arrow keys to move the player around.
- Use the (r) key to reverse a move.
- Use the (z) key to restart a stage.
- Use the (q) key to quit the game.
## Options
Specify which stage to play
```
sokoban 7
```
## Development
- Clone repository.
- Setup poetry and install dependencies.
- Load stage data using `python script/generate.py`.
- Run Game using play instructions above.
## Credits
- [Blessed](https://github.com/jquast/blessed)
- [cursewords](https://github.com/thisisparker/cursewords)
- Levels data from http://sourcecode.se/sokoban/
Raw data
{
"_id": null,
"home_page": "https://github.com/IamAbbey/terminal-sokoban",
"name": "terminal-sokoban",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.12",
"maintainer_email": null,
"keywords": "sokoban, terminal, console, game",
"author": "Abiodun Sotunde",
"author_email": "sotundeabiodun00@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/09/73/10ce691eaaeeb5cc537b101c8a754bbeaed612e4b988a84bdefcfb689ed8/terminal_sokoban-1.1.0.tar.gz",
"platform": null,
"description": "# Terminal Sokoban\n\n`sokoban` is a \"graphical\" command line program for playing the popular sokoban game in the terminal.\n\n> Sokoban (\u5009\u5eab\u756a, S\u014dko-ban, lit.\u2009'warehouse keeper'[1]) is a puzzle video game in which the player pushes boxes around in a warehouse, trying to get them to storage locations. The game was designed in 1981 by Hiroyuki Imabayashi, and first published in December 1982. - Wikipedia: http://en.wikipedia.org/wiki/\n\n\n\n## Installation\n\n`sokoban` is only compatible with `python3`, and can be installed through `pip`.\n\n```bash\npip3 install terminal-sokoban\n```\n\nYou should then be ready to go.\n\n## Play \nRun `sokoban` to start playing the game.\n\n```\nsokoban\n```\n\nThere are over `17,991` stages.\n\n`sokoban` has been tested to work on Linux, Mac, and Windows computers.\n\n### Instruction\n\n- Use the arrow keys to move the player around.\n\n- Use the (r) key to reverse a move.\n\n- Use the (z) key to restart a stage.\n\n- Use the (q) key to quit the game.\n\n\n## Options\n\nSpecify which stage to play\n\n```\nsokoban 7\n```\n\n## Development\n- Clone repository.\n- Setup poetry and install dependencies.\n- Load stage data using `python script/generate.py`.\n- Run Game using play instructions above.\n\n## Credits\n- [Blessed](https://github.com/jquast/blessed)\n- [cursewords](https://github.com/thisisparker/cursewords)\n- Levels data from http://sourcecode.se/sokoban/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A terminal based Sokoban game interface",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/IamAbbey/terminal-sokoban",
"Repository": "https://github.com/IamAbbey/terminal-sokoban"
},
"split_keywords": [
"sokoban",
" terminal",
" console",
" game"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d03500891336cebc30038f9c5389ca7b7ab23b291336c946282e83345e0dc0f2",
"md5": "1abb75a38b9b8ab2ffed2eb9b70b77c3",
"sha256": "46ea0779c778d0ba8c8fc9d97938ed420a87a8b6e8aec9fe8eae64ed71f469d8"
},
"downloads": -1,
"filename": "terminal_sokoban-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1abb75a38b9b8ab2ffed2eb9b70b77c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.12",
"size": 1179462,
"upload_time": "2024-03-29T14:02:21",
"upload_time_iso_8601": "2024-03-29T14:02:21.527876Z",
"url": "https://files.pythonhosted.org/packages/d0/35/00891336cebc30038f9c5389ca7b7ab23b291336c946282e83345e0dc0f2/terminal_sokoban-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "097310ce691eaaeeb5cc537b101c8a754bbeaed612e4b988a84bdefcfb689ed8",
"md5": "c44f96bb5d3f9628d39f7ce916bc245e",
"sha256": "d0ed4eac19156daad35a1a2394a998604aa64f3e59f07e25b87628cd5b2fe0a0"
},
"downloads": -1,
"filename": "terminal_sokoban-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c44f96bb5d3f9628d39f7ce916bc245e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.12",
"size": 995132,
"upload_time": "2024-03-29T14:02:23",
"upload_time_iso_8601": "2024-03-29T14:02:23.849734Z",
"url": "https://files.pythonhosted.org/packages/09/73/10ce691eaaeeb5cc537b101c8a754bbeaed612e4b988a84bdefcfb689ed8/terminal_sokoban-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 14:02:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IamAbbey",
"github_project": "terminal-sokoban",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "terminal-sokoban"
}
JSON
