Skip to content

lynx-chess/Lynx_BOT

Repository files navigation

🤖 Lynx_BOT 🤖

👉 Play me on Lichess 👈

lichess-rapid lichess-rapid lichess-rapid lichess-classical

This repo sets up Lynx chess engine to play in lichess.org.

Although the code is open source so that it can be used to play from any account, the official Lynx account is Lynx_BOT.

A fork of the 'official lichess bot client' (ShailChoksi/lichess-bot) is used.

Last version:

Lynx_BOT release

Instructions

Instructions to run Lynx chess engine in your own lichess account.

If you're only interested in the binaries, they're available here.

Requirements

  • Owning a Lichess Bot account. You must not attempt this with a regular Lichess account. Learn here how to upgrade an account to a Bot one.

  • Docker.

  • Docker Compose.

Steps

  • Create a Lichess API Access Token with bot:play permissions.

  • Download the latest release artifact to an empty directory.

  • In that directory, create an .env file with your API token, i.e.:

    echo LICHESS_API_TOKEN="<YOUR_API_TOKEN>" > .env
  • Adjust any parameters you desire in lynx_bot.config.yml.

  • Run docker compose:

    docker compose up

Official Lynx_BOT architecture

Architecture

Licenses

Lynx chess engine has a more permissive MIT license, but since this repository makes use of lichess-bot as well, it's also licensed under AGPL-3.0.

Project License Relationship
Lynx MIT Dependency
lichess-bot AGPL-3.0 Dependency
lc0-docker - Inspiration
Lynx_BOT AGPL-3.0 This project