Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martan03/2048
2048 TUI implementation in Rust 🦀
https://github.com/martan03/2048
2048 game rust tui
Last synced: about 2 months ago
JSON representation
2048 TUI implementation in Rust 🦀
- Host: GitHub
- URL: https://github.com/martan03/2048
- Owner: Martan03
- Created: 2024-05-27T07:33:00.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-04T12:38:42.000Z (4 months ago)
- Last Synced: 2024-09-05T14:21:46.327Z (4 months ago)
- Topics: 2048, game, rust, tui
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 2048
2048 game implemented in terminal in Rust 🦀
## Contents
- [Installation](#installation)
- [Usage](#usage)
- [Detailed description](#detailed-description)
- [Game goal](#game-goal)
- [Joining tiles](#joining-tiles)
- [Game end](#game-end)
- [Controls](#controls)
- [Technologies](#technologies)
- [Links](#links)
## Installation
You have to compile it yourself, but that shouldn't be a problem. Only thing
you need is `cargo`:
```
cargo build -r
```
After its done compiling, you can start it in `./target/release/tui2048`
## Usage
Start 2048 game:
```
./tui2048
```
## Detailed description
### Game goal
If you don't know what 2048 game is, your goal is to get tile with 2048 value.
In order to get one, you need to combine tiles with the same value. Combining
tiles is really easy. When they're next to each other, you can "push" them
together and they will join to one tile with value equal to their sum.
### Joining tiles
You can use arrow keys to move all tiles in corresponding direction (for
example, up arrow will move all tiles up as much as possible). When two tiles
with the same value are next to each other in the corresponding direction, they
will join and therefore you get one with greater value.
### Game end
I already mentioned the goal of the game - getting tile with value of 2048 -
but what can also happen is that you fill the whole board and you can't join
any tiles. This is game over. You can then restart the game with `r` key.
### Custom game
You can also start the game with any size of the board that fits yours screen
and its size is at least 2 in each dimension. The goal number (win number) can
be set too (note that the number has to be power of 2 and at least 2).
This is example of setting both of the mentioned options:
```
./tui2048 -s 10 10 -w 4098
```
### Controls
- `Arrow keys`/`hjkl`: moving tiles
- `r`: restarts the game
- `Esc` / `q`: exits the game
## Technologies
I used these libraries:
- [crossterm](https://crates.io/crates/crossterm)
- Creating key listeners
- [termint](https://crates.io/crates/termint)
- Creating TUI itself
- [rand](https://crates.io/crates/rand)
- Generating random number
## Links
- **Author:** [Martan03](https://github.com/Martan03)
- **GitHub repository:** [tui2048](https://github.com/Martan03/tui2048)
- **Author website:** [martan03.github.io](https://martan03.github.io)