Skip to content

Commit 6148e1f

Browse files
committedJul 23, 2024
Update READMEs
1 parent cd3aa56 commit 6148e1f

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed
 

‎README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,25 @@ This repo contains tools for letting bots play the game of [Gomori](https://gith
44

55
## Running a game between two bots
66

7+
You need to have [Rust installed](https://rustup.rs/). Afterwards, clone this repo and run
8+
79
```
810
cargo build --release
911
target/release/judge bots/random_bot.json bots/greedy_bot.json -n 1000
1012
```
1113

14+
to let `RandomBot` and `GreedyBot` play for 1000 games.
15+
1216
See the `--help` text of the judge for more options.
1317

1418
## Making a bot
1519

1620
The protocol that the bots use to play consists of JSON requests and responses via standard input/output, with the judge being the client and the bots being the servers.
1721
For instance, the judge will send the bot a JSON message on its stdin asking it to choose up to five cards to play, and the bots will reply via stdout with a JSON message of its own.
1822

19-
If you use the [Rust](gomori), Python or [C#](https://github.com/phwitti/gomori-bot-csharp-template) helper packages, the protocol and game logic is already implemented for you. See their READMEs for more information.
23+
You can either
24+
25+
If you use the [Rust](gomori), [Python](gomori-py) or [C#](https://github.com/phwitti/gomori-bot-csharp-template) helper packages, the protocol and game logic is already implemented for you. See their READMEs for more information.
2026

2127
### JSON protocol
2228

‎gomori/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# gomori (Rust library)
22

3-
See `cargo doc --open` for documentation.
3+
Game logic and tools for writing gomori bots.
4+
5+
See `cargo doc --open` for documentation. There is also an [online version](https://nnmm.github.io/docs/gomori/), but it is not automatically updated.

‎gomori_tui/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!IMPORTANT]
2+
> This is unfinished/not working yet.

0 commit comments

Comments
 (0)