https://github.com/coteh/minesweeperclone

:boom: A clone of Minesweeper made using JavaScript and rendered with PixiJS.
https://github.com/coteh/minesweeperclone

javascript minesweeper pixi

Last synced: 24 days ago
JSON representation

:boom: A clone of Minesweeper made using JavaScript and rendered with PixiJS.

• Host: GitHub
• URL: https://github.com/coteh/minesweeperclone
• Owner: Coteh
• License: mit
• Created: 2015-12-09T06:11:43.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-08T02:49:52.000Z (about 1 month ago)
• Last Synced: 2024-12-08T03:25:40.518Z (about 1 month ago)
• Topics: javascript, minesweeper, pixi
• Language: JavaScript
• Homepage: http://coteh.github.io/MinesweeperClone/
• Size: 1.71 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![MinesweeperClone](img/Logo.png "MinesweeperClone Logo")

[![Run Tests](https://github.com/Coteh/MinesweeperClone/actions/workflows/run-tests.yml/badge.svg)](https://github.com/Coteh/MinesweeperClone/actions/workflows/run-tests.yml)

[![release | v1.0.6](https://img.shields.io/badge/release-v1.0.6-00b2ff.svg)](https://github.com/Coteh/MinesweeperClone/releases/tag/v1.0.6)

[![Play here](https://img.shields.io/badge/play-here-yellow.svg)](http://coteh.github.io/MinesweeperClone/)

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](screenshots/title.png "Title Screen")

![In-Game](screenshots/game.png "In-Game")

## Installation

To run the game locally, follow these steps:

1. **Install Dependencies**

   Run the following command to install the necessary dependencies:

   ```sh

   npm install

   ```

2. **Build the Game**

    Use the following command to build the game:

    ```sh

    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:

    ```sh

    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:

    ```sh

    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](https://github.com/Coteh/MinesweeperClone/issues/3)

## Future Additions

- Microsoft Mode (first click guaranteed not a mine)

- Timed Mode