MAINTAINER OIVAS7572

lichess-bot

• A bridge between Lichess API and bots.
• This bot is made with Python and it is running using Docker container and is concentrated on heroku.

How to Install on Heroku

• Import or Fork this repository to your Github.
• Open the Settings tab on heroku and insert your API access token with bot:play scopes enabled in the Config vars field in the format LICHESS_BOT_TOKEN:API-ACCESS-TOKEN, where you replace API-ACCESS-TOKEN with your API Access token.
• Install Heroku CLI and create a new app in Heroku.
  Do note that in certain operating systems Heroku CLI doesn't get added to path automatically. If that's the case you'll have to add heroku to your path manually.
• Run this command in cmd or powershell heroku stack:set container -a appname, where appname is replaced with your Heroku app's name.
• In heroku, in the Deploy tab click on Connect to GitHub and then click on search and select your fork/import of this repository.
• Now scroll down and under Manual deploy, click on deploy with the master branch selected.
  
  Note: You could also Enable Automatic Deploys with the master branch selected if you would like each commit you make to get automatically and easily deployed onto your bot. It is your choice whether you'd like to Enable or Disable Automatic Deploys.
• After deploying wait for about 5 minutes till the build finishes and then in the Resources tab in heroku turn worker dynos. If you do not see any option to enable any dynos, then you'll have to wait for about 5 minutes and then refresh your page on heroku.

You're now connected to lichess and awaiting challenges! Your bot is up and ready!

Bot Information

Engine:

• Stockfish 14 SSE4.1 + POPCNT with the default NNUE.

Opening Books:

• Goi5.1.bin
• Drawkiller_EloZoom_big.bin

Keep you Forks or Imports Up-to-Date & Check the other Branches in this Repository

If you would like to run bot locally on PC, read the lichess-bot manual.

How to change the engine used?

Changing the engine to an engine of your preference is simple. Just follow the following steps:

• Firstly, you have to remove the engine used. To do this you need to put # at the start of these lines 15 to 16 in the dockerfile (or you can delete those lines).

• Then you need to download the binary of the chess engine you want to used and in your GitHub repository, Click on Add files and the click Upload files and upload the binary of the chess engine you have downloaded.

Note: Make sure you download a linux binary that is supported by heroku (by default Stockfish is used, but the default engine name is chess-engine).

• Then change the name of engine in 6th line of config.yml and 18th line of Dockerfile to your binary file's name.

How to use Stockfish dev

• You can reset link in 15th line in Dockerfile to the Stockfish dev binary link from abrok.eu/stockfish (You can set this http://abrok.eu/stockfish/latest/linux/stockfish_x64_modern.zip link for latest Stockfish dev binary)

Note: You need to use Linux x64 for modern computers binary for Heroku.

Acknowledgements

Credits to ShailChoksi's lichess-bot.

License

This code is primarily taken from lichess-bot by ShailChoksi and is hence run under the AGPLv3 License (or later at your option). Check out the LICENSE file for full text.