This is a Slack bot that allows players in a channel to challenge each other to a game of Chess.
cp .env.sample .env
export $(cat .env | xargs) && go run cmd/web/web.go
| Environment Variable | Default | Description |
|---|---|---|
| PORT | 8080 |
Port that the web server will listen |
| HOSTNAME | localhost:8080 |
Used for generating links to render the game board state images |
| SIGNINGKEY | N/A | Key used to sign the signature for board rendering URLs |
| SQLITEPATH | N/A | Path to a sqlite3 database file. If not included, falls back to memory store. |
| SLACKAPPID | N/A | The app ID that operates the slack bot. |
| SLACKCLIENTID | N/A | Slack app client ID |
| SLACKCLIENTSECRET | N/A | Slack app client secret |
| SLACKVERIFICATIONTOKEN | N/A | (deprecated) This is used to verify POSTs to /slack and /slack/action originate from slack |
https://slack.com/oauth/authorize?client_id=<client_id_here>&scope=bot
GET /board?fen=&signature=&from=&to=&check=
Renders the game board based on the state of a game by FEN.
POST /slack
All slack event subscription callbacks flow through this.
- This is used for all typed commands mentioning
@ChessBotin the channel.
POST /slack/action
All slack interactive component callbacks flow through this.
- This is used for accepting/rejecting challenges.
GET /slack/oauth
Slack app installation requests flow through here. A bot token is generated as part of the key exchange and stored keyed by team ID.
GET /analyze?game_id=
- This endpoint is used to generate an analysis of a game. It will redirect the user upon successful import to an analysis provider.
go run cmd/repl/main.go
λ go run cmd/repl/main.go
Game REPL
Note: piece colors may appear reversed on dark background terminals.
Game ID: jcghocxkvgakyefcjgsd
A B C D E F G H
8♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
7♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
6- - - - - - - -
5- - - - - - - -
4- - - - - - - -
3- - - - - - - -
2♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙
1♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
player2's turn (White)
> d2d4
A B C D E F G H
8♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
7♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
6- - - - - - - -
5- - - - - - - -
4- - - ♙ - - - -
3- - - - - - - -
2♙ ♙ ♙ - ♙ ♙ ♙ ♙
1♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
player1's turn (Black)
> export
[Site "Slack ChessBot match"]
[White "player2"]
[Black "player1"]
1.d4 *
> fen
rnbqkbnr/pppppppp/8/8/3P4/8/PPP1PPPP/RNBQKBNR b KQkq d3 0 1
>
There are two reason:
- We have to implement a web server anyways for serving the game board as a PNG to be unfurled by Slack.
- RTM messages don't support attachments yet.
I will reconsider RTM if the messaging ability improves and I will split off the gameboard rendering webserver to its own process at that time.