/scalachess

Chess API written in scala. Immutable and free of side effects.

Primary LanguageScalaMIT LicenseMIT

Continuous Integration

Chess API written in scala for lichess.org

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

INSTALL

Clone scalachess

git clone git://github.com/ornicar/scalachess

Get latest sbt on http://www.scala-sbt.org/download.html

Start sbt in scalachess directory

sbt

In the sbt shell, to compile scalachess, run

compile

To run the tests (with coverage):

clean coverage test
coverageReport

To run benchmarks (takes 10-20 minutes to finish):

sbt "bench / Jmh / run"

To run quick benchmarks (results may be incorrect):

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

Code formatting

This repository uses scalafmt.

Please install it for your code editor if you're going to contribute to this project.

If you don't install it, please run scalafmtAll in the sbt console before committing.