Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.25 KB

README.md

File metadata and controls

44 lines (26 loc) · 2.25 KB
Raw

Broadcast Lichess Games

An easy way to Broadcast/Relay lichess games from a live url using heroku.

How to Use

  • Fork this repository on GitHub.
  • Login/Sign up to heroku Create a new heroku app.
  • Go to the Deploy tab in heroku and click Connect to GitHub (Make sure your GitHub account is authorised to access heroku).
  • Click on search and select your fork of this repository.
  • Then Enable Automatic Deploys and then Deploy Branch. Make sure you choose the master branch to deploy.
  • Then go to the Settings in heroku and scroll down and click on Reveal Config Vars and add the necessary Config Vars from here.
  • Now click on Open app in heroku and save this link as you will need it soon for your broadcast.
  • Now go to Lichess and create a new broadcast. Add your Event Name, Description and all other required details for your broadcast. In the Source URL, or game IDs field in your broadcast add the link that you had saved when you clicked on Open app in heroku. Now click on SUBMIT in lichess and then click CLICK TO CONNECT and your broadcast is now ready!!

Configuration Variables

Set the following environment variables ( Heroku Config Vars ) in heroku.

Do note that all the variables mentioned below are in the format key=value

RELAY_URL

Your PGN source url. For live broadcasts, you need the live PGN url.

TOKEN

Your Lichess API Access Token. This is required if you want to relay your ongoing games or live games.

MAX_GAMES

Maximum number of your ongoing games to relay ( default : 1 ).

BROADCAST_ID

Broadcast id of your Lichess Broadcast.

Usage

Start server with node server.js.

Endpoint / path will relay the games you specified in RELAY_URL.

If you provide your API access token, then endpoint /ongoing will relay your ongoing games. An attempt will be made to initialize ongoing games from RELAY_URL if it is set. If you provide a BROADCAST_ID, then your ongoing games will be pushed to your broadcast ( in this case TOKEN must have broadcast scopes ).