Repository files navigation

Chess API written in scala forlichess.org

It is entirely functional, immutable, and free of side effects.

Clone scalachess

git clone https://github.com/lichess-org/scalachess

Startsbt in scalachess directory

sbt

In the sbt shell, to compile scalachess, run

compile

To run the tests

testKit / test

To run benchmarks (takes more than 1 hour to finish):

bench / Jmh / run

Or to output a json file

bench / Jmh / run -rf json

To run quick benchmarks (results may be inaccurate):

bench / Jmh / run -i 1 -wi 1 -f1 -t1

To run benchmarks for a specific class:

bench / Jmh / run -rf json .*PlayBench.*

To runscalafmt andscalafix:

sbt prepare

For python code,install pipenv, and run$ pipenv install from project root.