Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martan03/tictactoe
TicTacToe TUI implementation in Rust 🦀
https://github.com/martan03/tictactoe
rust termint tictactoe tui
Last synced: about 1 month ago
JSON representation
TicTacToe TUI implementation in Rust 🦀
- Host: GitHub
- URL: https://github.com/martan03/tictactoe
- Owner: Martan03
- Created: 2024-08-09T21:18:18.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-24T17:45:24.000Z (4 months ago)
- Last Synced: 2024-08-24T18:55:55.141Z (4 months ago)
- Topics: rust, termint, tictactoe, tui
- Language: Rust
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tictactoe
TicTacToe TUI implementation in Rust 🦀
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Detailed description](#detailed-description)
- [TUI description & usage](#tui-description--usage)
- [Keybinds](#keybinds)
- [Links](#links)
## Installation
You have to compile it yourself, but that shouldn't be a problem. Only thing
you need is `cargo`. You need to go to the `tictactoe` project folder and run:
```
cargo build -r
```
After it's done compiling, you can start it in `./target/release/tictactoe`.
## Usage
You can start `tictactoe` game like this (automatically fills screen):
```
./tictactoe
```
If you want to set specific size and win length, you can do it like this:
```
./tictactoe -s -w
```
All the usage and flags can be seen in the help:
```
./tictactoe -h
```
## Detailed description
### TUI description & usage
When you start the game, you immediately see the board. Above the board,
there's current game state and score. It displays who's turn it is, who won or
whether game is a draw and score between the two players. There's one cell,
which is selected (has bold border). You can change selected cell using
`Arrow` keys and using `hjkl` keys. Player on turn can place its symbol by
pressing `Enter`. The symbol will appear in the selected cell.
When any player reaches set win length (by default 5), the winning sequence
gets crossed out. The game then can be restarted by pressing `r` key.
### Keybinds
- `Arrow` keys: moves selected cell
- `Enter`: places symbol on selected cell
- `r`: restarts the game
- `R`: resets the score
- `Esc`/`q`: exists the game
## Links
- **Author:** [Martan03](https://github.com/Martan03)
- **GitHub repository:** [tictactoe](https://github.com/Martan03/tictactoe)
- **Author website:** [martan03.github.io](https://martan03.github.io)