Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iqxd/vim-mine-sweeping

mine sweeping game in vim and neovim
https://github.com/iqxd/vim-mine-sweeping

game mine neovim sweeping vim vimscript

Last synced: about 2 months ago
JSON representation

mine sweeping game in vim and neovim

Awesome Lists containing this project

README

        

# vim-mine-sweeping
mine sweeping game in vim and neovim

## ScreenShot
![screenshot](https://user-images.githubusercontent.com/13008913/111640012-bcad0800-8836-11eb-85c3-bf20af90c1ba.png)
-

## Installation
```vimscript
" vim-plug
Plug 'iqxd/vim-mine-sweeping'
```
```lua
-- packer
use 'iqxd/vim-mine-sweeping'
```

## Usage
* Launch `Vim Mine Sweeping` with command `:MineSweep`
* Press h, j, k, l or `arrow key` to move between cells
* Press c or `double left-click mouse` to reveal a cell,
* Press f or `right-click mouse` to toggle flag on a cell
* Press n g to start a new game
* Press p b to print all mines and numbers in board
* Press ? to toggle help
* Press Z Z to exit current game

## Options
Command `:MineSweep` can be called with following arugments:
> `:MineSweep` `easy | medium | hard | row col` `-e | -n | -v | -t`
* `easy` 9 x 9 board
* `medium` 16 x 16 board
* `hard` 24 x 24 board
* `row col` user defined row x col board
* `-e` create board in current window
* `-n` create board in new split window
* `-v` create board in new vsplit window
* `-t` create board in new tabpage
* `-f` create board in new floating window (neovim only)

The default `:MineSweep` are equal to command with arguments like:
> `:MineSweep` `12 20` `-v`

which create game with 12 x 20 board in a new vsplit window

You can also map the command in vimrc like below
```vimscript
nnoremap :MineSweep medium -t
```

---
**Enjoy! :)**