https://github.com/thieman/tarrasch

A Chess bot for Slack with graphical boards, win tracking, and automated analysis
https://github.com/thieman/tarrasch

Last synced: 7 days ago
JSON representation

A Chess bot for Slack with graphical boards, win tracking, and automated analysis

• Host: GitHub
• URL: https://github.com/thieman/tarrasch
• Owner: thieman
• License: mit
• Created: 2015-12-23T17:56:43.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-25T22:18:37.000Z (almost 9 years ago)
• Last Synced: 2024-04-14T19:16:46.273Z (7 months ago)
• Language: Python
• Homepage:
• Size: 83 KB
• Stars: 10
• Watchers: 2
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

A Chess bot for Slack. Uses a fully-functional chess engine, graphical boards (none of that low-budget ASCII stuff), keeps track of your record against your friends and coworkers, and automatically uploads each game to lichess.org for analysis.

![](http://i.imgur.com/cDPLZl1.png)

![](http://i.imgur.com/eC0NWDq.png)

### Features

1. [Fully-functional chess engine](https://pypi.python.org/pypi/python-chess) with en passant, castling, minor promotion, all that good stuff

2. Graphical boards courtesy of jinchess.com

3. Keeps track of personal and org-wide records against each opponent

4. Lets you undo moves for when your friends screw up algebraic notation

5. Optional waiting period between moves to force you to get some amount of work done

6. Uploads each game to lichess.org for analysis [(sample)](http://en.lichess.org/9SGIekDg)

### Installation

Basic setup requires a Slack bot token. A Redis instance is also required, which is set up for you if you're running on Heroku. Once the bot is online, enter a channel with it and say `chess help` to see the command list.

### Configuration

Tarrasch is configured through environment variables.

* `TARRASCH_MESSAGE_PREFIX`: Set the word Tarrasch listens for at the beginning of your messages to know you're talking to it. Default: `chess`.

* `TARRASCH_COOLDOWN_SECONDS`: Number of seconds to wait after each move before accepting another move. Default: `0`.

There are also various `TARRASCH_REDIS_*` variables for configuring the Redis connection, but if you're deployed on Heroku this should Just Work™.

#### Interaction Model

To keep things simple, Tarrasch can manage one game per channel it is in. The recommended way of playing a game is to invite your opponent and Tarrasch to a group DM. You can also play in public channels if you want an audience, but only one game can go on in that channel at a time.

#### Using Heroku Free Dynos

You'll need to take Tarrasch offline for 6 hours a day if you plan to deploy it on Heroku free dynos. See the [scaling](scaling.md) doc for more information.