~zamfofex/moonfish

a simple chess bot (in C 89)
fix UCI move name parsing
also upload “book” to Neocities
do not allocate large array on thread stack

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~zamfofex/moonfish
read/write
git@git.sr.ht:~zamfofex/moonfish

You can also use your local clone with git send-email.

#moonfish

builds.sr.ht status Lichess classical rating Lichess rapid rating Lichess blitz rating

moonfish is a simple chess bot written in C 89 (ANSI C).

You may play moonfish on Lichess! You don’t need a Lichess account, just make sure to choose “real time” and select a fast enough time control.

#table of contents

#features

  • simple evaluation based on PSTs
  • alpha/beta pruning search
  • cute custom UCI TUIs
  • custom Lichess integration
  • custom UGI/UCI translators
  • custom IRC integration

#limitations

These are things that might be fixed eventually.

  • the TUIs do not let you underpromote
  • no transposition table
  • no support for go infinite, go mate, or go nodes
  • no FEN validation (may lead to potential exploits)

#download

Pre‐compiled executables for Linux of moonfish (and some of its tools) may be found at https://moonfish.neocities.org (Windows binaries are also provided.)

#compiling from source

Building on UNIX (and clones) should be easy. Make sure you have GNU Make and a C compiler like GCC, then run the following command.

make moonfish

Conversely, you may also invoke your compiler by hand. (Feel free to replace cc with your compiler of choice.)

cc -ansi -O3 -pthread -D_POSIX_C_SOURCE=199309L -o moonfish chess.c search.c main.c

Note: If your C implementation doesn’t support pthreads, but supports C11 threads, you may pass in -Dmoonfish_c11_threads.

Note: If your C implementation doesn’t support threads at all, you may pass in -Dmoonfish_no_threads.

#using “play” and “analyse”

make play analyse

“play” and “analyse” are TUI that allows you to play against and analyse with UCI bots respectively.

After compiling and running them, you may use the mouse to click and move pieces around. (So, they require mouse support from your terminal.)

To play against a UCI bot, use ./play followed by the command of whichever bot you want to play against. The color of your pieces will be decided randomly by default.

# (start a game against Stockfish)
./play stockfish

# (start a game against Leela)
./play lc0

# (start a game against moonfish)
./play ./moonfish

To analyse a game with a UCI bot, use ./analyse followed optionally by the UCI options you want to specify, and then the command of whichever bot you want to use for analysis. (Though note that moonfish currently does not have analysis capabilities.)

# (analyse a game using Stockfish)
./analyse stockfish

# (analyse a game using Stockfish, showing win/draw/loss evaluation)
./analyse UCI_ShowWDL=true stockfish

# (analyse a game using Leela)
./analyse lc0

# (analyse a game using Leela, showing win/draw/loss evaluation)
./analyse lc0 --show-wdl

#using "book"

make book

Opening book support for moonfish is handled with the “book” utility. You specify a opening book file name to it as well as the command for a UCI bot, and it will intercept that bot’s communication with the GUI to make it play certain openings.

The format for opening book files is very simple: One opening per line with move names in either SAN or UCI format separated by spaces. (Move numbers are no allowed.) Empty lines are ignores, # is used for comments. Check out the book.txt file for an example.

Invalid opening book files will be rejected early.

# (have moonfish play openings from the given file)
./book --file=book.txt ./moonfish

#using “battle” and “ribbon”

make battle ribbon

The CLI tools, called “battle” and “ribbon” can be used to (respectively) play a single game between two bots and to play a tournament between any given number of bots.

The “battle” CLI may be used to have two UCI or UGI bots play against each other. Each bot has to be specified between brackets (these ones: [ and ]).

./battle [ stockfish ] [ lc0 --preload ] > game.pgn

The bot specified first will play as white (or p1 for UGI) and the bot specified second will play as black (or p2 for UGI).

The program will write a simplified PGN variant to stdout with the game as it happens. The moves will be in UCI/UGI format, rather than SAN.

The program will also annouce to stderr the start and end of the game.

If your bot’s command requires a ] to be used as an argument, you may use double brackets instead, like ./battle [[ unusual ] --foo ]] [ stockfish ]. You may use as many brackets as necessary, you just have to match them when closing.

If your bot’s command starts with a dash, you may precede it by --, like ./battle [ -- -unusual ] [ stockfish ]

A FEN string may be passed in to the battle command, like ./battle --fen='...' [ stockfish ] [ lc0 ]

You may also pass in a time control, with time and increment both in milliseconds, like ./battle [ --time=6000+500 stockfish ] [ ./moonfish ] Since each bot may have a different time control, this has to be specified within the backets for a specific bot. The default is 15 minutes with ten seconds of increment.

You may also pass in x as the first character of the given time control to make it “fixed”, which means that it will be reset after every move. This can be used to set a fixed time per move, for example. For example, ./battle [ --time=1000+0 stockfish ] [ --time --time=x1000+0 ./moonfish ] will set a countdown clock starting at one second for Stockfish, but allow one second for moonfish for every move.

In order to use a UGI bot, you may also pass in --protocol=ugi to that bot, like ./battle [ --protocol=ugi some-bot ] [ stockfish ]. If both bots are UGI, then the game is not assumed to be chess, and the bot playing as p1 will be queried for the status of the game.


