ref: 074cc2c9d5ddb09be274610f793a8f2301895cdc
parent: 34d627b5ec5914b22b0e4a2596f5daf8632a199b
author: zamfofex <zamfofex@twdb.moe>
date: Sun Jun 1 09:46:25 EDT 2025
make miscellaneous fixes
--- a/README.md
+++ b/README.md
@@ -4,33 +4,23 @@
moonfish
===
-[](https://builds.sr.ht/~zamfofex/moonfish/commits/main)
-[](https://lichess.org/@/munfish/perf/classical)
-[](https://lichess.org/@/munfish/perf/rapid)
-[](https://lichess.org/@/munfish/perf/blitz)
-
**moonfish** is a simple chess bot written in C89 (using just a few POSIX and C11 APIs).
-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.
-
-[play moonfish on Lichess]: <https://lichess.org/?user=munfish#friend>
-
table of contents
---
-- [features](#features) and [limitations](#limitations)
+- [features](#features)
- [download](#download)
- compiling from source
+ - [configuring the compilation](#configuring-the-compilation)
- [compiling on UNIX](#compiling-from-source) (and UNIX clones)
- [compiling on Plan 9](#compiling-on-9front) (specifically 9front)
- [compiling on Windows](#compiling-on-windows)
+ - [compiling on Mac OS](#notes-for-mac-os)
- [compiling on other systems](#porting-moonfish)
-- using moonfish’s tools
- - [using “analyse”](#using-analyse)
- - [using “chat”](#using-chat) (for integrating UCI bots with IRC)
- - [using “lichess”](#using-lichess) (for integrating UCI bots with Lichess)
+- [using moonfish’s tools](#using-moonfishs-tools)
- [helping improve moonfish!](#contributing-to-moonfish)
-- [license](#license-0bsd)
+- [license](#license)
features
---
@@ -37,32 +27,25 @@
- simple evaluation based on PSTs
- MCTS (Monte Carlo tree search)
-- cute custom UCI TUI
+- cute custom TUI for UCI bots
- custom Lichess integration
- custom IRC integration
-limitations
----
-
-These are things that might be resolved eventually.
-
-- the TUI does not let you underpromote
-- no support for some seldom used UCI features
-
download
---
-Pre‐compiled executables for Linux of moonfish (and some of its tools) may be found at <https://moonfish.cc>
+Precompiled binaries of moonfish for Linux may be found at <https://moonfish.cc>
contributing to moonfish
---
-Contributions to moonfish are always welcome! Whether you just have thoughts to share, or you want to improve its source code, any kind of help is vastly appreciated!
+Contributions to moonfish are always welcome! Whether you just have thoughts or ideas to share or complaints to make, any kind of help is very appreciated!
-Contributions (complaints, ideas, thoughts, patches, etc.) may be submitted via email to <zamfofex@twdb.moe> or shared in its IRC channel ([#moonfish] on [Libera Chat]).
+Please feel free to reach out!
-- Note: The IRC channel is also bridged to Discord. (Please ask on IRC for a Discord invite.)
-- Note: There is also a [#moonfish-miscellany] channel for general off‐topic conversations.
+- via email: <zamfofex@twdb.moe>
+- via IRC: [#moonfish] on [Libera Chat]
+- off‐topic channel: [#moonfish-miscellany]
[Libera Chat]: <https://libera.chat>
[#moonfish]: <https://web.libera.chat/#moonfish>
@@ -71,7 +54,7 @@
compiling from source
---
-Compiling on UNIX (and clones) should be easy! Make sure you have [POSIX Make] (like [GNU Make] or [BSD Make] or [PDP Make]) and a C compiler (like [GCC] or [Clang]), then run the following command.
+You’ll need a C compiler (like [GCC] or [Clang]) and also [POSIX Make] (like [GNU Make] or [BSD Make] or [PDP Make]).
~~~
make moonfish
@@ -84,115 +67,85 @@
[GCC]: <https://gnu.org/software/gcc/>
[Clang]: <https://clang.llvm.org>
-Conversely, you may also invoke your compiler by hand. (Feel free to replace `cc` with your compiler of choice.)
+You can also run your compiler manually if you prefer.
~~~
-cc -O3 -o moonfish chess.c search.c main.c -lm -pthread
+# (feel free to replace 'cc' with your compiler of choice)
+cc -O3 -o moonfish chess.c search.c main.c -lm -pthread -latomic
~~~
-By default, moonfish uses C11 `<threads.h>`, but it is possible to have it use POSIX `<pthread.h>` instead by passing `-Dmoonfish_pthreads` to the compiler. (This is necessary if you’re on Mac OS.)
+configuring the compilation
+---
-~~~
-cc -O3 -Dmoonfish_pthreads -o moonfish chess.c search.c main.c -lm -pthread
-~~~
+**Note:** Consult the makefile for more configuration options.
-It is also possible to compile moonfish without a dependency on threads by passing `-Dmoonfish_no_threads` to the compiler.
+- **threads**: moonfish uses C11 `<threads.h>` by default
+ - `make CPPFLAGS=-Dmoonfish_pthreads` to compile with pthreads instead
+ - `make CPPFLAGS=-Dmoonfish_no_threads` to disable threads altogether
+- **clock/time**: moonfish uses `clock_gettime` by default
+ - `make CPPFLAGS=-Dmoonfish_no_clock` to compile with `time()` instead (note: discouraged)
+- **libraries**: moonfish uses `-pthread` and `-latomic` by default
+ - `make LIBPTHREAD= LIBATOMIC=` to disable them (respectively)
+ - `make LIBPTHREAD=-lpthread` to replace `-pthread` with `-lpthread` (for example)
-~~~
-cc -O3 -Dmoonfish_no_threads -o moonfish chess.c search.c main.c -lm
-~~~
+notes for Mac OS
+---
-Note: It’s also possible to pass arguments to the compiler when using Make by specifying `CFLAGS`:
+MacOS usually lacks `-latomic` and C11 `<threads.h>`, so you may need to compile with `-Dmoonfish_pthreads` and `LIBATOMIC=`.
~~~
-make CFLAGS='-O3 -Dmoonfish_pthreads' moonfish
+# (configuring the compilation for MacOS)
+make CPPFLAGS=-Dmoonfish_pthreads LIBATOMIC= moonfish
~~~
-using “analyse”
+using moonfish’s tools
---
-~~~
-make analyse
-~~~
+moonfish also has a few tools to use UCI bots in various ways.
-“analyse” is a TUI that allows you to analyse chess games with UCI bots.
+- **`analyse`**: TUI for analysing chess games with UCI bots
+- **`chat`**: IRC integration for UCI bots
+- **`lichess`**: Lichess integration for UCI bots
-After compiling and running it, you may use the mouse to click and move pieces around. (So, it requires mouse support from your terminal.)
+To compile them, simply run `make` followed by the name of the tool you want to compile.
-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.
-
~~~
-# (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 “chat”
----
-
-~~~
+make analyse
make chat
+make lichess
~~~
-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.
+Each of them has fairly good `--help` documentation, so you may use that to learn more about them!
~~~
-# 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
+./analyse --help
+./chat --help
+./lichess --help
~~~
-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].
+Note that some of them have external dependencies!
-using “lichess”
----
+- `chat` depends on [LibreSSL] (`-ltls`)
+- `lichess` depends on [LibreSSL] (`-ltls`) and [cJSON] (`-lcjson`)
-~~~
-make lichess
-~~~
+[LibreSSL]: <https://libressl.org>
+[cJSON]: <https://github.com/DaveGamble/cJSON>
-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.
-
-[Lichess]: <https://lichess.org>
-
-~~~
-# (use Stockfish as a Lichess bot)
-lichess_token=XXX ./lichess stockfish
-
-# (use moonfish as a Lichess bot)
-lichess_token=XXX ./lichess ./moonfish
-~~~
-
compiling on 9front
---
-After installing [NPE], each file may be compiled and linked as expected. (Note: A `mkfile` is also provided for covenience.)
+You’ll need [NPE]. After that, you can just compile moonfish and its tools with `mk`. (They have no further dependencies on 9front.)
[NPE]: <https://git.sr.ht/~ft/npe>
-~~~
-# (example for x86-64)
-6c -I/sys/include/npe -Dmoonfish_plan9 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. Only the UCI bot will be compiled, not its tools. (You may use a GUI like [cutechess] to try it.)
+Clone the repository, then open `moonfish.vcxproj` with Visual Studio.
-Note that [MinGW] compilation is also supported.
+- Only the UCI bot will be compiled, not the tools.
+- Compiling with [MinGW] is also supported. (In this case, the tools may be compiled too.)
+- You may use a GUI like [cutechess] to try it.
[cutechess]: <https://github.com/cutechess/cutechess>
[MinGW]: <https://mingw-w64.org>
@@ -200,20 +153,17 @@
porting moonfish
---
-Porting moonfish to a different platform should be a matter of simply providing a “mostly C89‐compliant” C implementation. 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 9front](#compiling-on-9front), for example, works through NPE, which provides something close enough to C89 for moonfish to work.
+Porting moonfish to a different platform should be a matter of simply providing a “mostly C89‐compliant” C implementation. Of course, moonfish doesn’t make use of *all* C89 features, so it is not necessary to have features that it doesn’t use. For example, [compiling on 9front](#compiling-on-9front) works through NPE, which provides something close enough to C89 for moonfish to work.
-The only pieces of functionality that moonfish optionally depends on that is not specified entirely in C89 are `clock_gettime` and threads. For threads, either pthreads or C11 `<threads.h>` may be used. For `clock_gettime`, it is possible to use `time` instead. These can be configured with the following compile‐time macros.
+It is possible to compile moonfish within a strict C89 implementation by defining the `moonfish_no_threads` and `moonfish_no_clock` macros.
-- default (without explicit options): use `clock_gettime` and C11 `<threads.h>`
-- `-Dmoonfish_pthreads`: use pthreads instead of C11 `<threads.h>`
-- `-Dmoonfish_no_threads`: disable threads altogether
-- `-Dmoonfish_no_clock`: use `time` instead of `clock_gettime` (note: this is highly discouraged because 1 second time granularity is very detrimental in fast games, besides unfortunate reliance on wall‐clock time.)
-
-Thus, moonfish can be compiled within a strict C89 implementation by setting the `moonfish_no_threads` and `moonfish_no_clock` macros during compile time.
-
-license (0BSD)
+license
---
-Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+moonfish is released under the [0BSD] license:
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+>
+> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+[0BSD]: <https://landley.net/toybox/license.html>
--- a/index.html
+++ b/index.html
@@ -280,7 +280,7 @@
</section>
<section>
<h3> efficient </h3>
- <p> moonfish makes efficient uses of resources, allowing for it to run in constrained environments such as embedded devices </p>
+ <p> moonfish makes efficient use of resources, allowing for it to run in constrained environments such as embedded devices </p>
<p> <a href="https://git.sr.ht/~zamfofex/moonfish#porting-moonfish">port moonfish</a> </p>
</section>
</div>
--- a/makefile
+++ b/makefile
@@ -6,11 +6,25 @@
.SUFFIXES:
.SUFFIXES: .c .o
+# configurable variables (note: not exhaustive!)
CFLAGS = -O3 -Wall -Wextra -Wpedantic
PREFIX = /usr/local
BINDIR = $(PREFIX)/bin
RM = rm -f
+# configurable libraries
+LIBM = -lm
+LIBPTHREAD = -pthread
+LIBATOMIC = -latomic
+LIBTLS = -ltls -lssl -lcrypto
+LIBCJSON = -lcjson
+
+# further configurable variables
+moonfish_libs = $(LIBM) $(LIBPTHREAD) $(LIBATOMIC)
+lichess_libs = $(LIBPTHREAD) $(LIBTLS) $(LIBCJSON)
+analyse_libs = $(LIBPTHREAD)
+chat_libs = $(LIBTLS)
+
# hack for BSD Make
# (ideally, '$^' should be used directly instead)
.ALLSRC ?= $^
@@ -18,11 +32,6 @@
tool_obj = tools/utils.o tools/https.o tools/pgn.o tools/lichess.o tools/analyse.o tools/chat.o tools/perft.o
obj = chess.o search.o main.o
-moonfish_libs = -lm -pthread -latomic
-lichess_libs = -pthread -ltls -lssl -lcrypto -lcjson
-analyse_libs = -pthread
-chat_libs = -ltls -lssl -lcrypto
-
all: moonfish lichess analyse chat
moonfish: $(obj)
@@ -40,7 +49,7 @@
$(CC) $(LDFLAGS) -o $@ $(.ALLSRC) $($@_libs)
.c.o:
- $(CC) $(CFLAGS) -o $@ -c $<
+ $(CC) $(CFLAGS) $(CPPFLAGS) -o $@ -c $<
check: moonfish perft
scripts/check.sh
--- a/moonfish.vcxproj
+++ b/moonfish.vcxproj
@@ -16,6 +16,7 @@
<ItemDefinitionGroup>
<ClCompile>
<LanguageStandard_C>stdc11</LanguageStandard_C>
+ <AdditionalOptions>/experimental:c11atomics</AdditionalOptions>
</ClCompile>
</ItemDefinitionGroup>
<ItemGroup>
--
⑨