Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/twilio/chessms

Play Chess over SMS!
https://github.com/twilio/chessms

Last synced: 11 days ago
JSON representation

Play Chess over SMS!

Awesome Lists containing this project

README

        

# ChesSMS

ChesSMS is an application that lets you play Chess over SMS, powered by
[Twilio](http://www.twilio.com/). A blog about it can be read
[here](http://www.twilio.com/engineering/2012/11/08/adventures-in-unicode-sms).

![screenshot](https://raw.github.com/twilio/chessms/master/priv/static/screenshot.png)

## Dependencies
Erlang/OTP R15B01 (may work on older versions)

## Building

ChesSMS uses [rebar](https://github.com/basho/rebar). To build it...

./rebar get-deps
./rebar compile

## Choosing a Chess Engine
ChesSMS should in theory work with any UCI compatible chess engine. It is known to
work with [Stockfish](https://github.com/mcostalba/Stockfish).

If using stockfish, compile it according to your machine and copy the
binary to `priv/bin/stockfish`.

If using another Chess Engine, you can put the binary where ever you want
but you'll have to modify `src/chessms_server.app.src` and change the
`engine_path` configuration parameter.

## Running
If everything has been built correctly, you should be able to run:

erl -pa ebin deps/*/ebin -s chessms_server -chessms_server port 7000

## Connecting to SMS
To connect ChesSMS to an SMS enabled Twilio number, sign up for Twilio
and buy a number (if you haven't already). Configure the SMS URL of the
phone number to point where your ChesSMS server is running.

Now, you should be able to text "play" to your Twilio phone number to
start a chess game!

## Contributing
Contributions are welcome. If you're looking for things to add, checkout
the Issues page.