<h1 align="center">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/logo.png">
</h1>
<p align="center">
<a href="https://github.com/kfurtak1024/bansoko/releases/latest">
<img src="https://img.shields.io/github/v/release/kfurtak1024/bansoko">
</a>
<a>
<img src="https://img.shields.io/github/pipenv/locked/python-version/kfurtak1024/bansoko">
</a>
<a href="https://pypi.org/project/bansoko/">
<img src="https://img.shields.io/pypi/v/bansoko">
</a>
<a href="https://github.com/kfurtak1024/bansoko/actions/workflows/codeql-analysis.yml">
<img src="https://github.com/kfurtak1024/bansoko/workflows/CodeQL/badge.svg">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/license-MIT-blue.svg">
</a>
<a href="https://kfurtak1024.itch.io/bansoko">
<img src="https://img.shields.io/badge/itch.io-download-black?logo=itchdotio&color=FA5C5C">
</a>
</p>
**Bansoko** is a reimagined, space-themed 🚀 clone of MS-DOS Soko-Ban from 1984 created in Python using [Pyxel](https://github.com/kitao/pyxel).
You can download :package: for both Windows and Linux from:
<a href="https://kfurtak1024.itch.io/bansoko">
<img src="https://static.itch.io/images/badge-color.svg" height="42">
</a>
## 📖 Introduction
>
> *Welcome to Bansoko!*
>
> *You are a scavenger. You collect cargo that people have left in abandoned ships in deep space.*
> *It's a dangerous job, that's why we're using robots.*
>
> *Your goal is to use a remotely controlled robot to push all crates to cargo bays.*
> *Remember, you can only **push** them (you cannot **pull**)*
> *Fortunately, in case of a mistake, you can undo as many steps as you need.*
>
> *Good luck!*
<p align="center">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot1.png">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot2.png">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot3.png">
</p>
<p align="center">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot4.png">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot5.png">
<img src="https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot6.png">
</p>
## 🎮 Installation
### Windows
Install [Python](python.org) (version 3.8 or higher) and make sure that python is added to PATH.
Install Bansoko by running:
```shell
pip install -U bansoko
```
Run the game:
```shell
bansoko
```
### Linux
Install ```python3``` (version 3.8 or higher), ```python3-pip``` and required SDL2 libraries (```libsdl2-2.0-0``` and ```libsdl2-image-2.0-0```).
On Ubuntu, this can be done by running:
```shell
sudo apt install python3 python3-pip libsdl2-2.0-0 libsdl2-image-2.0-0
```
Install Bansoko by running:
```shell
pip3 install -U bansoko
```
Run the game:
```shell
bansoko
```
## 💻 Development setup
### 1. Install prerequisites
### Windows
Install 32-bit [Python](python.org) (version 3.8 or higher) and make sure that python is added to PATH.
Additionally, install ```pipenv``` for managing virtual environments and project dependencies:
```shell
pip install pipenv
```
### Linux
Install ```python3``` (version 3.8 or higher), ```python3-pip```, ```pipenv``` and required SDL2 libraries (```libsdl2-2.0-0``` and ```libsdl2-image-2.0-0```).
On Ubuntu, this can be done by running:
```shell
sudo apt install python3 python3-pip pipenv libsdl2-2.0-0 libsdl2-image-2.0-0
```
### 2. Set up the project
Clone the repository:
```shell
git clone https://github.com/kfurtak1024/bansoko
```
Navigate to the directory Bansoko was cloned to.
Create virtual environment to isolate development:
```shell
pipenv shell
```
Install all dependencies needed for development:
```shell
pipenv install --dev
```
### 3. Run the game
Run Bansoko from virtual environment created in the previous step:
### Windows
```shell
python -m bansoko
```
### Linux
```shell
python3 -m bansoko
```
## 🧰 Modding
**Bansoko** is heavily modifiable thanks to included resource builder. More information on how to 'mod' it can be found on [Bansoko modding page](https://github.com/kfurtak1024/bansoko/wiki/Bansoko-modding).
## 🤝 How to contribute
### Submitting an issue
Use the issue tracker to submit bug reports and feature/enhancement requests.
When submitting a report, please select the appropriate [template](https://github.com/kfurtak1024/bansoko/issues/new/choose).
### Submitting a 'mod'
If you have created a modification for Bansoko which you would like to publish then please contact me via <contact@krzysztoffurtak.dev>
## ⚖️ License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/kfurtak1024/bansoko/blob/master/LICENSE) file for details.
Copyright © 2020-2024 Krzysztof Furtak
Raw data
{
"_id": null,
"home_page": "https://github.com/kfurtak1024/bansoko",
"name": "bansoko",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "game puzzle sokoban 8-bit retro",
"author": "Krzysztof Furtak",
"author_email": "contact@krzysztoffurtak.dev",
"download_url": "https://files.pythonhosted.org/packages/b8/20/5e514741c2be2cc04d006291704b83e2767eeaae34c931e7944c307734e7/bansoko-1.2.1.tar.gz",
"platform": "any",
"description": "<h1 align=\"center\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/logo.png\">\n</h1>\n<p align=\"center\">\n <a href=\"https://github.com/kfurtak1024/bansoko/releases/latest\">\n <img src=\"https://img.shields.io/github/v/release/kfurtak1024/bansoko\">\n </a>\n <a>\n <img src=\"https://img.shields.io/github/pipenv/locked/python-version/kfurtak1024/bansoko\">\n </a>\n <a href=\"https://pypi.org/project/bansoko/\">\n <img src=\"https://img.shields.io/pypi/v/bansoko\">\n </a>\n <a href=\"https://github.com/kfurtak1024/bansoko/actions/workflows/codeql-analysis.yml\">\n <img src=\"https://github.com/kfurtak1024/bansoko/workflows/CodeQL/badge.svg\">\n </a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/license-MIT-blue.svg\">\n </a>\n <a href=\"https://kfurtak1024.itch.io/bansoko\">\n <img src=\"https://img.shields.io/badge/itch.io-download-black?logo=itchdotio&color=FA5C5C\">\n </a>\n</p>\n\n**Bansoko** is a reimagined, space-themed \ud83d\ude80 clone of MS-DOS Soko-Ban from 1984 created in Python using [Pyxel](https://github.com/kitao/pyxel).\n\nYou can download :package: for both Windows and Linux from:\n\n<a href=\"https://kfurtak1024.itch.io/bansoko\">\n <img src=\"https://static.itch.io/images/badge-color.svg\" height=\"42\">\n</a>\n\n## \ud83d\udcd6 Introduction\n\n>\n> *Welcome to Bansoko!*\n> \n> *You are a scavenger. You collect cargo that people have left in abandoned ships in deep space.*\n> *It's a dangerous job, that's why we're using robots.*\n> \n> *Your goal is to use a remotely controlled robot to push all crates to cargo bays.*\n> *Remember, you can only **push** them (you cannot **pull**)*\n> *Fortunately, in case of a mistake, you can undo as many steps as you need.*\n> \n> *Good luck!*\n\n<p align=\"center\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot1.png\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot2.png\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot3.png\">\n</p>\n<p align=\"center\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot4.png\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot5.png\">\n <img src=\"https://github.com/kfurtak1024/bansoko/raw/master/docs/images/screen_shot6.png\">\n</p>\n\n## \ud83c\udfae Installation\n\n### Windows\nInstall [Python](python.org) (version 3.8 or higher) and make sure that python is added to PATH.\n\nInstall Bansoko by running:\n```shell\npip install -U bansoko\n```\n\nRun the game:\n```shell\nbansoko\n```\n\n### Linux\nInstall ```python3``` (version 3.8 or higher), ```python3-pip``` and required SDL2 libraries (```libsdl2-2.0-0``` and ```libsdl2-image-2.0-0```).\n\nOn Ubuntu, this can be done by running:\n\n```shell\nsudo apt install python3 python3-pip libsdl2-2.0-0 libsdl2-image-2.0-0 \n```\n\nInstall Bansoko by running:\n```shell\npip3 install -U bansoko\n```\nRun the game:\n```shell\nbansoko\n```\n\n## \ud83d\udcbb Development setup\n\n### 1. Install prerequisites\n\n### Windows\nInstall 32-bit [Python](python.org) (version 3.8 or higher) and make sure that python is added to PATH.\n\nAdditionally, install ```pipenv``` for managing virtual environments and project dependencies: \n```shell\npip install pipenv\n```\n\n### Linux\nInstall ```python3``` (version 3.8 or higher), ```python3-pip```, ```pipenv``` and required SDL2 libraries (```libsdl2-2.0-0``` and ```libsdl2-image-2.0-0```).\n\nOn Ubuntu, this can be done by running:\n\n```shell\nsudo apt install python3 python3-pip pipenv libsdl2-2.0-0 libsdl2-image-2.0-0 \n```\n\n### 2. Set up the project\n\nClone the repository:\n```shell\ngit clone https://github.com/kfurtak1024/bansoko\n```\nNavigate to the directory Bansoko was cloned to.\n\nCreate virtual environment to isolate development:\n```shell\npipenv shell\n```\n\nInstall all dependencies needed for development:\n```shell\npipenv install --dev\n```\n\n### 3. Run the game\n\nRun Bansoko from virtual environment created in the previous step:\n\n### Windows\n```shell\npython -m bansoko\n```\n\n### Linux\n```shell\npython3 -m bansoko\n```\n\n## \ud83e\uddf0 Modding\n**Bansoko** is heavily modifiable thanks to included resource builder. More information on how to 'mod' it can be found on [Bansoko modding page](https://github.com/kfurtak1024/bansoko/wiki/Bansoko-modding).\n\n## \ud83e\udd1d How to contribute\n\n### Submitting an issue\n\nUse the issue tracker to submit bug reports and feature/enhancement requests.\nWhen submitting a report, please select the appropriate [template](https://github.com/kfurtak1024/bansoko/issues/new/choose).\n\n### Submitting a 'mod'\n\nIf you have created a modification for Bansoko which you would like to publish then please contact me via <contact@krzysztoffurtak.dev>\n\n## \u2696\ufe0f License\nThis project is licensed under the MIT License - see the [LICENSE.md](https://github.com/kfurtak1024/bansoko/blob/master/LICENSE) file for details.\n\nCopyright \u00a9 2020-2024 Krzysztof Furtak\n",
"bugtrack_url": null,
"license": null,
"summary": "Bansoko is a reimagined, space-themed clone of MS-DOS Soko-Ban from 1984 created in Python using Pyxel",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/kfurtak1024/bansoko"
},
"split_keywords": [
"game",
"puzzle",
"sokoban",
"8-bit",
"retro"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3367958e42ebbb858f53ca936d1149936699dc1b8f8e4eb92a8d4bcf839d3d07",
"md5": "86371ef749cc35dc775d60844924359b",
"sha256": "c6e342891fffefd8d315d8d54ace6e68074bf52b767163852da62a901f1ab8bf"
},
"downloads": -1,
"filename": "bansoko-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86371ef749cc35dc775d60844924359b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 105747,
"upload_time": "2024-03-27T15:48:37",
"upload_time_iso_8601": "2024-03-27T15:48:37.657498Z",
"url": "https://files.pythonhosted.org/packages/33/67/958e42ebbb858f53ca936d1149936699dc1b8f8e4eb92a8d4bcf839d3d07/bansoko-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8205e514741c2be2cc04d006291704b83e2767eeaae34c931e7944c307734e7",
"md5": "18990625852258deeb54a9d70e1f34c0",
"sha256": "21bdaa7c26b95253c8f40fdc48cc12adba8b5d0a9e1e296fa39a4ad85b8cd7b2"
},
"downloads": -1,
"filename": "bansoko-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "18990625852258deeb54a9d70e1f34c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 95401,
"upload_time": "2024-03-27T15:48:39",
"upload_time_iso_8601": "2024-03-27T15:48:39.375463Z",
"url": "https://files.pythonhosted.org/packages/b8/20/5e514741c2be2cc04d006291704b83e2767eeaae34c931e7944c307734e7/bansoko-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 15:48:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kfurtak1024",
"github_project": "bansoko",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bansoko"
}
JSON
