Fairy-Stockfish
Overview
Fairy-Stockfish is a chess variant engine derived from Stockfish designed for the support of fairy chess variants and easy extensibility with more games. It can play various regional, historical, and modern chess variants as well as games with user-defined rules. For compatibility with graphical user interfaces it supports the UCI, UCCI, USI, UCI-cyclone, and CECP/XBoard protocols.
The goal of the project is to create an engine supporting a large variety of chess-like games, equipped with the powerful search of Stockfish. Despite its generality the playing strength is on a very high level in almost all supported variants. Due to its multi-protocol support Fairy-Stockfish works with almost any chess variant GUI.
Installation
You can download the Windows executable or Linux binary from the latest release or compile the program from source. The program comes without a graphical user interface, so you perhaps want to use it together with a compatible GUI, or play against it online at pychess, lishogi, or lichess. Read more about how to use Fairy-Stockfish in the wiki.
If you want to preview the functionality of Fairy-Stockfish before downloading, you can try it out on the Fairy-Stockfish playground in the browser.
Optional NNUE evaluation parameter files to improve playing strength for many variants are in the list of NNUE networks.
For the regional variants Xiangqi, Janggi, and Makruk dedicated releases with built-in NNUE networks are available. See the wiki for more details on NNUE.
Contributing
If you like this project, you can support its development via github sponsors, or by contributing to the code or documentation. An introduction to the code base can be found in the wiki.
Supported games
The games currently supported besides chess are listed below. Fairy-Stockfish can also play user-defined variants loaded via a variant configuration file, see the file src/variants.ini and the wiki.
Regional and historical games
- Xiangqi, Manchu, Minixiangqi, Supply chess
- Shogi, Shogi variants
- Janggi
- Makruk, ASEAN, Makpong, Ai-Wok
- Ouk Chatrang, Kar Ouk
- Sittuyin
- Shatar, Jeson Mor
- Shatranj, Courier
- Raazuvaa
Chess variants
- Capablanca, Janus, Modern, Chancellor, Embassy, Gothic, Capablanca random chess
- Grand, Shako, Centaur, Tencubed, Opulent
- Chess960, Placement/Pre-Chess
- Crazyhouse, Loop, Chessgi, Pocket Knight, Capablanca-Crazyhouse
- Bughouse, Koedem
- Seirawan, Seirawan-Crazyhouse, Dragon Chess
- Amazon, Chigorin, Almost chess
- Hoppel-Poppel, New Zealand
- Antichess, Giveaway, Suicide, Losers, Codrus
- Extinction, Kinglet, Three Kings, Coregal
- King of the Hill, Racing Kings
- Three-check, Five-check
- Los Alamos, Gardner’s Minichess
- Atomic
- Horde, Maharajah and the Sepoys
- Knightmate, Nightrider, Grasshopper
- Duck chess, Omicron, Gustav III
- Berolina Chess, Pawn-Sideways, Pawn-Back, Torpedo, Legan Chess
- Spartan Chess
- Wolf Chess
- Troitzky Chess
Shogi variants
Help
See the Fairy-Stockfish Wiki for more info, or if the required information is not available, open an issue or join our discord server.
Bindings
Besides the C++ engine, this project also includes bindings for other programming languages in order to be able to use it as a library for chess variants. They support move, SAN, and FEN generation, as well as checking of game end conditions for all variants supported by Fairy-Stockfish. Since the bindings are using the C++ code, they are very performant compared to libraries directly written in the respective target language.
Python
The python binding pyffish contributed by @gbtami is implemented in pyffish.cpp. It is e.g. used in the backend for the pychess server.
Javascript
The javascript binding ffish.js contributed by @QueensGambit is implemented in ffishjs.cpp. The compilation/binding to javascript is done using emscripten, see the readme.
Ports
WebAssembly
For in-browser use a port of Fairy-Stockfish to WebAssembly is available at npm. It is e.g. used for local analysis on pychess.org. Also see the Fairy-Stockfish WASM demo available at https://fairy-stockfish-nnue-wasm.vercel.app/.
Terms of use
Fairy-Stockfish is free, and distributed under the GNU General Public License version 3
(GPL v3). Essentially, this means you are free to do almost exactly
what you want with the program, including distributing it among your
friends, making it available for download from your website, selling
it (either by itself or as part of some bigger software package), or
using it as the starting point for a software project of your own.
The only real limitation is that whenever you distribute Fairy-Stockfish in
some way, you MUST always include the full source code, or a pointer
to where the source code can be found, to generate the exact binary
you are distributing. If you make any changes to the source code,
these changes must also be made available under the GPL.
For full details, read the copy of the GPL v3 found in the file named
Copying.txt.
评论