lichess-bot

README

Lichess Bot

Lichess bot interface for uci compatible engines.

How to use

• Upgrade to a bot account on lichess. guide
• Download the binary for your system from the releases or compile yourself
• 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 are normal usage shown about, 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"
]

Releases

See releases for compiled releases Note: Windows release is untested

References

• Lichess docs
• python lichess bot
• uci reference