lila/README.md

4.0 KiB

lichess.org

Build Status Crowdin Twitter

lichess.org

Lila (li[chess in sca]la) is a free online chess game server focused on realtime gameplay and ease of use.

It features a search engine, computer analysis distributed with fishnet, tournaments, simuls, forums, teams, tactic trainer, a mobile app, and a shared analysis board. The UI is available in more than 80 languages thanks to the community.

Lichess is written in Scala 2.11, and relies on Play 2.4 for the routing, templating, and JSON. Pure chess logic is contained in scalachess submodule. The server is fully asynchronous, making heavy use of Scala Futures and Akka 2 actors. Lichess talks to Stockfish deployed in an AI cluster of donated servers. It uses MongoDB to store more than 800 million games, which are indexed by elasticsearch. HTTP requests and websocket connections are proxied by nginx. The web client is written in TypeScript and snabbdom. The blog uses a free open content plan from prismic.io. All rated games are published in a free PGN database. Browser testing done with Browserstack. Please help us translate lichess with Crowdin.

Join us on discord or in the #lichess freenode IRC channel for more info. Use GitHub issues for bug reports and feature requests.

Installation

The Wiki describes how to setup a development environment.

The source code is available for learning and contribution, but please don't just setup a public Lichess clone. Don't expect developers to help you run your own instance. Questions about the installation and runtime issues will probably be ignored.

HTTP API

Feel free to use lichess API in your applications and websites.

Credits

See the contributors on this repository and lichess.org/thanks.

Supported browsers

  • Chrome or Chromium, 1 year old or newer (fastest local analysis!)
  • Firefox, 1 year old or newer (second fastest local analysis!)
  • Opera 34 and newer (meh)
  • Safari 9 and newer (boo)
  • Microsoft Edge (yuck)
  • Internet Explorer 11 (eew)

Older browsers will not work. For your own sake, please upgrade. Security and performance, think about it!

License

Lila is licensed under the GNU Affero General Public License 3 or any later version at your choice with an exception for Highcharts. See COPYING for details.