README.md 1.84 KB
Newer Older
1 2 3 4 5 6
Ormulogun
=========

A very simple serverless, privacy aware chess tactics
trainer. Released under the Apache License 2.0.

Artefact2's avatar
Artefact2 committed
7 8
Test it live at: <https://artefact2.gitlab.io/ormulogun/>

9 10 11 12
Dependencies
============

* PHP (CLI)
13
* Any UCI engine (eg stockfish; puzzle generation only)
14 15 16
* GNU parallel
* pv
* zstd
Artefact2's avatar
Artefact2 committed
17
* CMake
18
* clang/llvm
19 20 21
* sassc
* Judy (only for opening book generation)
* Inkscape (only for EPUB generation)
22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
Getting started
===============

~~~
git submodule update --recursive --init
~~~

Frontend
--------

~~~
make -C frontend
make -C frontend host
~~~

Puzzle generation
-----------------

41
See [README.md](./puzzles/README.md).
42

43 44 45 46 47
Opening book generation
-----------------------

See [README.md](./book/README.md).

Artefact2's avatar
Artefact2 committed
48 49 50
To-Do
=====

Artefact2's avatar
Artefact2 committed
51
* More automatic tagging (sacrifices, Zugzwang, Zwischenzug, checkmate patterns, avoid stalemate...)
52
* More subtags (Fork (Knight), Pin (Queen) etc. or just add tags per involved piece)
Artefact2's avatar
Artefact2 committed
53
* Better automatic tagging (not a trivial task)
54
* Local puzzle blacklist (ignore list)
Artefact2's avatar
Artefact2 committed
55
* Better activity log, activity streak
Artefact2's avatar
Artefact2 committed
56
* Find some way of rating puzzles by difficulty without relying on a central server and user tracking (if at all possible)
Artefact2's avatar
Artefact2 committed
57
* localStorage space limit may become an issue with large puzzlesets, maybe use lz-string
58 59
* Opening trainer
* Guess the move
Artefact2's avatar
Artefact2 committed
60

61 62 63 64 65 66
Credits
=======

* [Lichess](https://lichess.org/), for making their game dumps available
* [Colin M.L. Burnett](https://en.wikipedia.org/wiki/User:Cburnett) for releasing his chess pieces as SVG (full license in `COPYING.pieces`)
* Pablo Impallari for releasing the [Kaushan Script](https://fontlibrary.org/en/font/kaushan-script) under the SIL Open Font License
Artefact2's avatar
Artefact2 committed
67
* [GitHub Octicons](https://octicons.github.com/) for the "fork" icon, released under the SIL Open Font License, version 1.1
Artefact2's avatar
Artefact2 committed
68
* [stockfish.js](https://github.com/niklasf/stockfish.js) and all the contributors of Stockfish