Skip to content

Latest commit

 

History

History
122 lines (76 loc) · 8.6 KB

README.md

File metadata and controls

122 lines (76 loc) · 8.6 KB
Raw

Testing: Testing Status Test Coverage Docs Deploy Status CodeFactor Codacy Badge
Version: GitHub tag GitHub Release Python Version PyPI - Version
Activity: Opened Issue Count Closed Issue Count Closed PR Count PyPI - Downloads
Meta: GitHub License PyPI Status Repo Size pre-commit.ci status

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:

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.

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.

Contribution Wanted!!!

Currently the project only has 1 contributor, me, and I'm getting busy on schoolwork. Please come and contribtue! You don't need to know how to code to contribute. Simple open up issues or discussion when you found bugs or have some suggestion to the project.

If you want to contribute to the code, feel free to fork and submit pull request! Try to follow the conventional commit style when writing commit message. Any help is appreciated! To get started, you can take a look at the issues labeled as good first issue which contain a list of tasks that are easy to do that can help you get started with contributing to the project!

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

Installation Guide

  1. Install Python 3.10+ if you have not already.

  2. Install this the latest python release using pip in your terminal:

    pip install mastermind-ai

  3. Run the program with the following command:

    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:

    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:

    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:

    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, and we will try to help you out. Or alternatively you can run the program in your browser

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

All contributors must adhere to the Contributor Covenant Code of Conduct to ensure a welcoming and inclusive environment for all contributors.

To contribute to the code directly, you must also follow the Contributing Guidelines to ensure a smooth and efficient collaboration process.

License

Licensed under MIT License by @FlysonBot.

Questions?

If you have any questions, please feel free to leave them in the Discussions or open up an Issue.