X-Git-Url: http://git.subgeniuskitty.com/sgk-go/.git/blobdiff_plain/c82ca61cf5e0994e080619e826b51d8a0ba96d51..6e524d8086b42ce69ac368485dac62d90d40493e:/README.md diff --git a/README.md b/README.md index 18b84a0..1e1bfe7 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ terminal. I find myself less distracted when playing from a serial terminal. I also rarely finish a game in one session. Thus, my selection of GNU Go as a base -upon which to tinker was in part driven by its `--mode ascii` CLI interface. +upon which to tinker was in part driven by its `--mode=ascii` CLI interface. This allows me to run a game inside `screen`, (re-)attaching to it either from a real serial terminal or from a terminal emulator on a modern computer. @@ -31,16 +31,37 @@ attempting to read the board position. Adding some color cleared the fog. In order to maintain compatibility with `screen` and my terminal, this addition of color uses only ANSI escape codes to set the background, printing an ASCII space character to create a block of color. This mode may be selected via the -`--mode ansi` option. The screenshot below shows ASCII mode on the left and +`--mode=ansi` option. The screenshot below shows ASCII mode on the left and ANSI mode on the right, both boards depicting the same game. ![Screenshot: ASCII mode (left) vs ANSI mode (right)](/sgk-go/.git/blob_plain/HEAD:/interface/interface-example.png) In support of serial terminals like my Tektronix 4107 which only support -era-appropriate ANSI escape codes, an additional `--mode strictansi` option was +era-appropriate ANSI escape codes, an additional `--mode=strictansi` option was 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 @@ -57,5 +78,5 @@ execute directly from within the build directory, run the following commands. ./configure make - ./interface/gnugo --mode ansi + ./interface/gnugo