mastermind-ai 1.6.2b0__tar.gz

mastermind_ai-1.6.2b0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Flyson Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mastermind_ai-1.6.2b0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: mastermind-ai
+Version: 1.6.2b0
+Summary: A Python package that simulates the Mastermind game with an AI solver.
+Home-page: https://github.com/FlysonBot/Mastermind
+Author: FlysonBot
+Author-email: FlysonBot@users.noreply.github.com
+Project-URL: Repository, https://github.com/FlysonBot/Mastermind
+Project-URL: Documentation, https://flysonbot.github.io/Mastermind/
+Project-URL: Issues and Bugs, https://github.com/FlysonBot/Mastermind/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
+Classifier: Topic :: Games/Entertainment :: Puzzle Games
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas>=2.2.2
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/FlysonBot/Mastermind/main/docs/source/_static/Mastermind Logo.svg" width="350">
+</p>
+
+| **Testing:** | [![Testing Status](https://img.shields.io/github/actions/workflow/status/FlysonBot/Mastermind/coveralls.yaml?label=test)](https://github.com/FlysonBot/Mastermind/actions/workflows/coveralls.yaml) [![Test Coverage](https://coveralls.io/repos/github/FlysonBot/Mastermind/badge.svg?branch=main)](https://coveralls.io/github/FlysonBot/Mastermind?branch=main)  [![CodeFactor](https://www.codefactor.io/repository/github/flysonbot/mastermind/badge/main)](https://www.codefactor.io/repository/github/flysonbot/mastermind/overview/main) [![Docs Deploy Status](https://img.shields.io/github/actions/workflow/status/FlysonBot/Mastermind/deploy_sphinx.yaml?label=docs)](https://flysonbot.github.io/Mastermind/) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/af7ee6c4fbc945f88a41ef8edbea682d)](https://app.codacy.com/gh/FlysonBot/Mastermind/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)|
+| --- | :-: |
+| **Version:** | [![GitHub tag](https://img.shields.io/github/tag/FlysonBot/Mastermind?include_prereleases=&sort=semver&color=blue)](https://github.com/FlysonBot/Mastermind/tags) [![GitHub Release](https://img.shields.io/github/v/release/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/releases) [![Python Version](https://img.shields.io/badge/Python-3.10+-blue)](https://www.python.org/downloads/) |
+| **Activity:** | [![Opened Issue Count](https://img.shields.io/github/issues/FlysonBot/Mastermind?color=teal)](<https://github.com/FlysonBot/Mastermind/issues>) [![Closed Issue Count](https://img.shields.io/github/issues-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/issues?q=is%3Aissue+is%3Aclosed) [![Closed PR Count](https://img.shields.io/github/issues-pr-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/pulls?q=is%3Apr+is%3Aclosed) |
+| **Meta:** | [![GitHub Downloads](https://img.shields.io/github/downloads/FlysonBot/Mastermind/total)](https://github.com/FlysonBot/Mastermind/releases) ![Repo Size](https://img.shields.io/github/repo-size/FlysonBot/Mastermind) [![GitHub License](https://img.shields.io/github/license/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) |
+
+> [!NOTE]  
+> This repo is currently still under development. Currently there is a beta version that have the basic simulation feature finished. If you encountered any issue, please open up an issue and let me know! I will try to fix them as soon as possible.
+
+**Links:**
+
+- [Documentation](https://flysonbot.github.io/Mastermind/)
+- [Source Code](https://github.com/FlysonBot/Mastermind)
+- [Releases](https://github.com/FlysonBot/Mastermind/releases)
+- [Bug Reports](https://github.com/FlysonBot/Mastermind/issues)
+- [Changelog](https://github.com/FlysonBot/Mastermind/blob/main/CHANGELOG.md)
+- [Contributing](https://github.com/FlysonBot/Mastermind/blob/main/.github/CONTRIBUTING.md)
+- [Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md)
+
+# Mastermind
+
+> This is a python implementation of the classic puzzle game Mastermind. It simulates the game and allow you to play with either another human being (sits next to you) or the computer, with a AI Solver build-in (still under development). You can install this game with pip or try it out in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb).
+
+## What is Mastermind?
+
+Mastermind is a code-breaking game for two players. The first player (the code-setter) creates a secret code, which the second player (the code-cracker) tries to guess. The code-cracker has a limited number of attempts to guess the code correctly. After each guess, the code-setter provides feedback to the code-cracker, indicating how many dots have the right color and are in the right place, and how many are the right color but in the wrong place. The code-cracker uses this feedback to refine their guesses until they correctly guess the code or run out of attempts.
+
+## Getting Started
+
+### Prerequisites
+
+To run this project, you must have the following installed (installation guide below):
+
+- Python 3.10 (or higher)
+- pip (comes with Python, needed to install the project as a library)
+
+Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/mastermind_in_colab.ipynb)
+
+### Installation Guide
+
+1. Install [Python 3.10+](https://www.python.org/downloads/) if you have not already.
+
+2. Install this the latest python release using pip in your terminal:
+
+    ```bash
+    pip install mastermind-ai
+    ```
+
+3. Run the program with the following command:
+
+    ```bash
+    mastermind
+    ```
+
+4. Enjoy!
+
+> [!TIP]
+> If the above does not work, try the troubleshooting guide below.
+
+### Troubleshooting
+
+If you encounter any issues during installation, please check the following:
+
+1. Do you have trouble finding your terminal?
+
+    - For windows users, press `Ctrl + R` and type `cmd` and press enter.
+    - For mac users, press `Cmd + Space` and type `terminal` and press enter.
+    - For linux users, press `Ctrl + Alt + T`.
+
+2. Do you have the correct version of `python` installed? Check with the following command:
+
+    ```bash
+    python --version
+    ```
+
+    If you get an error, you need to install python.
+    If your python version is lower than 3.10, you need to upgrade your python version.
+
+3. Do you have `pip` installed properly? Check with the following command:
+
+    ```bash
+    pip --version
+    ```
+
+    If you get an error, you need to install `pip`.
+
+4. Did you encountered an error associated with installing the dependencies of this project? Try installing the dependencies manually using the following command:
+
+    ```bash
+    pip install pandas
+    ```
+
+    If you get an error, the dependencies does not work on your machine. You will have to find your own way to install the dependencies.
+
+5. If you are still having trouble, please feel free to open up an issue [here](https://github.com/FlysonBot/Mastermind/issues), and we will try to help you out. Or alternatively you can run the program in your [browser](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+All contributors must adhere to the [Contributor Covenant Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors.
+
+To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
+
+## License
+
+Licensed under [MIT License](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) by [@FlysonBot](https://github.com/FlysonBot).
+
+## Questions?
+
+If you have any questions, please feel free to leave them in the [Discussions](https://github.com/FlysonBot/Mastermind/discussions) or open up an [Issue](https://github.com/FlysonBot/Mastermind/issues).

mastermind_ai-1.6.2b0/README.md

@@ -0,0 +1,115 @@
+<p align="center">
+<img src="https://raw.githubusercontent.com/FlysonBot/Mastermind/main/docs/source/_static/Mastermind Logo.svg" width="350">
+</p>
+
+| **Testing:** | [![Testing Status](https://img.shields.io/github/actions/workflow/status/FlysonBot/Mastermind/coveralls.yaml?label=test)](https://github.com/FlysonBot/Mastermind/actions/workflows/coveralls.yaml) [![Test Coverage](https://coveralls.io/repos/github/FlysonBot/Mastermind/badge.svg?branch=main)](https://coveralls.io/github/FlysonBot/Mastermind?branch=main)  [![CodeFactor](https://www.codefactor.io/repository/github/flysonbot/mastermind/badge/main)](https://www.codefactor.io/repository/github/flysonbot/mastermind/overview/main) [![Docs Deploy Status](https://img.shields.io/github/actions/workflow/status/FlysonBot/Mastermind/deploy_sphinx.yaml?label=docs)](https://flysonbot.github.io/Mastermind/) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/af7ee6c4fbc945f88a41ef8edbea682d)](https://app.codacy.com/gh/FlysonBot/Mastermind/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)|
+| --- | :-: |
+| **Version:** | [![GitHub tag](https://img.shields.io/github/tag/FlysonBot/Mastermind?include_prereleases=&sort=semver&color=blue)](https://github.com/FlysonBot/Mastermind/tags) [![GitHub Release](https://img.shields.io/github/v/release/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/releases) [![Python Version](https://img.shields.io/badge/Python-3.10+-blue)](https://www.python.org/downloads/) |
+| **Activity:** | [![Opened Issue Count](https://img.shields.io/github/issues/FlysonBot/Mastermind?color=teal)](<https://github.com/FlysonBot/Mastermind/issues>) [![Closed Issue Count](https://img.shields.io/github/issues-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/issues?q=is%3Aissue+is%3Aclosed) [![Closed PR Count](https://img.shields.io/github/issues-pr-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/pulls?q=is%3Apr+is%3Aclosed) |
+| **Meta:** | [![GitHub Downloads](https://img.shields.io/github/downloads/FlysonBot/Mastermind/total)](https://github.com/FlysonBot/Mastermind/releases) ![Repo Size](https://img.shields.io/github/repo-size/FlysonBot/Mastermind) [![GitHub License](https://img.shields.io/github/license/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) |
+
+> [!NOTE]  
+> This repo is currently still under development. Currently there is a beta version that have the basic simulation feature finished. If you encountered any issue, please open up an issue and let me know! I will try to fix them as soon as possible.
+
+**Links:**
+
+- [Documentation](https://flysonbot.github.io/Mastermind/)
+- [Source Code](https://github.com/FlysonBot/Mastermind)
+- [Releases](https://github.com/FlysonBot/Mastermind/releases)
+- [Bug Reports](https://github.com/FlysonBot/Mastermind/issues)
+- [Changelog](https://github.com/FlysonBot/Mastermind/blob/main/CHANGELOG.md)
+- [Contributing](https://github.com/FlysonBot/Mastermind/blob/main/.github/CONTRIBUTING.md)
+- [Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md)
+
+# Mastermind
+
+> This is a python implementation of the classic puzzle game Mastermind. It simulates the game and allow you to play with either another human being (sits next to you) or the computer, with a AI Solver build-in (still under development). You can install this game with pip or try it out in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb).
+
+## What is Mastermind?
+
+Mastermind is a code-breaking game for two players. The first player (the code-setter) creates a secret code, which the second player (the code-cracker) tries to guess. The code-cracker has a limited number of attempts to guess the code correctly. After each guess, the code-setter provides feedback to the code-cracker, indicating how many dots have the right color and are in the right place, and how many are the right color but in the wrong place. The code-cracker uses this feedback to refine their guesses until they correctly guess the code or run out of attempts.
+
+## Getting Started
+
+### Prerequisites
+
+To run this project, you must have the following installed (installation guide below):
+
+- Python 3.10 (or higher)
+- pip (comes with Python, needed to install the project as a library)
+
+Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/mastermind_in_colab.ipynb)
+
+### Installation Guide
+
+1. Install [Python 3.10+](https://www.python.org/downloads/) if you have not already.
+
+2. Install this the latest python release using pip in your terminal:
+
+    ```bash
+    pip install mastermind-ai
+    ```
+
+3. Run the program with the following command:
+
+    ```bash
+    mastermind
+    ```
+
+4. Enjoy!
+
+> [!TIP]
+> If the above does not work, try the troubleshooting guide below.
+
+### Troubleshooting
+
+If you encounter any issues during installation, please check the following:
+
+1. Do you have trouble finding your terminal?
+
+    - For windows users, press `Ctrl + R` and type `cmd` and press enter.
+    - For mac users, press `Cmd + Space` and type `terminal` and press enter.
+    - For linux users, press `Ctrl + Alt + T`.
+
+2. Do you have the correct version of `python` installed? Check with the following command:
+
+    ```bash
+    python --version
+    ```
+
+    If you get an error, you need to install python.
+    If your python version is lower than 3.10, you need to upgrade your python version.
+
+3. Do you have `pip` installed properly? Check with the following command:
+
+    ```bash
+    pip --version
+    ```
+
+    If you get an error, you need to install `pip`.
+
+4. Did you encountered an error associated with installing the dependencies of this project? Try installing the dependencies manually using the following command:
+
+    ```bash
+    pip install pandas
+    ```
+
+    If you get an error, the dependencies does not work on your machine. You will have to find your own way to install the dependencies.
+
+5. If you are still having trouble, please feel free to open up an issue [here](https://github.com/FlysonBot/Mastermind/issues), and we will try to help you out. Or alternatively you can run the program in your [browser](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+All contributors must adhere to the [Contributor Covenant Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors.
+
+To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
+
+## License
+
+Licensed under [MIT License](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) by [@FlysonBot](https://github.com/FlysonBot).
+
+## Questions?
+
+If you have any questions, please feel free to leave them in the [Discussions](https://github.com/FlysonBot/Mastermind/discussions) or open up an [Issue](https://github.com/FlysonBot/Mastermind/issues).

mastermind_ai-1.6.2b0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mastermind_ai-1.6.2b0/setup.py

@@ -0,0 +1,42 @@
+from setuptools import find_packages, setup
+
+
+def read_requirements(file):
+    with open(file, "r") as f:
+        return [line.strip() for line in f if line and not line.startswith("#")]
+
+
+setup(
+    name="mastermind-ai",
+    version="1.6.2-beta",
+    author="FlysonBot",
+    author_email="FlysonBot@users.noreply.github.com",
+    description="A Python package that simulates the Mastermind game with an AI solver.",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/FlysonBot/Mastermind",
+    project_urls={
+        "Repository": "https://github.com/FlysonBot/Mastermind",
+        "Documentation": "https://flysonbot.github.io/Mastermind/",
+        "Issues and Bugs": "https://github.com/FlysonBot/Mastermind/issues",
+    },
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python :: 3.10",
+        "License :: OSI Approved :: MIT License",
+        "Intended Audience :: End Users/Desktop",
+        "Intended Audience :: Education",
+        "Natural Language :: English",
+        "Topic :: Games/Entertainment :: Puzzle Games",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.10",
+    install_requires=read_requirements("src/requirements.txt"),
+    entry_points={
+        "console_scripts": [
+            "mastermind = mastermind.main.main:main",
+        ],
+    },
+)

mastermind_ai-1.6.2b0/src/mastermind/game/__init__.py

@@ -0,0 +1,3 @@
+from mastermind.game.game import Game
+
+__all__ = ["Game"]

mastermind_ai-1.6.2b0/src/mastermind/game/board.py

@@ -0,0 +1,116 @@
+from typing import Tuple
+
+from mastermind.utils import Stack
+
+
+class GameBoard:
+    """
+    Represents the game board for a Mastermind game.
+
+    The GameBoard class manages the game's guesses and feedbacks, allowing players to make guesses, retrieve past guesses and feedbacks, and clear the board.
+
+    Attributes:
+        NUMBER_OF_COLORS (int): The number of colors available in the game.
+        NUMBER_OF_DOTS (int): The number of dots (or pegs) in each guess.
+        _number_of_guesses_made (int): The number of guesses made so far.
+        _guesses (Stack): A stack of the guesses made so far.
+        _feedbacks (Stack): A stack of the feedbacks received for the guesses made so far.
+
+    Raises:
+        EmptyBoardError: If there are no guesses to retrieve or remove.
+    """
+
+    class EmptyBoardError(Exception):
+        """
+        Exception raised when trying to access the game board when it is empty.
+        """
+
+        pass
+
+    def __init__(self, number_of_colors: int, number_of_dots: int) -> None:
+        self.NUMBER_OF_COLORS = number_of_colors
+        self.NUMBER_OF_DOTS = number_of_dots
+
+        self._number_of_guesses_made = 0
+        self._guesses = Stack()
+        self._feedbacks = Stack()
+
+    def __len__(self) -> int:
+        """
+        Returns the number of guesses made on the game board.
+        """
+        return self._number_of_guesses_made
+
+    def __getitem__(self, index: int) -> Tuple:
+        """
+        Returns the guess and feedback at the specified index.
+        """
+        return self._guesses[index], self._feedbacks[index]
+
+    def last_guess(self) -> Tuple:
+        """
+        Returns the last guess made on the game board.
+
+        Returns:
+            Tuple: A tuple representation of the last guess.
+
+        Raises:
+            EmptyBoardError: If there are no guesses on the game board.
+        """
+        if self._number_of_guesses_made == 0:
+            raise self.EmptyBoardError("No guesses to return.")
+
+        return self._guesses.top()
+
+    def last_feedback(self) -> Tuple:
+        """
+        Returns the feedback for the last guess made on the game board.
+
+        Returns:
+            Tuple: A tuple representation of the last feedback.
+
+        Raises:
+            EmptyBoardError: If there are no guesses on the game board.
+        """
+        if self._number_of_guesses_made == 0:
+            raise self.EmptyBoardError("No guesses to return.")
+
+        return self._feedbacks.top()
+
+    def remove_last(self) -> Tuple:
+        """
+        Removes the last guess and feedback from the game board.
+
+        Returns:
+            Tuple: The removed guess and feedback.
+
+        Raises:
+            EmptyBoardError: If there are no guesses on the game board.
+        """
+        if self._number_of_guesses_made == 0:
+            raise self.EmptyBoardError("No guesses to remove.")
+
+        self._number_of_guesses_made -= 1
+
+        return self._guesses.pop(), self._feedbacks.pop()
+
+    def add_guess(self, guess: Tuple[int, ...], feedback: Tuple[int, ...]) -> None:
+        """
+        Adds a new guess and its corresponding feedback to the game board.
+
+        Args:
+            guess (Tuple[int, ...]): The new guess.
+            feedback (Tuple[int, ...]): The feedback for the new guess.
+        """
+
+        self._guesses.push(guess)
+        self._feedbacks.push(feedback)
+        self._number_of_guesses_made += 1
+
+    def clear(self) -> None:
+        """
+        Clears the game board, removing all guesses and feedbacks.
+        """
+        self._guesses.clear()
+        self._feedbacks.clear()
+        self._number_of_guesses_made = 0

mastermind_ai-1.6.2b0/src/mastermind/game/game.py

@@ -0,0 +1,77 @@
+from typing import Optional
+
+from mastermind.game.game_flow import GameFlow
+from mastermind.game.game_parameter import GameParameter
+from mastermind.game.player_logic import PlayerLogic
+
+
+class Game:
+    """
+    The main entry point for the Mastermind game.
+
+    Args:
+        number_of_colors (int): The number of colors in the game.
+        number_of_dots (int): The number of dots in each combination.
+        maximum_attempts (int): The maximum number of attempts allowed in the game.
+        game_mode (str): The game mode, such as "HvH", "HvAI", "AIvH", or "AIvAI".
+    """
+
+    def __init__(self, number_of_colors, number_of_dots, maximum_attempts, game_mode):
+        self._state = GameParameter(
+            number_of_colors, number_of_dots, maximum_attempts, game_mode
+        )
+        self._board = self._state._board
+        self._player_logic = PlayerLogic(self._state)
+        self._game_flow = GameFlow(self._state, self._player_logic)
+
+    def start_game(self) -> Optional[str]:
+        """
+        Starts the game.
+
+        Returns:
+            Optional[str]: A command from the player, if any.
+        """
+        return self._game_flow.start_game()
+
+    def resume_game(self) -> Optional[str]:
+        """
+        Resumes the game.
+
+        Returns:
+            Optional[str]: A command from the player, if any.
+        """
+        return self._game_flow.resume_game()
+
+    def __len__(self) -> int:
+        """
+        Returns the number of attempts made in the game.
+        """
+        return len(self._board)
+
+    @property
+    def number_of_colors(self) -> int:
+        """
+        Returns the number of colors in the game.
+        """
+        return self._state.number_of_colors
+
+    @property
+    def number_of_dots(self) -> int:
+        """
+        Returns the number of dots in each combination.
+        """
+        return self._state.number_of_dots
+
+    @property
+    def maximum_attempts(self) -> int:
+        """
+        Returns the maximum number of attempts allowed in the game.
+        """
+        return self._state.MAXIMUM_ATTEMPTS
+
+    @property
+    def game_mode(self) -> str:
+        """
+        Returns the game mode.
+        """
+        return self._state.GAME_MODE

mastermind_ai-1.6.2b0/src/mastermind/game/game_flow.py

@@ -0,0 +1,75 @@
+from typing import Optional
+
+from mastermind.game.game_parameter import GameParameter
+from mastermind.game.player_logic import PlayerLogic
+
+
+class GameFlow:
+    """
+    Manages the flow of the Mastermind game.
+
+    Args:
+        game_state (GameState): The state of the game.
+        player_logic (PlayerLogic): The logic for the players.
+    """
+
+    def __init__(self, game_state: GameParameter, player_logic: PlayerLogic) -> None:
+        self.game_state = game_state
+        self.player_logic = player_logic
+
+    def start_game(self) -> Optional[str]:
+        """
+        Starts the game.
+
+        Returns:
+            Optional[str]: A command from the player, if any.
+        """
+        if self.game_state.game_started:
+            raise NotImplementedError("Game has already started.")
+
+        self.game_state.game_started = True
+        self.player_logic.initialize_players()
+        if self.player_logic.PLAYER_SETTER.set_secret_code() == "d":
+            return "d"  # code setter discarded the game
+
+        return self._play_game()
+
+    def resume_game(self) -> Optional[str]:
+        """
+        Resumes the game.
+
+        Returns:
+            Optional[str]: A command from the player, if any.
+        """
+        if not self.game_state.game_started:
+            raise NotImplementedError("Game has not started yet.")
+
+        return self._play_game()
+
+    def _play_game(self) -> Optional[str]:
+        """
+        Plays the game and retrieves a command from the player, if any.
+
+        Returns:
+            Optional[str]: A command from the player, if any.
+        """
+
+        command = self.player_logic.process_player_guessing()
+
+        self.output_result()
+        return command
+
+    def output_result(self) -> None:
+        """
+        Outputs the result of the game.
+        """
+        self.game_state.check_and_update_win_status()
+
+        if self.game_state.win_status is None:
+            return
+
+        if self.game_state.win_status:
+            self.player_logic.PLAYER_CRACKER.win_message()
+
+        else:
+            self.player_logic.PLAYER_CRACKER.lose_message()