Home

Awesome

<div align="center"> <h1>chess-tui</h1> A chess TUI implementation in rust 🦀 </div>

board

GitHub CI License: MIT GitHub release

Demo

With docker

docker run --rm -it ghcr.io/thomas-mauran/chess-tui:main

With Cargo

cargo install chess-tui
chess-tui

With Github

git clone git@github.com:thomas-mauran/chess-tui.git
cd chess-tui
cargo build --release
./target/release/chess-tui

NetBSD

On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:

pkgin install chess-tui

Arch Linux

You can install from official repositories:

pacman -S chess-tui

Features

<details> <summary>Helper menu</summary> <img src="./examples/helper.gif" alt="Helper menu" /> </details> <details> <summary>Local 2 player mode</summary> <img src="./examples/demo.gif" alt="Helper menu" /> </details> <details> <summary>Draws</summary> <ul> <li>Stalemate</li> <li>50 moves rules</li> <li>3 time repetition of the same position</li> </ul> </details> <details> <summary>Piece Promotion</summary> no demo available yet </details> <details> <summary>Play against any UCI chess engine as black or white</summary> <h3>Play the white pieces</h3> <img src="./examples/play_against_white_bot.gif" alt="Play against a chess engine as white" /> <h3>Play the black pieces</h3> <img src="./examples/play_against_black_bot.gif" alt="Play against a chess engine as black" /> </details>

Connect a chess engine

You can play chess-tui with any UCI compatible chess engines. To do so you will need to use the -e command to give the chess engine binary path.

Example:

chess-tui -e /your/bin/path

Here I installed stockfish using homebrew and gave chess-tui the path the the engine binary. This command will store in your home directory the chess engine path so you don't have to relink it everytime !

Roadmap

You can find the roadmap of the project here if you want to contribute.

Crates.io

The project is also available on crates.io here