ref: 144478a27b1f0b229e49ce4cab3827db47736df9
parent: 4d10a9f000eaf678308e19270e0f1a1ef107ae63
author: zamfofex <zamfofex@twdb.moe>
date: Sun Apr 7 11:27:43 EDT 2024
document IRC bot
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@
- custom Lichess integration
- threaded search
- custom UGI/UCI translators
+- custom IRC integration
limitations
---
@@ -78,6 +79,12 @@
make battle ribbon
~~~
+The IRC/UCI bot integration may also be compiled:
+
+~~~
+make chat
+~~~
+
All such programs may also be compiled by using the default target, `all`. Note the the Lichess integration requires BearSSL and cJSON. (The other programs require no external libraries.)
~~~
@@ -204,6 +211,23 @@
while ! make
do : ; done
~~~
+
+using the IRC integration
+---
+
+It is also possible to use the IRC integration, called “chat” 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].
+
+[Libera Chat]: <https://libera.chat>
using the UGI/UCI translators
---
--
⑨