Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martan03/minesweeper
Minesweeper TUI implementation in Rust 🦀
https://github.com/martan03/minesweeper
minesweeper minesweeper-cli rust
Last synced: about 1 month ago
JSON representation
Minesweeper TUI implementation in Rust 🦀
- Host: GitHub
- URL: https://github.com/martan03/minesweeper
- Owner: Martan03
- License: gpl-3.0
- Created: 2024-03-28T18:14:36.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-04-15T13:55:56.000Z (8 months ago)
- Last Synced: 2024-04-24T09:11:49.168Z (8 months ago)
- Topics: minesweeper, minesweeper-cli, rust
- Language: Rust
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# minesweeper
Minesweeper implemented in terminal
## 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/minesweeper`
## Usage:
Start minesweeper with default difficulty *(medium)*:
```
./minesweeper
```
Start minesweeper with different difficulty:
```
./minesweeper -d
```
Or you can create your custom difficulty:
```
./minesweeper -c
```
## Detailed description
### Game screen:
When you start the game, you will see the board in the middle and number of
flags left above the board on the left side. You can then use arrow keys to
change selected cell. By pressing `d` or `Enter` you reveal currently selected
cell. To place/remove flag, you can press `f`.
When you fill the whole board and it's correct, you will see Victory message
above the board on the right side.
### Help screen
By pressing `i` you can display help with all other keybind that I didn't
mention.
## 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:** [termint](https://github.com/Martan03/minesweeper)
- **Author website:** [martan03.github.io](https://martan03.github.io)