diff --git a/README.md b/README.md new file mode 100644 index 0000000..38a63ff --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Gomoku engine + +## Description + +simple gomoku engine written in Rust +uses AlphaBeta pruning and caching with zobrist hashing + +TODO: iterative deepening + +## Modes + +### 1. interactive + +`gomoku [start]` + +- player - which symbol should engine play as ('x' or 'o') +- depth - how many plies in future should the engine look +- start - should the engine be first player ('true' or 'false') + +reads from stdin in format `x,y` + +### 2. single position + +`gomoku debug ` + +- player - which symbol should engine play as ('x' or 'o') +- depth - how many plies in future should the engine look +- path-to-input-file - path to file in specified format + +evaluates single positions and returns its move + +input file example: + +```txt +--------- +--------- +---x----- +---xoo--- +----xo--- +---xxxo-- +------oo- +--------x +--------- +```