# TMaze
Simple multiplatform maze solving game for terminal written entirely in Rust
## What's this
### Features
- Responsive to terminal size
- Variable maze sizes
- Various maze generation algorithms: Randomized Kruskal's, Depth-First Search
- Timer and move counter
- Show visited places
- Spectator mode, where you can fly and see the map
- Floors and 3D mazes (that's what spectator mode is mainly for)
### To do
- Better settings UI
- Render path (you will be able to disable this)
- Maybe multiplayer
- Saving and exporting game state, mazes and their generators
## How to run
- You can either download from GitHub releases, they are built automatically now, using GitHub Actions ~~althought there are old builds, and I won't update them so frequently, maybe in the future~~
- or build from source, you need cargo installed on your system
### How to build from source
1. Make sure you have [cargo](https://crates.io/) installed
1. Clone GitHub repository or download it as zip, then extract it
1. Go to that folder
1. Run command `cargo run --release` to run (or you can just build it with `cargo build --release` without runing it)
1. You can find compiled executable in the folder `./target/release/`, which you can move or link somewhere else
#### Other option is to just install it using cargo
1. Make sure you have [cargo](https://crates.io/) installed
1. Run `cargo install tmaze`
1. If you want, make sure that `~/.cargo/bin` is in the PATH and enjoy