“ribbon” is a CLI for setting up a round‐robin tournament between multiple bots with the help of the “battle” program mentioned above and a makefile (currently requiring GNU Make).

It will output a makefile to stdout, which may be used by GNU Make to start the tournament between the given bots.

You may use the -j option of GNU Make to configure the number of concurrent games to play. Likewise, you may stop a given tournament with ctrl-c and continue it by simply running Make again.

You may modify the makefile to prevent certain games from continuing to be played.

Each bot’s command should be passed in as a single argument to ./ribbon, including potential --time=... and --protocol=... options to be interpreted by “battle”.

The file name of an opening book may be passed in, and the file should contain one FEN per line. Empty lines and comments starting with # are allowed.

In addition, as a matter of convenience, you may specify --time=... to “ribbon” itself, which will be passed in verbatim to “battle”.

# prepare a tournament between Stockfish, Leela and moonfish:
./ribbon stockfish lc0 ./moonfish > makefile

# same as above, but with an argument passed in to Leela:
./ribbon stockfish 'lc0 --preload' ./moonfish > makefile

# same, but with the time control made explicit:
./ribbon --time=18000+1000 stockfish 'lc0 --preload' ./moonfish > makefile

# same, but with a different time control for Stockfish:
# (mind the '--' separating "ribbon" options from the bot options for "battle")
./ribbon --time=18000+1000 -- '--time=6000+0 stockfish' 'lc0 --preload' ./moonfish > makefile

# start the tournament, with at most two games being played at any given time:
make -j2

# concatenate the resulting game PGNs into a single file.
cat *.pgn > result.pgn

In addition, you may specify the “battle” command to “ribbon”, which must be done if “battle” is not installed on your system as moonfish-battle, like ./ribbon --battle=./battle stockfish lc0

# prepare a tournament using the locally-built "battle":
./ribbon --battle=./battle stockfish lc0 ./moonfish > makefile

# set up a timeout of thirty seconds for each game:
./ribbon --time=1000+0 --battle='timeout 30 moonfish-battle' stockfish lc0 ./moonfish > makefile

# same as above, but with locally-built "battle":
./ribbon --time=1000+0 --battle='timeout 30 ./battle' stockfish lc0 ./moonfish > makefile

# pick up the tournament again on every failure (possibly due to timeout):
while ! make
do : ; done

#using “ugi-uci“ and “uci-ugi”

make ugi-uci uci-ugi

ugi-uci may be used to let a UGI GUI communicate with a UCI bot, and conversely, uci-ugi may be used to let a UCI GUI communicate with a UGI bot.

Simply pass the command of the bot as arguments to either of these tools, and it’ll translate it to be used by the respective GUI.

Note that if the GUI sends a uci/gui command to the bot that is the same as its protocol, no translation will happen, and the commands will be passed in verbatim between them.

#using “chat”

make chat

moonfish’s IRC integration, called “chat” may be used to play with a UCI bot through IRC. The bot will connect to a given network through TLS and then start responding to move names such as “e4” written on given channels.

# have moonfish play on a given channel
./chat -N irc.example.net -C '#my-channel' ./moonfish

# have Stockfish play on the given channels with the given nickname "chess-bot"
./chat -N irc.example.net -C '#my-channel,#other-channel' -M chess-bot stockfish

It is only possible to connect to networks using TLS. The default nickname is “moonfish”, and it will connect by default to #moonfish on Libera Chat.

#using “lichess”

make lichess

In order to integrate a UCI bot with Lichess, it is possible to use “lichess”. Simply write ./lichess followed by your bot’s command. The Lichess bot token may be specified with the lichess_token environment variable.

# (use Stockfish as a Lichess bot)
lichess_token=XXX ./lichess stockfish

# (use moonfish as a Lichess bot)
lichess_token=XXX ./lichess ./moonfish

#compiling on Plan 9

Note: NPE is required.

After installing NPE, each file may be compiled and linked as expected. (Note: A mkfile isn’t provided.)

6c -I/sys/include/npe chess.c search.c main.c
6l -o moonfish chess.6 search.6 main.6
moonfish

#compiling on Windows

Clone the repository, then open moonfish.vcxproj with Visual Studio. Support for C11 <threads.h> is required. Only the UCI bot will be compiled, not its tools. (You may use a GUI like cutechess to try it.)

Note that MinGW compilation is also supported.

#porting moonfish

The only pieces of functionality the moonfish depends on that are not specified entirely in C89 are pthreads (POSIX threads) and clock_gettime. POSIX threads are not required, and may be substituted by C11 threads or even disabled altogether with compile-time macros. (See “compiling from source”) clock_gettime is required and cannot be replaced, however.

Porting moonfish to a different platform should be a matter of simply providing a “mostly C89-compliant” environment alongside clock_gettime and pthreads. Of course, moonfish doesn’t make use of all C89 features, so it is not necessary to have features that it doesn’t use. Compiling on Plan 9, for example, works through NPE, which provides something close enough to C89 for moonfish to work.

#license

AGPL (v3 or later) © zamfofex 2023, 2024