https://github.com/nicklamyeeman/my_sokoban
Sokoban game in ncurses for my 1st year at Epitech
https://github.com/nicklamyeeman/my_sokoban
Last synced: about 2 months ago
JSON representation
Sokoban game in ncurses for my 1st year at Epitech
- Host: GitHub
- URL: https://github.com/nicklamyeeman/my_sokoban
- Owner: nicklamyeeman
- Created: 2021-10-12T21:25:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-23T18:32:19.000Z (over 3 years ago)
- Last Synced: 2025-01-27T07:09:19.867Z (4 months ago)
- Language: C
- Size: 377 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SOKOBAN
Play the japanese game in your Terminal
Explore the docs »
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
This project is a school project of the Epitech school. The goal is to recreate the famous Japanese game of the same name: Sokoban.
The player "P" has to move all the boxes "X" on the "O" locations. Once all the "O" places are replaced by the "X" places, the level is finished and validated.
11 levels are available !
### Built With
* [ncurses](https://invisible-island.net/ncurses/announce.html)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
Be sure you have Ncurses installed on your PC, then open a terminal
### Installation
1. Clone the repo
```sh
git clone https://github.com/nicklamyeeman/my_sokoban.git
```
2. Compile it
```sh
make
```
## Usage
### Example
```sh
./my_sokoban
```
Menu page:
You can navigate throught the menu with the arrow keys ↑ & ↓ and start any level with Space
The ascii menu is available at ```config/menu```
Each original level is harder than the previous one.
You can use Space to restart the level your currently trying to solve
Use ESC in any level to back in the menu and in the menu to quit the game.
### TUTORIAL : ADD YOUR OWN MAPS
You can add your own maps in the ```maps/``` folder.
However, you have to follow these steps in order to integrate it properly into the game :
- The file of your map must follow the sequence of numbers already present (11 maps are originally present so the next one is the map "12")
- Add the selection line of your level in the ascii file of the menu : ```config/menu``` and don't forget to leave an empty line at the end of the file
- Add the validation line of the level in the config file of the player : ```config/player``` in the following way : «```map_name```:```is_finished```» where ```map_name``` will be the name/number of the map and ```is_finished``` being 0 or 1, 0 for an unfinished map and 1 for finished.
Adding for example the line: ```12:0``` at the end of the file will add the map 12 which is not considered finished.
Also leave an empty line at the end of the file
## Roadmap
See the [open issues](https://github.com/nicklamyeeman/my_sokoban/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Contact
Nick LAM YEE MAN - [@nickauteen](https://twitter.com/nickauteen) - [email protected]
Project Link: [https://github.com/nicklamyeeman/my_sokoban](https://github.com/nicklamyeeman/my_sokoban)
## Acknowledgements
* [Best-README Template](https://github.com/othneildrew/Best-README-Template)
[contributors-shield]: https://img.shields.io/github/contributors/nicklamyeeman/repo.svg?style=flat-square
[contributors-url]: https://github.com/nicklamyeeman/repo/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/nicklamyeeman/repo.svg?style=flat-square
[forks-url]: https://github.com/nicklamyeeman/repo/network/members
[stars-shield]: https://img.shields.io/github/stars/nicklamyeeman/repo.svg?style=flat-square
[stars-url]: https://github.com/nicklamyeeman/repo/stargazers
[issues-shield]: https://img.shields.io/github/issues/nicklamyeeman/repo.svg?style=flat-square
[issues-url]: https://github.com/nicklamyeeman/repo/issues
[license-shield]: https://img.shields.io/github/license/nicklamyeeman/repo.svg?style=flat-square
[license-url]: https://github.com/nicklamyeeman/repo/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/nicklamyeeman
[product-screenshot]: images/screenshot.png