# mui-minesweeper

> Classic Minesweeper game created using typescript and MUI (formerly knows as material UI)

Latest version **1.0.3** (published 2022-07-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install mui-minesweeper
pnpm add mui-minesweeper
yarn add mui-minesweeper
bun add mui-minesweeper
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-07-05 |
| First published | 2022-07-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 29.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yash Oza |
| Maintainers | yoza13 |
| Keywords | game, minesweeper, mui-game  |

## Links

- npm: https://www.npmjs.com/package/mui-minesweeper
- Repository: https://github.com/yoza13/mui-minesweeper
- Homepage: https://github.com/yoza13/mui-minesweeper.git#readme
- Issues: https://github.com/yoza13/mui-minesweeper/issues
- npm.io page: https://npm.io/package/mui-minesweeper

## Dependencies (11)

- [react](https://npm.io/package/react.md) ^17.0.2
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [ts-loader](https://npm.io/package/ts-loader.md) ^9.3.1
- [typescript](https://npm.io/package/typescript.md) ^4.7.4
- [file-loader](https://npm.io/package/file-loader.md) ^6.2.0
- [@mui/material](https://npm.io/package/@mui/material.md) ^5.8.7
- [@svgr/webpack](https://npm.io/package/@svgr/webpack.md) ^6.2.1
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.9.3
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.9.3
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.12.4
- [@mui/icons-material](https://npm.io/package/@mui/icons-material.md) ^5.8.4

## Recent versions

- 1.0.3 (latest) — 2022-07-05
- 1.0.2 — 2022-07-05
- 1.0.1 — 2022-07-05
- 1.0.0 — 2022-07-05

## README

# Classic Mine Sweeper Game

#### created using Typescript and MUI-core (formerly called Material-UI)

## Getting Started

Install this package:

```shell
npm install mui-minesweeper
```

Import the Counter component:

```js
import { Minesweeper } from "mui-minesweeper";
```

You can then render the `Minesweeper` component like any other React component in JSX.

Rendering this module in your application will also enable you to have a capability to select the difficulty level as below
![skill-selection](./src/images/Skill%20Level.png)

| Skill        | xFieldsCount              | yFieldCount               | bombCount                |
| ------------ | ------------------------- | ------------------------- | ------------------------ |
|              | Number of boxes in x-axis | Number of boxes in y-axis | Number of bombs on board |
| Beginner     | 8                         | 8                         | 10                       |
| Intermediate | 16                        | 16                        | 40                       |
| Expert       | 30                        | 16                        | 99                       |

![beginner-board](./src//images//Beginner.png)

##### Bombs selection on board is completely random and every new page load or render of the component will have bombs in different places

### Won

When the user wins the game
![win](./src/images/Won.png)

### Loss

When the user wins the game
![win](./src/images/Lost.png)

### Since this game uses right click to select mines, it is difficult to play on laptop or mobile devices and so in those devices, following warning is shown

![warning](./src/images/Warning.png)

---
_Source: https://npm.io/package/mui-minesweeper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._