ollama-cli-board-game 1
This package contains implementation of a board game on command-line interface with Ollama AI integrated into it.
License: MIT

# ollama_cli_board_game

**Ollama CLI Board Game** is a board game on command-line interface with Ollama AI integrated into it.

# Source Code

The source code of the game **Ollama CLI Board Game** is available in 
[Source Code](https://github.com/SoftwareApkDev/ollama_cli_board_game/blob/master/ollama_cli_board_game/ollama_cli_board_game.py).

# Installation

```
pip install ollama_cli_board_game
```

# How to Play the Game?

Pre-requisite:

The directory "saved" exists inside the directory <OLLAMA_CLI_BOARD_GAME_DIRECTORY>. 
Please create the "saved" directory if it has not existed in <OLLAMA_CLI_BOARD_GAME_DIRECTORY> directory yet.

First, open a Terminal or Command Prompt window and run the following commands.

```
cd <OLLAMA_CLI_BOARD_GAME_DIRECTORY>
python3 ollama_cli_board_game.py
```

**Note:** Replace <OLLAMA_CLI_BOARD_GAME_DIRECTORY> with the path to the directory of the game 
**Ollama CLI Board Game**.

Then, the game will start with something looking like in the screenshot below.

![Getting Started](images/Getting_Started.png)

You will need to enter the number of the LLM model you want to use. If the chosen LLM model is not yet installed on your machine, 
you will need to manually pull it to your machine. For reference on pulling an LLM model, you can refer to [Ollama](https://github.com/ollama/ollama).

Once you chosen an LLM model which is already installed on your machine, the following will appear.

![Game](images/Game.png)

You have two choices:

1. Enter "NEW GAME" to create new saved game data.
2. Enter "LOAD GAME" to load existing saved game data.

# New Saved Game Data Creation

The following happens if you choose to create new saved game data.

![New Saved Game Data](images/New_Saved_Game_Data.png)

You will be asked to enter the player name.

You will then be directed to the main menu.

# Loading Existing Saved Game Data

You will only be able to load existing saved game data if at least one or more saved game files are stored inside the 
"saved" directory.

The following happens when you choose to load existing saved game data.

![Load Saved Game Data](images/Load_Saved_Game_Data.png)

You will then be asked to enter the name of the player associated with the existing saved game data you want to load. 
After that, your saved game data will be loaded and you will be directed to the main menu.

# Main Menu

Once you reach the main menu, you will be asked whether you want to continue playing the game or not. If you enter 'Y', 
you will be directed to choose an action. Else, your game data will be saved and you will exit the game.

![Main Menu](images/Main_Menu.png)

# Gameplay

Once you entered 'Y' when you were at the main menu, you will be redirected to gameplay. You can roll the dice when it 
is your turn. Moreover, places you land on can be purchased (if unowned) or acquired from AI player. Upgrades can be purchased
and random rewards can be obtained from random reward tiles. You will just need to follow the instructions on the screen.

![Gameplay](images/Gameplay.png)