Metadata-Version: 2.1
Name: minegauler
Version: 4.1.6
Summary: A clone of the original minesweeper game with many added features
Home-page: https://github.com/LewisGaul/minegauler
Author: Lewis Gaul
Author-email: minegauler@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/LewisGaul/minegauler/issues
Project-URL: Source, https://github.com/LewisGaul/minegauler/
Project-URL: Background, https://www.lewisgaul.co.uk/blog/coding/2020/02/12/minegauler/
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Topic :: Games/Entertainment :: Puzzle Games
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: attrs
Requires-Dist: PyQt5
Requires-Dist: requests
Requires-Dist: typing-extensions
Requires-Dist: zig-minesolver (<0.2,>=0.1.1)
Provides-Extra: bot
Requires-Dist: pytz ; extra == 'bot'
Requires-Dist: requests-toolbelt ; extra == 'bot'
Requires-Dist: tabulate ; extra == 'bot'

[![Build badge](https://img.shields.io/github/workflow/status/LewisGaul/minegauler/Workflow%20for%20full%20test%20matrix/dev)](https://github.com/LewisGaul/minegauler/actions?query=workflow%3A%22Workflow+for+full+test+matrix%22+branch%3Adev)
[![Codecov badge](https://img.shields.io/codecov/c/github/LewisGaul/minegauler/dev)](https://codecov.io/gh/LewisGaul/minegauler/)
[![PyPI badge](https://img.shields.io/pypi/v/minegauler.svg)](https://pypi.python.org/pypi/minegauler/)
[![Downloads badge](https://img.shields.io/github/downloads/LewisGaul/minegauler/total)](https://github.com/LewisGaul/minegauler/releases/)
[![Code style badge](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable/)


A perfect clone of the classic Minesweeper game, with many added features.

Read more about the project history on [the project homepage](https://github.com/LewisGaul/minegauler).


<img src="https://raw.githubusercontent.com/LewisGaul/minegauler/e3fa64f404952fe70ad8acaa83a53504e90e5e22/img/screenshots/beginner_start.png" height=250> <img src="https://raw.githubusercontent.com/LewisGaul/minegauler/e3fa64f404952fe70ad8acaa83a53504e90e5e22/img/screenshots/beginner_win.png" height=250> <img src="https://raw.githubusercontent.com/LewisGaul/minegauler/e3fa64f404952fe70ad8acaa83a53504e90e5e22/img/screenshots/split-cell-intermediate.png" height=250> <img src="https://raw.githubusercontent.com/LewisGaul/minegauler/e3fa64f404952fe70ad8acaa83a53504e90e5e22/img/screenshots/intermediate_probs.PNG" height=250>


## Install and Run

Install with `pip install minegauler`, and then run with `python -m minegauler`.


## Features

- Basic functional game
- Ability to specify custom board size/number of mines
- Ability to replay a game
- Mode to create boards
- Ability to save and load boards (created or played)
- Get current game information, including predicted completion time for lost game
- Option of whether first click will guarantee an opening
- Option to select cells by click-and-drag technique with the mouse
- Option to allow multiple mines per cell
- Local highscores for standard difficulty modes
- Highscores uploaded to remote server when there is an internet connection
- Custom cell styles
- Option to change the cell size
- Ability to reduce the window size and use scroll


## Contact

Email at minegauler@gmail.com, any questions/suggestions/requests welcome.

Alternatively, feel free to [open an issue](https://github.com/LewisGaul/minegauler/issues) if you find a bug or have a feature request.


