Mastermind

🎮 Adaptation of the official game

• Instructions for use
• Functional specifications
• Technical specifications
• Design patterns
• Diagram C4

Dependencies

• Python 3.13

Windows

Installation guide

1. You need to have all the listed dependencies
2. Verify that you have the correct version of python installed
3. Install all requirements

    pip install -r requirements.txt

4. Copy the .env.example file to create your own .env file

Getting Started

You need to follow the Installation guide before

• Run the project

  python main.py

MacOS, WSL & Linux

Installation guide

IMPORTANT: Don't use your system python

1. You need to have all the listed dependencies
2. Create a virtual environment

   python3.13 -m venv venv

3. Activate virtual environment

   source venv/bin/activate

4. Install all requirements

   pip install -r requirements.txt

5. Copy the .env.example file to create your own .env file

Getting Started

You need to follow the Installation guide before

1. Configure your game rules in Rules
2. Run the project

   python main.py