Science Score: 26.0%

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

  • 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
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: BookCatKid
  • License: agpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 89.5 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 1 year ago · Last pushed about 1 year 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
  • 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. Upgrade to a BOT account
  4. Setup the engine
  5. Configure lichess-bot
  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

  • Login: BookCatKid
  • Kind: user

GitHub Events

Total
  • Push event: 7
  • Create event: 2
Last Year
  • Push event: 7
  • Create event: 2

Dependencies

.github/workflows/docker.yml actions
  • actions/checkout v4 composite
  • christian-korneck/update-container-description-action v1 composite
  • docker/build-push-action v6 composite
  • docker/login-action v3 composite
  • docker/setup-buildx-action v3 composite
  • docker/setup-qemu-action v3 composite
.github/workflows/mypy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/python-build.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/python-test.yml actions
  • actions/cache/restore v4 composite
  • actions/cache/save v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/sync-wiki.yml actions
  • actions/checkout v4 composite
.github/workflows/versioning.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
docker/Dockerfile docker
  • python 3$VARIANT build
requirements.txt pypi
  • PyYAML *
  • backoff *
  • chess *
  • requests *
  • rich *
test_bot/test-requirements.txt pypi
  • mypy * test
  • pytest * test
  • pytest-timeout * test
  • ruff * test
  • types-PyYAML * test
  • types-requests * test