board-master

📋 Table of contents

• board-master
  • Introduction
    • What is BoardMaster?
      • Main-menu:
      • TicTacToe-menu:
      • TicTacToe game:
    • Minimax Algorithm
  • Setup
    • Prerequisites
  • Installation
    • 1. Clone the repository
    • 2. Navigate to the Project Directory:
  • Usage
  • Documentation 📖
  • Contributors
  • License

Introduction

What is BoardMaster?

BoardMaster is a full-stack application designed for players to enjoy various board games against a range of bots, such as RandomMoveAgent, MiniMaxAgent, and others. It offers an immersive gaming experience, combining classic board game fun with modern AI technology.

Main-menu:

TicTacToe-menu:

TicTacToe game:

Minimax Algorithm

The games this algorithm works great for are what game theorists call deterministic , two-player turn-taking, perfect information, zero-sum games. These games are "fully observable", meaning that you can see everything that is going on in the game. They are also "deterministic", meaning that there is no element of chance involved in the game. There is no dice rolling or card drawing. The game is "zero-sum", meaning that one player's gain is the other player's loss. In other words, if you add up all the gains and losses for each player, they will sum to zero. Finally, the game is "turn-taking", meaning that the players alternate making moves, and "perfect information", meaning that no information is hidden from either player. Chess, checkers, tic-tac-toe, Go, and Othello are all examples of deterministic, two-player, turn-taking, perfect information, zero-sum games. However games that has too many possible moves, such as chess, will take too long to compute and will not be feasible to use this algorithm on.

Setup

To setup the project, one needs to have all the prerequisites installed. Clone the repository, install the dependencies and build the project. This is described in more detail below.

Prerequisites

Before setting up BoardMaster, ensure that your system meets the following requirements:

• Ensure that git is installed on your machine. Download Git
• Ensure that Docker is installed on your machine. Download Docker

Installation

Follow these steps to set up BoardMaster on your local machine:

1. Clone the repository

git clone https://github.com/SverreNystad/board-master.git

2. Navigate to the Project Directory:

After cloning, move into the BoardMaster project directory:

cd board-master

Usage

To start the application locally, follow the steps below:

docker compose up --build

After starting the application, the frontend should be available at http://localhost:3000/ and should pop up in your default browser. The backend should be available at http://localhost:8080/. The backend has OpenAPI documentation available at http://localhost:8080/swagger-ui.html generated straight from the source code.

For the full development setup, see the Developer Setup guide.

Documentation 📖

• Developer Setup 🛠️
• Testing 🧪
• Docker Guide 🐳
• Understanding the Minimax Algorithm 🧠
• Architecture 🏗️

Contributors

Jon Bergland

Sverre Nystad

License

Licensed under the MIT License.