80 lines
2.6 KiB
Markdown
80 lines
2.6 KiB
Markdown
# jminos
|
|
|
|
Modern stacker game with every polyominos from size 1 to 15, made in C++ with [SFML 3](https://www.sfml-dev.org/)!
|
|
|
|
## Download
|
|
|
|
// TODO when the game is finished //
|
|
|
|
This game has been tested on and built on Windows 11 and WSL2 Ubuntu only.
|
|
If your OS isn't compactible with either of theses two, you can try [manually building the project](#manual-build).
|
|
|
|
## How to play
|
|
|
|
You can see and change in-game keybinds in the **SETTINGS** section of the main menu!
|
|
All of in-menu navigation is done with the **arrow keys**, the **Enter key** and the **Escape key**. Theses are unchangeable keybinds.
|
|
You will find more infos about the Rotation System, the scoring system, or the different pieces type in the **INFO** section of the main menu.
|
|
If you want to know more details about the generation of polyominoes, [check the documentation](/doc/)!
|
|
|
|
## Features
|
|
|
|
- Every polyominoes up to pentedecaminoes!
|
|
- 7bag with proportionnality for each polyomino size!
|
|
- Customizable board size!
|
|
- Customizable keybinds!
|
|
- 0° rotations!
|
|
- AutoRS as the Rotation System!
|
|
- IRS, IHS, infinite hold, and other leniency mechanics!
|
|
- Very bland interface!! (i'm not a designer)
|
|
|
|
### Available gamemodes
|
|
|
|
- SPRINT : clear 40 lines as fast as possible!
|
|
- MARATHON : clear 200 lines with increasing gravity!
|
|
- ULTRA : scores as much as possible in only 2 minutes!
|
|
- MASTER : clear 200 lines at levels higher than maximum gravity!
|
|
- ZEN : practice indefinitely in this mode with no gravity!
|
|
|
|
### Screenshots
|
|
|
|
// TODO when the game is finished //
|
|
|
|
## Manual build
|
|
|
|
This project uses xmake for compiling, xmake is cross-platform and works in most OS, xmake also automatically install supported librairies.
|
|
To be able to build this project, you need to [have xmake installed](https://xmake.io) and have a compiler with C++20 compatibility.
|
|
|
|
### Build the project
|
|
|
|
``cd jminos``
|
|
|
|
``xmake``
|
|
|
|
If you need to change the toolchain (for example using gcc):
|
|
``xmake f --toolchain=gcc``
|
|
|
|
### Run the project
|
|
|
|
``xmake run``
|
|
|
|
The program will generate the polyomino files for you if you don't have them.
|
|
As this is a lengthy process, debug mode limits pieces size to 10.
|
|
To switch between debug and release mode:
|
|
``xmake f -m debug``
|
|
``xmake f -m release``
|
|
|
|
If for some reasons you wanna run the command line version (not updated):
|
|
``xmake run text``
|
|
|
|
### Package the project
|
|
|
|
// TODO when the game is finished //
|
|
|
|
## Credits
|
|
|
|
Library used: [SFML 3](https://www.sfml-dev.org/).
|
|
Font used: [Press Start](https://www.zone38.net/font/#pressstart).
|
|
|
|
Inspired by other modern stacker games such as Techmino, jstris, tetr.io, etc.
|
|
This game isn't affiliated with any of them.
|