semvec/pypi-packages huggingface dataset:
nachomines 1.0.4
Simple python minesweeper game using pygame
License: MIT
Requires Python: >=3.6

# NachoMines
*A python minesweeper game using pygame*

## Requires
* Python 3.6 or greater
* pygame

## Installation

```bash
pip3 install nachomines
```
or

```bash
git clone https://github.com/nachomonkey/NachoMines
cd nachomines
python3 setup.py install
```

## Launching the game

The **setup.py** script installs the "nachomines" python module, a "nachomines" console script, and a .desktop file on linux machines.

**To launch on Windows or Linux, run:**
```bash
python3 -m nachomines
```

**or if you cloned the repository, run:**

```bash
python3 run_game.py
```

On linux, an application by the name "NachoMines" should be found in the "Games" section of your application menu

## Gameplay and Controls
* Press <**Esc**> or <**Q**> to exit
### Main Menu

* The "Grid Subdivisions" drop-down menu selects the size of the game board
* The "Mine Density" drop-down menu controls the chance in percentage of a square containing a mine.
* The "Theme" drop-down menu decides if you want a light, dark, or **nacho** theme during gameplay.

### Game
Hover over the blocks using the cursor. Right-click to flag a block.
Left-click to show an empty square and the empty squares near it.

Win by flagging all of the mines.

# Credits

The success sound was a modified version of a [sound](https://freesound.org/people/kagateni/sounds/404360/) by kagateni on freesound.org

# License
Uses the MIT License. See the [LICENSE file](https://github.com/nachomonkey/NachoMines/blob/master/LICENSE) for further detail.