README.rst

fairyfishnet: distributed Fairy-Stockfish analysis for pychess.org

Installation

1. Request your personal fairyfishnet key on pychess Discord https://discord.gg/aPs8RKr

2. Install the fairyfishnet client.

   Via pip

   To install or upgrade to the latest version do:

   pip3 install --upgrade --user fairyfishnet
   

   Example usage:

   python3 -m fairyfishnet --auto-update
   

   Optional: Generate a systemd service file:

   python3 -m fairyfishnet systemd
   

   Via Docker

   There is a Docker container courtesy of @mklemenz. For example you can simply do:

   docker run mklemenz/fishnet --key MY_APIKEY --auto-update
   

pychess-variants custom Fairy-Stockfish

fairyfishnet is using Fairy-Stockfish by @ianfab.

You can build Fairy-Stockfish yourself (for example with ./build-stockfish.sh) and provide the path using python -m fairyfishnet --stockfish-command. Otherwise a precompiled binary will be downloaded for you.

Overview

See protocol.md for details.

License

fairyfishnet is licensed under the GPLv3+ license. See LICENSE.txt for the full license text.