Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 1.93 KB

README.md

File metadata and controls

59 lines (42 loc) · 1.93 KB

MinesweeperClone

Run Tests release | v1.0.6 Play here

Simple clone of the well-known Minesweeper game. Created using JavaScript, Node.js, and PixiJS.

Features

  • Simple and familiar Minesweeper gameplay
  • Ability to initialize a Minesweeper instance with specified height and width of board, and amount of mines
  • Game rendering with PixiJS

Screenshots

Title Screen In-Game

Installation

To run the game locally, follow these steps:

  1. Install Dependencies

    Run the following command to install the necessary dependencies:

    npm install
  2. Build the Game

    Use the following command to build the game:

    npm run build
  3. Serve the Game Locally

    Run a local server to serve the contents of the build directory and open the game in your browser:

    npm run serve

    Then open http://localhost:4173 to play the game locally.

  4. Development Mode

    To run the game in development mode, use the following command:

    npm run dev

    Then open http://localhost:5173 to play the game locally in development mode. The game will reload on changes in the source.

Issues

  • Unit and Integration testing is limited
  • Stack overflow (RangeError) when recursive revealing boards with dimensions 100x100 or greater #3

Future Additions

  • Microsoft Mode (first click guaranteed not a mine)
  • Timed Mode