https://github.com/mordv/mnswpr

💣 Minesweeper game for your terminal
https://github.com/mordv/mnswpr

cli cli-app fun game ink nodejs npm-package react reactjs terminal terminal-game typescript

Last synced: about 11 hours ago
JSON representation

💣 Minesweeper game for your terminal

• Host: GitHub
• URL: https://github.com/mordv/mnswpr
• Owner: mordv
• License: mit
• Created: 2021-09-29T16:28:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-22T15:32:30.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T10:02:25.487Z (12 months ago)
• Topics: cli, cli-app, fun, game, ink, nodejs, npm-package, react, reactjs, terminal, terminal-game, typescript
• Language: TypeScript
• Homepage:
• Size: 564 KB
• Stars: 155
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• starred - mordv/mnswpr - 💣 Minesweeper game for your terminal (TypeScript)

README

        


    

    


	    🚩 A Minesweeper game for your terminal written with ReactJS & ink 😎

	    

    


## Run

```bash

npx mnswpr

```

## Install globally

```bash

npm install -g mnswpr

mnswpr

```

## Supported terminals

![legacy mode](https://user-images.githubusercontent.com/32086218/141684622-dcf166b5-1d66-4f03-a895-8f14edec6132.gif)

The interface works with emoji by default. If your terminal doesn't support it, you can either switch to legacy mode by pressing `l` button or update your terminal (For Windows I suggest  [Windows Terminal](https://github.com/microsoft/terminal))

## Options

```

Usage: mnswpr

Press h to show game controls.

Options:

  --legacy, -L  (or press l)

        Legacy mode. Use this if your terminal doesn't support emojis

      

  --quick [b|i|e|width,height,mines], -Q [b|i|e|width,height,mines] 

        Start game directly with one of the difficulties: [b|i|e]

	or a custom field: [width(5-50),height(5-25),mines(1-width*height*0.6)]

	

        Examples:

          mnswpr --quick b #start game with beginner difficulty

          mnswpr -Q 10,20,60 #start game with custom field width:10 height:20 mines:60

```