Readme added

jmacuga · Feb 23, 2023 · 7ca2eaf · 7ca2eaf
1 parent 9f61d85
commit 7ca2eaf
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,35 @@
-Run ui.game.py
+# Nine Men's Morris Game
+Nine Men's Morris implementation with AI player.
+## Configuration and running
+Requirements:
+    python3.9
+    tabulate==0.9.0
+To run program, run ui_game.py file
+
+`python3 -m ui_game`
+
+## Game description
+* In the main menu you can choose the __size of the board__. There are 4 possible variations: __Three__,__ Six__, __Nine__ or __Twelve__ men's morris, each with different number of points. Different board sizes have different game phases and game rules. For details go to [Wikipedia Nine Men's Morris page](https://en.wikipedia.org/wiki/Nine_men%27s_morris)
+
+* Next you can choose the __two player's mode__ or a game with the computer
+
+* Player puts pawns on the board by typing the __coordinates__ of desired point.
+
+## AI player mode
+The computer player checks possible future moves and predicts the optimal move using __MiniMax__ algorithm with  __alpha-beta pruning__. The depth of search is set to 4.
+## Gameplay screenshots
+Start Menu:
+
+![](img/menu_start.png)
+
+Three Men's Morris board:
+
+![](img/three_mills.png)
+
+Six Men's Morris board:
+
+![](img/six_mills.png)
+
+Players symbols:
+
+![](img/player_symbols.png)
diff --git a/img/menu_start.png b/img/menu_start.png
diff --git a/img/player_symbols.png b/img/player_symbols.png
diff --git a/img/six_mills.png b/img/six_mills.png
diff --git a/img/three_mills.png b/img/three_mills.png