Data

Tools

Indexes

Applications

Experiments

Open Source Science

lichess-bot

A bridge between Lichess bots and chess engines

https://github.com/lichess-bot-devs/lichess-bot

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.9%) to scientific vocabulary

Keywords

api bot bot-account chess lichess lichess-api lichess-bot python
Last synced: 6 months ago · JSON representation ·

Repository

A bridge between Lichess bots and chess engines

Basic Info
  • Host: GitHub
  • Owner: lichess-bot-devs
  • License: agpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 1.42 MB
Statistics
  • Stars: 909
  • Watchers: 32
  • Forks: 503
  • Open Issues: 4
  • Releases: 0
Topics
api bot bot-account chess lichess lichess-api lichess-bot python
Created almost 8 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Security

README.md

![lichess-bot](https://github.com/lichess-bot-devs/lichess-bot-images/blob/main/lichess-bot-icon-400.png)

lichess-bot

A bridge between [lichess.org](https://lichess.org) and bots.
[Explore lichess-bot docs »](https://github.com/lichess-bot-devs/lichess-bot/wiki)

[![Python Build](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml) [![Python Test](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml) [![Mypy](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml)

Overview

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.

Features

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

Steps

  1. Install lichess-bot
  2. Create a lichess OAuth token
  3. Setup the engine
  4. Configure lichess-bot
  5. Upgrade to a BOT account
  6. Run lichess-bot

Advanced options


Acknowledgements

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.

License

lichess-bot is licensed under the AGPLv3 (or any later version at your option). Check out the LICENSE file for the full text.

Citation

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.

Owner

  • Name: lichess-bot-devs
  • Login: lichess-bot-devs
  • Kind: organization
  • Email: lichess.bot.devs@gmail.com

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: lichess-bot
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ioannis
    family-names: Pantidis
  - given-names: Mark
    family-names: Harrison
    orcid: 'https://orcid.org/0000-0001-7212-8810'
  - given-names: Shail
    family-names: Choksi
  - given-names: Thibault
    family-names: Duplessis
    affiliation: lichess.org
repository-code: 'https://github.com/lichess-bot-devs/lichess-bot'
abstract: >-
  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.
keywords:
  - chess
  - chess engine
  - lichess
  - API
  - game
license: AGPL-3.0

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 43
  • Average time to close issues: 10 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 10
  • Total pull request authors: 8
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.91
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 11
Past Year
  • Issues: 13
  • Pull requests: 43
  • Average time to close issues: 10 days
  • Average time to close pull requests: 2 days
  • Issue authors: 10
  • Pull request authors: 8
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.91
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 11
View more stats
Top Authors
Issue Authors
  • eduherminio (5)
  • erberj (3)
  • arvyy (3)
  • MarkZH (3)
  • CallOn84 (3)
  • Naphthalin (2)
  • AttackingOrDefending (2)
  • JimViebke (2)
  • realBravo (2)
  • fathzer (2)
  • greg-finley (2)
  • andreasabel (1)
  • qftpardox (1)
  • pGOD1000 (1)
  • glolichen (1)
Pull Request Authors
  • dependabot[bot] (74)
  • MarkZH (45)
  • AttackingOrDefending (38)
  • eduherminio (4)
  • fathzer (3)
  • greg-finley (3)
  • adbar (3)
  • osmankaan01 (2)
  • vincentlinzhu (2)
  • Timofei2506 (1)
  • Madhumita16 (1)
  • github-jimjim (1)
  • ezhang7423 (1)
  • desparza22 (1)
  • realBravo (1)
Top Labels
Issue Labels
good first issue (3) dependencies (1) python (1)
Pull Request Labels
dependencies (74) python (72) github_actions (2)

Dependencies

.github/workflows/mypy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/python-build.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/python-test.yml actions
  • actions/cache/restore v3 composite
  • actions/cache/save v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/sync-wiki.yml actions
  • actions/checkout v4 composite
  • dorny/paths-filter v2 composite
.github/workflows/versioning.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
requirements.txt pypi
  • PyYAML ==6.0.1
  • backoff ==2.2.1
  • chess ==1.10.0
  • requests ==2.31.0
  • rich ==13.5.3
test-requirements.txt pypi
  • flake8 ==6.1.0 test
  • flake8-docstrings ==1.7.0 test
  • flake8-markdown ==0.5.0 test
  • mypy ==1.5.1 test
  • pytest ==7.4.2 test
  • pytest-timeout ==2.1.0 test
  • types-PyYAML ==6.0.12.12 test
  • types-requests ==2.31.0.5 test