Skip to main content

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.

Metadata

Release files for mastermind-ai 2.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mastermind-ai 2.2.2
File Size Uploaded
mastermind_ai-2.2.2.tar.gz 42.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for mastermind-ai 2.2.2
File Interpreter ABI Platform
mastermind_ai-2.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 84.6 MB

Release files / mastermind_ai-2.2.2.tar.gz

Download URL mastermind_ai-2.2.2.tar.gz
Size 42.3 MB
Tags Source
SHA-256 checksum
How to use checksums
281e43fd775b8b964f408ed18e5ebcb8b5a067d186e76489554f40f8e1027d23
BLAKE2b-256 checksum
How to use checksums
ae007c6ee7f05f37b6c45fa1c0920484a54d2f9b299c5d88e2942942fdb24bc1
Upload date
Uploaded using Trusted Publishing?
What is 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}

Release files / mastermind_ai-2.2.2-py3-none-any.whl

Download URL mastermind_ai-2.2.2-py3-none-any.whl
Size 42.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
51265660680f926e6f932c3c2d71eef325b028a556d226ceff3bc50ff7857250
BLAKE2b-256 checksum
How to use checksums
ac74bef281e2af5e35dd602d8f895d9f774f7325381c7e4effab27ad9be05820
Upload date
Uploaded using Trusted Publishing?
What is 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}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page