git clone https://github.com/Samuil1337/lichess-bot.git
cd lichess-bot
git submodule update --init
cp config.yml.default config.yml
# Add your token to the first line of the config (e.g. `nano config.yml`)
# Download & extract the CSV and models directories to the root of the repo (e.g. tar xf CSV.tar.xz models.tar.xz)
nix develop # append `.#cuda` for cuda support
./start.sh
lichess-bot is a free bridge between the Lichess Bot API and chess engines.
With lichess-bot, you can create and operate a bot on lichess. Your bot will be able to play against humans and bots alike, and you will be able to view these games live on lichess.
See also the lichess-bot documentation for further usage help.
Supports:
- Every variant and time control
- UCI, XBoard, and Homemade engines
- Matchmaking (challenging other bots)
- Offering Draws and Resigning
- Participating in tournaments
- Accepting move takeback requests from opponents
- Saving games as PGN
- Local & Online Opening Books
- Local & Online Endgame Tablebases
Can run on:
- Python 3.9 and later
- Windows, Linux and MacOS
- Docker
- Install lichess-bot
- Create a lichess OAuth token
- Setup the engine
- Configure lichess-bot
- Upgrade to a BOT account
- Run lichess-bot
Thanks to the Lichess team, especially T. Alexander Lystad and Thibault Duplessis for working with the LeelaChessZero team to get this API up. Thanks to the Niklas Fiekas and his python-chess code which allows engine communication seamlessly.
lichess-bot is licensed under the AGPLv3 (or any later version at your option). Check out the LICENSE file for the full text.
If this software has been used for research purposes, please cite it using the "Cite this repository" menu on the right sidebar. For more information, check the CITATION file.