Skip to content

danielsquitt/minesweeper

Repository files navigation

MINESWEEPER

Overview

1. Introduction

Minesweeper is a one player game created by Curt Johnson y Robert Donner in 1989. The game ends when you discover all de mines without detonating any of them. To accomplish this objective, the board gives clues about how many bombs there are around.

This game showed up, for the first time in Windows, in 1990 with Windows 3.1. Different version of these games has been included in all standard Windows until Windows 8 (2012) and later. But you can download it from the Microsoft Store

2. Motivation

Minesweeper is a game that is fast to play, where you have to think, deduct, and guess. I've been playing it since my childhood on all Windows versions and it's currently the only game I got install in mobile phone.

3. Installation

  1. Downloading the project

    • Clone git repository
    git clone https://github.com/danielsquitt/minesweeper.git
  2. Install dependencies

    yarn install

4. Play the game:

  • Local:
   yarn run play

5. Instructions

To win you need to uncover all cells without mines. If you uncover a cell with a mine this will explete and you will lose. To help you, each empty cell has a number that matches the number of mines surrounding the cell. Controls:

  • Left Click: Discover the cell.
  • Right Click: Flag the cell.
  • Left + Right Click: If number of flags matches the surrounded mines, discover all surrounded cells.

6. Packages and dependencies

  • Typescript: Suport for typescript
  • Lodash: JS utility library
  • Parcel: Fast and easy server build
  • Eslint: Code Styling
  • rimraf: Execute UNIX cmd "rm -rf" with node.

7. Structure