Skip to main content

A Python package that simulates the Mastermind game with a powerful solver, with support for game for up to 9 colors and 9 pegs.

Project description

Mastermind Logo

Testing: Testing Status Test Coverage CodeFactor Codacy Badge
Version: GitHub tag GitHub Release Python Version PyPI - Version
Meta: GitHub License PyPI Status Repo Size pre-commit.ci status

Links:

Mastermind

A terminal Mastermind game with 4 modes and a built-in magic solver. Install with pip and play in seconds — no configuration needed.

What is Mastermind?

Mastermind is a classic code-breaking game: one player hides a secret code, the other tries to crack it. After each guess, you get feedback on how close you are — and you have to use that to narrow it down before you run out of attempts. Simple to learn, surprisingly deep to master.

Features

  • Play — Guess the secret code yourself
  • Watch — Let the AI solve it optimally
  • Assist — Get AI suggestions while playing a real game
  • Rules — Learn how to play

Getting Started

Prerequisites

Just install Python 3.12+ and pip — the Java runtime is bundled for Linux, Windows, and macOS.

For Android, install Termux and run pkg install openjdk-21 first.

Technical Details for Developers
  • JPype: bridges Python and Java at runtime, allowing the Python UI to call into the high-performance Java solver directly without a subprocess.

Installation

  1. Install Python 3.12+ if you haven't already.

  2. Install the latest release:

    pip install mastermind-ai
    
  3. Run the program:

    mastermind
    

[!TIP] If the above does not work, see the Troubleshooting Guide.

You can also try it in your browser with Google Colab.

Contributing

Contributions are welcome! See the Contributing Guidelines.

License

Licensed under MIT License by @FlysonBot.

Questions?

Feel free to leave questions in the Discussions or open an Issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mastermind_ai-2.2.1.tar.gz (42.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mastermind_ai-2.2.1-py3-none-any.whl (42.3 MB view details)

Uploaded Python 3

File details

Details for the file mastermind_ai-2.2.1.tar.gz.

File metadata

  • Download URL: mastermind_ai-2.2.1.tar.gz
  • Upload date:
  • Size: 42.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mastermind_ai-2.2.1.tar.gz
Algorithm Hash digest
SHA256 caecd67c898202989864acfd77a06370d8f93c8b62427566ba76d89e5520b2f9
MD5 12993742ddf8cb57cc1138b751fcef88
BLAKE2b-256 6143bd50440fbe6eb0c8d077db7906133f3a2ae25f5f36d904a0b1dcdcec8eb5

See more details on using hashes here.

File details

Details for the file mastermind_ai-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: mastermind_ai-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 42.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mastermind_ai-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7b97ad2715f1cfce3231599f70f1ae1bf223a2cd6a2ae0bac8825c9f31478392
MD5 16fd55e3f014fcc1c70700ea7fbed6e0
BLAKE2b-256 ab67e2daf3bb867864799ec58c44bcbcb6acdbec9a69efb2d1730c489414df3e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page