https://github.com/painlypink/minesweeper
Quantum Minesweeper
https://github.com/painlypink/minesweeper
minesweeper minesweeper-game python python-3 python3 terminal-based terminal-game
Last synced: 4 months ago
JSON representation
Quantum Minesweeper
- Host: GitHub
- URL: https://github.com/painlypink/minesweeper
- Owner: PainlyPink
- Created: 2024-06-29T08:06:43.000Z (almost 2 years ago)
- Default Branch: tg
- Last Pushed: 2024-10-15T20:34:33.000Z (over 1 year ago)
- Last Synced: 2024-10-17T07:09:55.749Z (over 1 year ago)
- Topics: minesweeper, minesweeper-game, python, python-3, python3, terminal-based, terminal-game
- Language: Python
- Homepage:
- Size: 8.05 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minesweeper [WIP]
The OG game,
but not the same.
## Overview
This is a terminal-based variant of the classic Minesweeper game.
### Variant Backstory
Schrodinger has placed a few of his beloved cats inside these mysterious boxes. The uncertainty of whether they are alive or not weighs heavily on his mind. His faith in you compels him to seek your assistance. Aid Schrodinger in reuniting with his precious cats. Alive...
## Requirements
- Python 3.x
- TBA: [#20](https://github.com/ElektrikFire/Minesweeper/issues/20)
## Installation
1. **Clone the repository**:
```bash
git clone https://github.com/ElektrikFire/Minesweeper.git
cd Minesweeper
```
2. **Install dependencies** (if not automatically installed):
TBA: [#20](https://github.com/ElektrikFire/Minesweeper/issues/20)
## Running the Game
1. Navigate to the project directory:
```bash
cd Minesweeper
```
2. Run the game:
```bash
python main.py
```
## OR
### Running the executable:
[DEPRECATED] [#20](https://github.com/ElektrikFire/Minesweeper/issues/20)
1. **Download the Game:**
- Go to the [Releases](https://github.com/ElektrikFire/Minesweeper/releases) page of the repository.
- Download the zipped build directory file (e.g., `build.zip`).
2. **Extract the Zip File:**
- Extract the contents of the zip file to a directory on your computer.
3. **Run the Game:**
- Navigate to the extracted directory.
- Open a terminal in this directory and run the executable (e.g., `main.exe` on Windows).
---
## Gameplay
- Explore a grid filled with hidden boxes, some of which are uncertain.
- Your objective is to uncover all boxes without triggering any surprises to achieve victory.
- If you encounter a surprise, the game concludes, in dismay.
## Controls(under work)
- **Movement**: Use `W`, `A`, `S`, `D` or arrow keys to move around the board.
- **Open a box**: Press `Enter` to uncover the selected box.
- **Flag a box**: Press `F` to mark a box with a flag.
- **Exit**: Press `Esc` to quit the game.
---
## Authors
- **ElektrikFire** -
[ElektrikFire](https://github.com/ElektrikFire)
See also the list of
[contributors](https://github.com/ElektrikFire/Minesweeper/graphs/contributors)
who participated in this project.
## License
TBA: [#20](https://github.com/ElektrikFire/Minesweeper/issues/20)
## Acknowledgments
- Minesweeper, a logic puzzle video game genre
- Variants of Minesweeper
---