Lichess Bot

Lichess BOT interface for UCI compatible engines.

How to use

• Upgrade to a BOT account on lichess. guide
• go get github.com/dolegi/lichess-bot
• Download a UCI compatible engine such as stockfish
• Create a new toml file for config
• Put BOT name, API key and engine path in config.toml
• Run with ./lichess-bot config.toml

Upgrade to BOT account

As well as normal usage shown above, you can use this library to upgrade your account

WARNING: Upgrading your account cannot be undone

To upgrade run like this

./lichess-bot config.toml upgrade

Minimal config

token = "XXX"
botname = "XXX"
url = "https://lichess.org/api/"

[engine]
path = "path/to/engine"

[challenge]
variants = [
  "standard"
]
speeds = [
  "blitz",
  "bullet"
]
modes = [
  "rated",
  "casual"
]

Config format

token = "XXX" # API token for Lichess
botname = "XXX" # Name of the BOT account
url = "https://lichess.org/api/" # URL for Lichess API

[engine]
path = "path/to/engine" # Path to UCI compatible engine
  [engine.options]
  threads = 1 # Number of CPU threads to use
  hash = 512 # Max memory in MB engine can use
  [engine.go]
  nodes = 1 # Search number of nodes only
  depth = 5 # Search depth limit
  movetime = 5000 # Move time limit in milliseconds

[network]
latency = 100 # Estimated network latency when sending requests in milliseconds

[challenge]
variants = [ # Variants engine supports
  "standard"
]
speeds = [ # Speeds to play at
  "blitz",
  "bullet"
]
modes = [ # Modes to play. Must be "rated" and/or "casual"
  "rated"
]

Docker

Example usage for using Docker: docker build . -t lichess-bot && docker run -v $(pwd)/config.toml:/app/config.toml lichess-bot ./config.toml

Releases

To install run go get github/dolegi/lichess-bot Note: Windows release is untested

References

• Lichess BOT API
• Python Lichess BOT
• UCI reference