{"id":13523116,"url":"https://github.com/thomas-mauran/chess-tui","last_synced_at":"2025-05-16T14:09:51.319Z","repository":{"id":207327499,"uuid":"718789585","full_name":"thomas-mauran/chess-tui","owner":"thomas-mauran","description":"Play chess from your terminal 🦀","archived":false,"fork":false,"pushed_at":"2025-03-14T19:41:16.000Z","size":11176,"stargazers_count":612,"open_issues_count":18,"forks_count":37,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-03T12:11:15.427Z","etag":null,"topics":["chess","cli","game","linux-game","linux-games","ratatui","rust","rust-game","tui"],"latest_commit_sha":null,"homepage":"https://thomas-mauran.github.io/chess-tui/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thomas-mauran.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-14T20:01:00.000Z","updated_at":"2025-04-03T06:55:48.000Z","dependencies_parsed_at":"2024-02-27T20:27:26.368Z","dependency_job_id":"fd3a365f-0ed9-4428-90b9-23fa1eaa4a79","html_url":"https://github.com/thomas-mauran/chess-tui","commit_stats":null,"previous_names":["thomas-mauran/chess-tui"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomas-mauran%2Fchess-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomas-mauran%2Fchess-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomas-mauran%2Fchess-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thomas-mauran%2Fchess-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thomas-mauran","download_url":"https://codeload.github.com/thomas-mauran/chess-tui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565052,"owners_count":21125415,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chess","cli","game","linux-game","linux-games","ratatui","rust","rust-game","tui"],"created_at":"2024-08-01T06:00:55.642Z","updated_at":"2025-04-12T11:54:14.849Z","avatar_url":"https://github.com/thomas-mauran.png","language":"Rust","funding_links":[],"categories":["Applications","Table of Contents","\u003ca name=\"games\"\u003e\u003c/a\u003eGames","💻 Apps"],"sub_categories":["Games","🕹️ Games and Entertainment"],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003echess-tui\u003c/h1\u003e\nA rusty chess game in your terminal 🦀\n\n![board](./examples/play_against_white_bot.gif)\n\n\u003cdiv\u003e\n\n  ![GitHub CI](https://github.com/thomas-mauran/chess-tui/actions/workflows/flow_test_build_push.yml/badge.svg)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)[![GitHub release](https://img.shields.io/github/v/release/thomas-mauran/chess-tui?color=success)](https://github.com/thomas-mauran/chess-tui/releases/latest)\n  \u003c/div\u003e\n\u003c/div\u003e\n\n### Description\n\nChess-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.\n\n### Quick install\n\n```bash\ncargo install chess-tui\nchess-tui\n```\n\nIf you want to install the game with your favorite package manager, you can find the installation guide [here](https://thomas-mauran.github.io/chess-tui/docs/Installation/Packaging%20status).\n\n### Available on\n[![Packaging status](https://repology.org/badge/vertical-allrepos/chess-tui.svg)](https://repology.org/project/chess-tui/versions)\n\n### Features\n\n\u003cdetails\u003e\n  \u003csummary\u003eHelper menu\u003c/summary\u003e\n  \u003cimg src=\"./examples/helper.gif\" alt=\"Helper menu\" /\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eLocal 2 player mode\u003c/summary\u003e\n  \u003cimg src=\"./examples/demo.gif\" alt=\"Local 2 players\" /\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eOnline multiplayer\u003c/summary\u003e\n  \u003cimg src=\"./website/static/gif/multiplayer.gif\" alt=\"Online multiplayer\" /\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eDraws\u003c/summary\u003e\n  \u003cul\u003e\n  \u003cli\u003eStalemate\u003c/li\u003e\n  \u003cli\u003e50 moves rules\u003c/li\u003e\n  \u003cli\u003e3 time repetition of the same position\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003ePiece Promotion\u003c/summary\u003e\n  no demo available yet\n\u003c/details\u003e\n\u003cdetails\u003e\n  \u003csummary\u003ePlay against any UCI chess engine as black or white\u003c/summary\u003e\n  \u003ch3\u003ePlay the white pieces\u003c/h3\u003e\n  \u003cimg src=\"./examples/play_against_white_bot.gif\" alt=\"Play against a chess engine as white\" /\u003e\n\n  \u003ch3\u003ePlay the black pieces\u003c/h3\u003e\n  \u003cimg src=\"./examples/play_against_black_bot.gif\" alt=\"Play against a chess engine as black\" /\u003e\n\u003c/details\u003e\n\n### Connect a chess engine\n\nYou 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.\n\nExample:\n\n```bash\nchess-tui -e /your/bin/path\n```\n\nHere I installed stockfish using homebrew and gave chess-tui the path the the engine binary.\nThis command will store in your home directory the chess engine path so you don't have to relink it everytime !\n\n### Configuration\n\nChess-tui uses a TOML configuration file located at `~/.config/chess-tui/config.toml`. Here are the available configuration options:\n\n```toml\n# Path to the chess engine binary\nengine_path = \"/path/to/engine\"\n\n# Display mode: \"DEFAULT\" or \"ASCII\"\ndisplay_mode = \"DEFAULT\"\n\n# Logging level: \"Off\", \"Error\", \"Warn\", \"Info\", \"Debug\", \"Trace\"\nlog_level = \"Off\"\n```\n\n#### Configuration Options:\n\n- **engine_path**: Path to your UCI-compatible chess engine binary\n- **display_mode**:\n  - `DEFAULT`: Uses unicode chess pieces\n  - `ASCII`: Uses ASCII characters for pieces\n- **log_level**: Controls the verbosity of logging\n  - `Off`: No logging (default)\n  - `Error`: Only errors\n  - `Warn`: Warnings and errors\n  - `Info`: General information, warnings and errors\n  - `Debug`: Debugging information\n  - `Trace`: Very verbose debugging information\n\nThe config file is automatically created when you first run chess-tui. You can manually edit it to customize your experience.\n\nAll logs are stored in `~/.config/chess-tui/logs`.\n\nBase config:\n```toml\n# no engine path\ndisplay_mode = \"DEFAULT\"\nlog_level = \"Off\"\n```\n\n### Documentation\n\nYou can find the documentation of the project [here](https://thomas-mauran.github.io/chess-tui/docs/intro)\n\n### Roadmap\n\nYou can find the roadmap of the project [here](https://github.com/users/thomas-mauran/projects/4) if you want to contribute.\n\n### Crates.io\n\nThe project is also available on crates.io [here](https://crates.io/crates/chess-tui)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomas-mauran%2Fchess-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomas-mauran%2Fchess-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomas-mauran%2Fchess-tui/lists"}