chess-tui 1.6.1

A rusty chess game in your terminal 🦀
Documentation

board

GitHub CILicense: MITGitHub release

Description

Chess-tui is a simple chess game you can play from your terminal. It supports local 2 players mode, online multiplayer and playing against any UCI compatible chess engine.

Quick install

cargo install chess-tui
chess-tui

If you want to install the game with your favorite package manager, you can find the installation guide here.

Available on

Packaging status

Features

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 !

Configuration

Chess-tui uses a TOML configuration file located at ~/.config/chess-tui/config.toml. Here are the available configuration options:

# Path to the chess engine binary
engine_path = "/path/to/engine"

# Display mode: "DEFAULT" or "ASCII"
display_mode = "DEFAULT"

# Logging level: "Off", "Error", "Warn", "Info", "Debug", "Trace"
log_level = "Off"

Configuration Options:

  • engine_path: Path to your UCI-compatible chess engine binary
  • display_mode:
    • DEFAULT: Uses unicode chess pieces
    • ASCII: Uses ASCII characters for pieces
  • log_level: Controls the verbosity of logging
    • Off: No logging (default)
    • Error: Only errors
    • Warn: Warnings and errors
    • Info: General information, warnings and errors
    • Debug: Debugging information
    • Trace: Very verbose debugging information

The config file is automatically created when you first run chess-tui. You can manually edit it to customize your experience.

All logs are stored in ~/.config/chess-tui/logs.

Base config:

# no engine path
display_mode = "DEFAULT"
log_level = "Off"

Documentation

You can find the documentation of the project here

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