Welcome to Hyper Bot !

Create your own permanent Hyper Bot ( runs on Heroku, no Lc0 )

If you want to create your own permanent bot, do the following:

Sign up to GitHub https://github.com/join , if you have not already.

With your GitHub account visit https://github.com/hyperchessbot/hyperbot , then click on Fork.

Sign up to Heroku https://signup.heroku.com/ , if you have not already.

At Heroku create a new app using New / Create new app.

In the app's dashboard go to the Deploy tab. Use the GitHub button to connect the app to your forked repo. Press Search to find your repositories, then select hyperbot. You need to deploy the master branch. Enable Automatic Deploys and press Deploy Branch, for the initial deploy.

Create a BOT account if you do not already have one. To create one use an account that has not played any games yet, log into this account, then visit https://hypereasy.herokuapp.com/auth/lichess/bot , approve oauth and then on the page you are taken to click on 'Request upgrade to bot'.

Create an API access token with your BOT account at https://lichess.org/account/oauth/token ( should have scopes Read incoming challenges / Create, accept, decline challenges / Play games with the bot API ) and in Heroku Settings / Reveal Config Vars create a new variable TOKEN and set its value to your newly created access token and also create a variable BOT_NAME and set its value to your bot's username.

Congratulations, you have an up and running lichess bot.

Upgrade to bot and play games in your browser

To upgrade an account, that has played no games yet, to bot, and to make this bot accept challenges and play games in your browser, visit https://hypereasy.herokuapp.com .

For detailed instructions see https://lichess.org/forum/off-topic-discussion/hyper-easy-all-variants-lichess-bot-running-in-your-browser#1 .

Update Heroku app to latest version using Gitpod

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Update-Heroku-app-to-latest-version-using-Gitpod#update-heroku-app-to-latest-version-using-gitpod .

Install bot on Windows ( runs Lc0 )

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Install-bot-on-Windows-(-runs-Lc0-)#install-bot-on-windows--runs-lc0- .

Install bot on goorm.io ( runs Lc0 )

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Install-bot-on-goorm.io-(-runs-Lc0-)#install-bot-on-goormio--runs-lc0- .

Download a net for Lc0

Dowload a net from https://lczero.org/dev/wiki/best-nets-for-lc0 .

Rename the weights file 'weights.pb.gz', then copy it to the 'lc0goorm' folder. Overwrite the old file.

Update to latest version on Windows / goorm

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Update-to-latest-version-on-Windows-or-goorm#update-to-latest-version-on-windows--goorm .

Explanation of files

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Explanation-of-files#git .

Contribute to code

Refer to this Wiki https://github.com/hyperchessbot/hyperbot/wiki/Contribute-to-code#contribute-to-code .

Discussion / Feedback

Join the HyperChessBot team https://lichess.org/team/hyperchessbot-team .

Discuss Hyper Bot on Discord https://discord.gg/8m3Muay .

Post issues on GitHub https://github.com/hyperchessbot/hyperbot/issues .

Config vars

GENERAL_TIMEOUT : timeout for event streams in seconds ( default : 15 )

ENGINE_THREADS : engine Threads option ( default : 1 )

ENGINE_HASH : engine Hash option in megabytes ( default : 16 )

ENGINE_MOVE_OVERHEAD : engine Move Overhead option in milliseconds ( default : 500 )

ALLOW_PONDER : set it to 'true' to make the bot think on opponent time

BOOK_DEPTH : up to how many plies into the game should the bot use the book, choosing too high book depth is running the risk of playing unsound moves ( default : 20 )

BOOK_SPREAD : select the move from that many of the top book moves, choosing to high book spread is running the risk of playing unsound moves ( default : 4 )

BOOK_RATINGS : comma separated list of allowed book rating brackets, possible ratings are 1600, 1800, 2000, 2200, 2500 ( default : '2200,2500')

BOOK_SPEEDS : comma separated list of allowed book speeds, possible speeds are bullet, blitz, rapid, classical ( default : 'blitz,rapid' )

LOG_API : set it to 'true' to allow more verbose logging, logs are available in the Inspection / Console of the browser

USE_SCALACHESS : set it to 'true' to use scalachess library and multi variant engine

ACCEPT_VARIANTS : space separated list of variant keys to accept ( default : 'standard' ), for non standard variants USE_SCALACHESS has to be set to 'true' , example : 'standard crazyhouse chess960 kingOfTheHill threeCheck antichess atomic horde racingKings fromPosition'

ACCEPT_SPEEDS : space separated list of speeds to accept ( default : 'bullet blitz rapid classical' ), cannot play infinite or correspondence !

DISABLE_RATED : set it to 'true' to reject rated challenges

DISABLE_CASUAL : set it to 'true' to reject casual challenges

DISABLE_BOT : set it to 'true' to reject bot challenges

DISABLE_HUMAN : set it to 'true' to reject human challenges

GAME_START_DELAY : delay between accepting challenge and starting to play game in seconds ( default : 2 )

CHALLENGE_INTERVAL : delay between auto challenge attempts in minutes ( default : 30 )

CHALLENGE_TIMEOUT : start attempting auto challenges after being idle for that many minutes ( default : 60 )

USE_NNUE : set it to 'true' to use NNUE for variants other than standard

USE_LC0 : set it to 'true' to use Lc0 engine, only works with Windows and goorm installation, on Heroku and Gitpod you should not use it or set it to false

USE_POLYGLOT : set it to 'true' to use polyglot opening book