Updated `README.md` with info about new two-player mode.
authorAaron Taylor <ataylor@subgeniuskitty.com>
Fri, 28 May 2021 00:21:50 +0000 (17:21 -0700)
committerAaron Taylor <ataylor@subgeniuskitty.com>
Fri, 28 May 2021 00:21:50 +0000 (17:21 -0700)
README.md

index 9f425d7..1e1bfe7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,6 +41,27 @@ era-appropriate ANSI escape codes, an additional `--mode=strictansi` option was
 created.
 
 
 created.
 
 
+## Two Player Mode ##
+
+The ANSI mode mentioned above was cloned to create a two-player mode with the
+same terminal-compatible ANSI-color UI. Both players must reside on the same
+computer and have permission to create FIFOs under `/tmp/` with `mknod()`.
+
+The first player to launch Go plays as black and the second player to launch
+plays as white.
+
+All communication in the client is strictly synchronous. Thus, commands to save
+or analyze the game may only occur during your turn. Outside your turn, your
+client will only display the following message, accepting no other input until
+a move is received from your opponent.
+
+    Waiting to receive move from other player...
+
+When a game terminates, each player is provided an opportunity to save an SGF
+file for later analysis. Continuing a multiplayer game from SGF is not
+currently supported.
+
+
 ## Future Plans ##
 
 The GNU Go engine is written in plain old C, all reasonably organized and
 ## Future Plans ##
 
 The GNU Go engine is written in plain old C, all reasonably organized and