<p align="center">
<a href="#"><img src="https://user-images.githubusercontent.com/3620552/214357735-53c2174c-5ada-45a2-97cb-6a25b5ca9c0c.png"/></a>
</p>
<p align="center">
A highly customizable way to play chess in your terminal. Supports playing online (via Lichess.org) and
offline against the Fairy-Stockfish engine. All Lichess variants are supported.
</p>
<p align="center">
<a href="https://github.com/trevorbayless/cli-chess/actions/">
<img alt="CI Workflow" src="https://github.com/trevorbayless/cli-chess/actions/workflows/ci.yml/badge.svg?branch=master&event=push">
</a>
<a href="https://pypi.org/project/cli-chess/">
<img alt="PyPI" src="https://img.shields.io/pypi/v/cli-chess?color=informational&label=PyPI&logo=PyPI">
</a>
<a href="#">
<img alt="Python" src="https://img.shields.io/static/v1?label=Python&message=3.8%2B&color=informational&logo=python">
</a>
</p>
<details><summary>Demo</summary>
#### Offline against Fairy-Stockfish
#### Watching Lichess UltraBullet TV
</details>
## Main Features
- Play online using your Lichess.org account
- Play offline against the Fairy-Stockfish engine
- Supports playing all Lichess [variants](https://lichess.org/variant)
- Theme the chess board and pieces to the colors of your choice
- Theme UI components to the colors of your choice
- Supports making moves in UCI, SAN, or LAN
- Play blindfold chess
- Watch Lichess TV
## Getting started
1. Open your terminal and run `pip install cli-chess`
2. Type `cli-chess` to start
3. Use your keyboard arrows, tab, or click to navigate the menus. Multi value menu options
(e.g. changing the variant) can be cycled by pressing spacebar, enter, or by clicking
on the value.
## Playing Online
In order to play online using your Lichess account you will need to create an API token for cli-chess to
authenticate with. Follow the steps below to create the token and register it with cli-chess. Generally, these
steps will only need to be run once as cli-chess will remember the API token.
1. Open your browser and login to your Lichess account
2. Click [here](https://lichess.org/account/oauth/token/create?scopes[]=board:play&description=cli-chess+token)
to create a Lichess API token for cli-chess to authenticate with _(**NOTE**: Do not uncheck any of the
token permissions as these are required by cli-chess)_
3. Click "Create"
4. Highlight and copy the token
5. Run cli-chess using the following command: `cli-chess --token ****` _(replace *'s with your API token)_
## Custom styling
Nearly every component of cli-chess can be styled by overriding parts of the
[default style elements](https://github.com/trevorbayless/cli-chess/blob/master/src/cli_chess/utils/styles.py)
in the `custom_style.py` file. This file will be located at `$HOME/.config/cli-chess/` for Linux and macOS and
`$APPDATA/cli-chess/` for Windows.
Colors are expected to be [HTML color names](https://www.w3schools.com/tags/ref_colornames.asp) (e.g. `seagreen`)
or [HTML hex colors](https://www.w3schools.com/colors/colors_picker.asp) (e.g. `#2E8B57`). The display of selected
colors is dependent on the terminal supporting true colors and the `Terminal Color Depth` option in cli-chess program
settings being set to `True Colors`). If the terminal does not support true colors, the colors selected will be mapped
to the closest supported color.
Restarting cli-chess, or pressing `Ctrl+R` on any screen will force a style refresh. If this custom style sheet is
invalid in any way, the default cli-chess style will be applied. This file must be kept in dictionary format.
Example `custom_style.py` to override board and piece colors:
```json
{
"light-square": "bg:wheat",
"light-square.light-piece": "fg:white",
"light-square.dark-piece": "fg:black",
"dark-square": "bg:#2E8B57",
"dark-square.light-piece": "fg:white",
"dark-square.dark-piece": "fg:black",
"last-move": "bg:slateblue",
"last-move.light-piece": "fg:white",
"last-move.dark-piece": "fg:black",
"in-check": "bg:#FFA500",
"in-check.light-piece": "fg:white",
"in-check.dark-piece": "fg:black"
}
```
## Questions
#### 1. How do I make a move?
Moves are case-sensitive and must be made in SAN, LAN, or UCI. Moves cannot be made using the mouse.
Pawn promotions must specify the promotion piece type (e.g. `e8=Q` or `e7e8q`).
Moves that are ambiguous must specify the _from square_ when using SAN (e.g. `Ncd6`).
To drop a piece in Crazyhouse, use the `@` symbol (e.g. `Q@g4`).
If you need more information on move notation, see Appendix C of [FIDE Laws of Chess](https://www.fide.com/FIDE/handbook/LawsOfChess.pdf).
#### 2. How do I increase the size of the board?
The only way to increase the size of the board is to increase the size of the
font you're using. Many terminals also support `Ctrl +` to increase the terminal size.
#### 3. The board or chess pieces aren't aligned or displaying properly, how can I fix this?
As cli-chess is a terminal based program, it has been designed to be used
with a monospace type font. A monospace font should always be used in order for
character alignment to be consistent. The display of cli-chess can change drastically
depending on the font being used, so it's important to choose a font that works best
for your terminal and display preferences. The fonts that I have found to work best with
cli-chess for piece alignment are `Ubuntu Mono`, `MS Gothic`, and `NSimSun`.
#### 4. What operating systems are supported?
Linux, Windows, and macOS. Development is mainly focused and will be prioritized for
Linux as it's readily available for me to test on. Regardless of operating system,
please report any issues found and I will do my best to support.
#### 5. Can I use a different chess engine?
Playing offline vs the computer is _currently_ only directly compatible with the [Fairy-Stockfish](<https://fairy-stockfish.github.io/>) engine.
For simplicity, the Fairy-Stockfish binaries come pre-built with cli-chess for Linux, Windows, and macOS _(x86-64 (and arm64 for macOS) architecture)_.
Raw data
{
"_id": null,
"home_page": "https://github.com/trevorbayless/cli-chess",
"name": "cli-chess",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "chess, terminal, fairy-stockfish, stockfish, lichess, lichess.org, cli, san, uci",
"author": "Trevor Bayless",
"author_email": "cli-chess@trb.simplelogin.com",
"download_url": "https://files.pythonhosted.org/packages/88/ed/e9a4acfb7e26c213c060f4299c3125b2792074fb9ff27483a7a616781cc3/cli_chess-1.4.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"#\"><img src=\"https://user-images.githubusercontent.com/3620552/214357735-53c2174c-5ada-45a2-97cb-6a25b5ca9c0c.png\"/></a>\n</p>\n\n<p align=\"center\">\nA highly customizable way to play chess in your terminal. Supports playing online (via Lichess.org) and\noffline against the Fairy-Stockfish engine. All Lichess variants are supported.\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/trevorbayless/cli-chess/actions/\">\n <img alt=\"CI Workflow\" src=\"https://github.com/trevorbayless/cli-chess/actions/workflows/ci.yml/badge.svg?branch=master&event=push\">\n </a>\n <a href=\"https://pypi.org/project/cli-chess/\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/cli-chess?color=informational&label=PyPI&logo=PyPI\">\n </a>\n <a href=\"#\">\n <img alt=\"Python\" src=\"https://img.shields.io/static/v1?label=Python&message=3.8%2B&color=informational&logo=python\">\n </a>\n</p>\n\n<details><summary>Demo</summary>\n\n#### Offline against Fairy-Stockfish\n\n\n#### Watching Lichess UltraBullet TV\n\n\n\n</details>\n\n## Main Features\n- Play online using your Lichess.org account\n- Play offline against the Fairy-Stockfish engine\n- Supports playing all Lichess [variants](https://lichess.org/variant)\n- Theme the chess board and pieces to the colors of your choice\n- Theme UI components to the colors of your choice\n- Supports making moves in UCI, SAN, or LAN\n- Play blindfold chess\n- Watch Lichess TV\n\n## Getting started\n1. Open your terminal and run `pip install cli-chess`\n2. Type `cli-chess` to start\n3. Use your keyboard arrows, tab, or click to navigate the menus. Multi value menu options\n (e.g. changing the variant) can be cycled by pressing spacebar, enter, or by clicking\n on the value.\n\n## Playing Online\nIn order to play online using your Lichess account you will need to create an API token for cli-chess to\nauthenticate with. Follow the steps below to create the token and register it with cli-chess. Generally, these\nsteps will only need to be run once as cli-chess will remember the API token.\n\n1. Open your browser and login to your Lichess account\n2. Click [here](https://lichess.org/account/oauth/token/create?scopes[]=board:play&description=cli-chess+token)\n to create a Lichess API token for cli-chess to authenticate with _(**NOTE**: Do not uncheck any of the\n token permissions as these are required by cli-chess)_\n3. Click \"Create\"\n4. Highlight and copy the token\n5. Run cli-chess using the following command: `cli-chess --token ****` _(replace *'s with your API token)_\n\n## Custom styling\nNearly every component of cli-chess can be styled by overriding parts of the\n[default style elements](https://github.com/trevorbayless/cli-chess/blob/master/src/cli_chess/utils/styles.py)\nin the `custom_style.py` file. This file will be located at `$HOME/.config/cli-chess/` for Linux and macOS and\n`$APPDATA/cli-chess/` for Windows.\n\nColors are expected to be [HTML color names](https://www.w3schools.com/tags/ref_colornames.asp) (e.g. `seagreen`)\nor [HTML hex colors](https://www.w3schools.com/colors/colors_picker.asp) (e.g. `#2E8B57`). The display of selected\ncolors is dependent on the terminal supporting true colors and the `Terminal Color Depth` option in cli-chess program\nsettings being set to `True Colors`). If the terminal does not support true colors, the colors selected will be mapped\nto the closest supported color.\n\nRestarting cli-chess, or pressing `Ctrl+R` on any screen will force a style refresh. If this custom style sheet is\ninvalid in any way, the default cli-chess style will be applied. This file must be kept in dictionary format.\n\nExample `custom_style.py` to override board and piece colors:\n```json\n{\n \"light-square\": \"bg:wheat\",\n \"light-square.light-piece\": \"fg:white\",\n \"light-square.dark-piece\": \"fg:black\",\n\n \"dark-square\": \"bg:#2E8B57\",\n \"dark-square.light-piece\": \"fg:white\",\n \"dark-square.dark-piece\": \"fg:black\",\n\n \"last-move\": \"bg:slateblue\",\n \"last-move.light-piece\": \"fg:white\",\n \"last-move.dark-piece\": \"fg:black\",\n\n \"in-check\": \"bg:#FFA500\",\n \"in-check.light-piece\": \"fg:white\",\n \"in-check.dark-piece\": \"fg:black\"\n}\n```\n\n## Questions\n#### 1. How do I make a move?\nMoves are case-sensitive and must be made in SAN, LAN, or UCI. Moves cannot be made using the mouse.\nPawn promotions must specify the promotion piece type (e.g. `e8=Q` or `e7e8q`).\nMoves that are ambiguous must specify the _from square_ when using SAN (e.g. `Ncd6`).\nTo drop a piece in Crazyhouse, use the `@` symbol (e.g. `Q@g4`). \n\nIf you need more information on move notation, see Appendix C of [FIDE Laws of Chess](https://www.fide.com/FIDE/handbook/LawsOfChess.pdf).\n\n#### 2. How do I increase the size of the board?\nThe only way to increase the size of the board is to increase the size of the\nfont you're using. Many terminals also support `Ctrl +` to increase the terminal size.\n\n#### 3. The board or chess pieces aren't aligned or displaying properly, how can I fix this?\nAs cli-chess is a terminal based program, it has been designed to be used\nwith a monospace type font. A monospace font should always be used in order for\ncharacter alignment to be consistent. The display of cli-chess can change drastically\ndepending on the font being used, so it's important to choose a font that works best \nfor your terminal and display preferences. The fonts that I have found to work best with\ncli-chess for piece alignment are `Ubuntu Mono`, `MS Gothic`, and `NSimSun`.\n\n#### 4. What operating systems are supported?\nLinux, Windows, and macOS. Development is mainly focused and will be prioritized for\nLinux as it's readily available for me to test on. Regardless of operating system,\nplease report any issues found and I will do my best to support.\n\n#### 5. Can I use a different chess engine?\nPlaying offline vs the computer is _currently_ only directly compatible with the [Fairy-Stockfish](<https://fairy-stockfish.github.io/>) engine.\nFor simplicity, the Fairy-Stockfish binaries come pre-built with cli-chess for Linux, Windows, and macOS _(x86-64 (and arm64 for macOS) architecture)_.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "A highly customizable way to play chess in your terminal",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/trevorbayless/cli-chess"
},
"split_keywords": [
"chess",
" terminal",
" fairy-stockfish",
" stockfish",
" lichess",
" lichess.org",
" cli",
" san",
" uci"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1dd8fdde36e93895b54a7edcab3df1db70cc0886227198f486561feb51444044",
"md5": "c08bf385c21d165cce03b9e175584d86",
"sha256": "683453342031c6a89b33209d3ac766e9b75f27603f28e769d1a678a667f56c6b"
},
"downloads": -1,
"filename": "cli_chess-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c08bf385c21d165cce03b9e175584d86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1898223,
"upload_time": "2024-11-21T22:54:32",
"upload_time_iso_8601": "2024-11-21T22:54:32.888897Z",
"url": "https://files.pythonhosted.org/packages/1d/d8/fdde36e93895b54a7edcab3df1db70cc0886227198f486561feb51444044/cli_chess-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88ede9a4acfb7e26c213c060f4299c3125b2792074fb9ff27483a7a616781cc3",
"md5": "276f4dd451eb05af0c556d2e8ea9ed7e",
"sha256": "d5f7d125b70780b657a0bd679122a35d98b03cb15d32cc391b95e539e4cde48c"
},
"downloads": -1,
"filename": "cli_chess-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "276f4dd451eb05af0c556d2e8ea9ed7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1853381,
"upload_time": "2024-11-21T22:54:35",
"upload_time_iso_8601": "2024-11-21T22:54:35.498041Z",
"url": "https://files.pythonhosted.org/packages/88/ed/e9a4acfb7e26c213c060f4299c3125b2792074fb9ff27483a7a616781cc3/cli_chess-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 22:54:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "trevorbayless",
"github_project": "cli-chess",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cli-chess"
}
JSON
