BlunderBot

An interactive Twitch and Discord bot for chess streamers.

You may see some references to chess.com, but currently BlunderBot only supports lichess.org.

WARNING

This is a work in progress. This was a personal project I had worked on for a couple of years and I'm releasing it before I think it's ready, but it will help me work harder on it. Though it works for me, there's still a lot of hard coded details that might not make it ideal for others. Feel free to contribute, fork, and use however you'd like; but don't tell me I blundered!

I may iterate quickly on the main branch while this is still v0.* without warning but aim for a v1.0 release soon.

Setup

The setup is fairly complicated, due to the fact that all major browsers have disabled the ability to turn off CSP in meta tags/headers. This means we have to set up a proxy to allow certain injections into the lichess frontend.

Fiddler Proxy

Note: You can use any proxy you want, but this is the one I use.

Download and install Fiddler V4

Make sure these rewrites are applied in the AutoResponder tab:

regex:https://lichess1?.org/blunderbot/*	http://localhost:3000/
regex:https://lichess.org/socket.io/*	http://localhost:3000/socket.io/
regex:*://socket5.lichess.org/twitch-socket/*	ws://localhost:3000/twitch-socket/
regex:https://www.chess.com/socket.io/*	http://localhost:3000/socket.io/
regex:https://lichess1?.org/giphy/*   https://i.giphy.com/

Add this Monkey Script to your browser

I use Violentmonkey for Chrome.

Add the script public/scripts/lichess-violentmonkey.js

Some other settings

These settings may be important to get the overlay to work properly. The size of the browser window doesn't matter, it's just what I use for my streamlabs layout, but the size of the lichess board does.

Google Chrome Browser window in FanzyZones is 1265x938
The lichess board is 677.33 x 677.33
Each square is 84.667x84.667

I use SoundVolumeView to mute or unmute desktop applications that may be playing music so BlunderBot is easier to hear.

I use ffmpeg to capture the length of audio clips for mute duration and may end up using it for other things.

I'll try to make those OS agnostic in the future.

Environment Variables

Copy the .env.sample to .env and fill in the values. You can ignore certain sections like Discord and Slack by leaving the *_ENABLED variables set to false.

fitztrev / blunderbot