45 lines
2.1 KiB
Markdown

# Gomoku Game User Manual
Welcome to the Gomoku game! This user manual will guide you on how to install the game and play it.
## Table of Contents
1. [Installation](#installation)
2. [Game Rules](#game-rules)
3. [Playing the Game](#playing-the-game)
4. [Restarting the Game](#restarting-the-game)
5. [Winning the Game](#winning-the-game)
## 1. Installation <a name="installation"></a>
To install and run the Gomoku game, please follow the steps below:
1. Make sure you have Python installed on your computer. You can download Python from the official website: [https://www.python.org/downloads/](https://www.python.org/downloads/)
2. Open a terminal or command prompt.
3. Navigate to the directory where you have saved the `main.py` and `game.py` files.
4. Install the required dependencies by running the following command:
```
pip install -r requirements.txt
```
5. Once the dependencies are installed, you can start the game by running the following command:
```
python main.py
```
## 2. Game Rules <a name="game-rules"></a>
Gomoku is a two-player board game played on a 15x15 grid. The objective of the game is to be the first player to get five of their pieces in a row, either horizontally, vertically, or diagonally.
## 3. Playing the Game <a name="playing-the-game"></a>
Once you start the game, you will see a 15x15 grid on the screen. Each cell represents a position on the board where you can place your piece.
To make a move, simply click on an empty cell on the board. The game will alternate between the black player and the white player.
## 4. Restarting the Game <a name="restarting-the-game"></a>
If you want to restart the game, click the "Restart" button at the bottom of the screen. This will reset the board and allow you to start a new game.
## 5. Winning the Game <a name="winning-the-game"></a>
The game will automatically detect when a player has won. If a player gets five of their pieces in a row, a message box will appear announcing the winner (either black or white). After the game is over, you can click the "Restart" button to start a new game.
Enjoy playing Gomoku!