# Diamant-AI

Repository of the project to create an AI to play the boardgame "Diamant".
See: [Diamant board game - Wikipedia](https://en.wikipedia.org/wiki/Diamant_(board_game))

Note: Only the base game works for now, the Monte Carlo Tree Search has not been implemented yet :c

## User Guide

1) Install Python 3.11+ on your computer.
2) On Linux, open a CLI and run the script: `python3.11 src/main.py`


## TODO List

- [ ] Setup a virtual environment.
- [ ] Code the MCTS AI player.
- [ ] Integrate joblib library to help MCTS computer faster the win/lose probabilities.


## Code Styling

### Git Commit Message

Commit messages should follow the standard:
`<type>[optional scope]: <description>`

The following types are accepted:
- feat: A new feature.
- fix: A bug fix.
- docs: Documentation only changes.
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
- refactor: A code change that neither fixes a bug nor adds a feature.
- perf: A code change that improves performance.
- test: Adding tests.
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation.

Source: <https://ec.europa.eu/component-library/v1.15.0/eu/docs/conventions/git/>