deepcrayon
/
lila
1
0
Fork 0
Code Releases Activity
lila/README.md

7.2 KiB
Raw Blame History

lichess.org

It's a free online chess game focused on realtime and simplicity.

It haz a search engine, computer analysis, tournaments, forums, teams, and a weird monitoring console. The UI is available in 72 languages thanks to the community.

Lichess is written in Scala 2.10, and relies on Play 2.2 for the routing, templating, and JSON. Pure chess logic is contained in scalachess submodule. The codebase is fully asynchronous, making heavy use of Scala Futures and Akka 2 actors. Lichess talks to Stockfish 4 using a FSM Actor to handle AI moves and analysis. It uses MongoDB 2.4 to store about 15 million games, which are indexed by elasticsearch 0.90. HTTP requests and websocket connections are proxied by nginx 1.4.

Join us on #lichess IRC channel for more info.

Installation

I am not happy to see lichess clones spreading on the Internet. This project source code is open for other developers to have an example of non-trivial scala/play2/mongodb application. You're welcome to reuse as much code as you want for your projects, and to get inspired by the solutions I propose to many common web development problems. But please don't just create a public lichess clone. Also, if you are building a website based on lichess, please mention it in the footer with Based on <a href="http://lichess.org">lichess</a>. Thank you!

Also note that if I provide the source code, I do not offer free support for your lichess instance. I will probably ignore any question about lichess installation and runtime issues.

This is full-stack application, not a library, and it may not be straightforward to get it fully running. I assume you run a Unix with nginx, mongodb, elasticsearch and stockfish installed.

git clone git://github.com/ornicar/lila
cd lila
git submodule update --init

Configuration

cp conf/application.conf.dist conf/application.conf

application.conf extends base.conf and can override any value. Note that application.conf is excluded from git index.

Websocket proxying and language subdomains

When accessed from the root domaing (e.g. lichess.org), the application will redirect to a language specific subdomaing (e.g. en.lichess.org). Additionally, lichess will open websockets on the socket. subdomain (e.g. socket.en.lichess.org).

Here is my local nginx configuration for l.org, assuming lila is installed in /home/thib/lila and runs on 127.0.0.1:9663 /etc/nginx/l.org.conf

And here is my local /etc/hosts file

Run it

Launch the play console:

sbt play -Dhttp.port=9663

From here you can now run the application (run).

API

GET user infos: /api/user/<username>

JSON

> curl en.lichess.org/api/user/thibault

{
    "rating": 1503,                           // shortcut to perfs.global.rating
    "progress": 36,                           // rating change over the last ten games
    "online": true,                           // is the player currently using lichess?
    "playing": "http://lichess.org/abcdefgh", // game being played, if any
    "username": "thibault",
    "perfs": {
        "black": {                            // performances with black pieces
            "rating": 1483,                   // Glicko2 rating
            "deviation": 62,                  // Glicko2 rating deviation
            "nbGames": 465                    // number of games played as black
        },
        "blitz": {
            "rating": 1480,
            "deviation": 63,
            "nbGames": 481
        },
        "bullet": {
            "rating": 1640,
            "deviation": 90,
            "nbGames": 23
        },
        "chess960": {
            "rating": 1575,
            "deviation": 64,
            "nbGames": 323
        },
        "global": {
            "rating": 1503,
            "deviation": 62,
            "nbGames": 883
        },
        "slow": {
            "rating": 1586,
            "deviation": 63,
            "nbGames": 379
        },
        "standard": {
            "rating": 1504,
            "deviation": 62,
            "nbGames": 560
        },
        "white": {
            "rating": 1478,
            "deviation": 63,
            "nbGames": 418
        }
    }
}

JSONP

$.ajax({
  url:'http://en.l.org/api/user/thibault',
  dataType:'jsonp',
  jsonp:'callback',
  success: function(data) {
    // data is a javascript object, do something with it!
    console.debug(JSON.stringify(data));
  }
});

Read the move stream

Lichess streams all played moves on http://en.lichess.org/stream using chunked HTTP response and the following format:

ChunkSize                # size of the next chunk, in hexadecimal
GameId UciMove IpAddress # actual chunk of data

UciMove format

([a-h][1-8]){2}x?(+|#)?

where x indicates a capture, + a check and # a checkmate.

Try it with netcat

> echo "GET /stream HTTP/1.1\nHost: en.lichess.org\n" | netcat en.lichess.org 80

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 16 Oct 2013 20:01:11 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding

1a
4om0thb7 d1e1 91.121.7.111
1b
o2eg9xu3 c8c2x 89.77.165.159
18
g3ag6xm6 g7f7+ 83.149.8.9
1b
hl0zbh3g c4c5# 109.237.157.8
1a
g3ag6xm6 c2c3x+ 91.121.7.111
1c
tj2u3hus a7a6x# 117.199.47.140

By comparing game IDs, you can guess who plays against who.

Note that 91.121.7.111 and 198.50.141.73 are AI servers.

Credits

Big thanks go to lichess community for the support, inspiration, bug reports, and amazing translation efforts.

Special thanks go to:

Thanks to all players for feeding the database.