README.md

   1 # minesVIiper
   2
   3 minesVIiper is a clone of Minesweeper, which runs in the terminal and can be
   4 controlled by either `vi` style keybindings, or the mouse.
   5
   6 Multiple character and color schemes are available, but more can be added
   7 easily.
   8
   9 Complete documentation and screenshots can be found on the
  10 [**Homepage**](https://gir.st/mines.htm).
  11
  12 ## Keybindings and mouse
  13
  14 | Key             | Action                                       |
  15 | --------------- | -------------------------------------------- |
  16 | `h`/`j`/`k`/`l` | move one cell left / down / up / right       |
  17 | `b`/`d`/`u`/`w` | move to the next "word" boundary             |
  18 | `^`/`G`/`g`/`$` | move to the very left / bottom / top / right |
  19 | `i`             | flag / unflag                                |
  20 | `o`             | open / chord                                 |
  21 | space           | modeful, either open or flag                 |
  22 | `s`             | toggle mode for space (open/flag)            |
  23 | Ctrl-L          | redraw screen                                |
  24 | `:n`            | new game                                     |
  25 | `:h`            | show keybindings (Ctrl-L to hide)            |
  26 | `:r`            | resize playfield                             |
  27 | `:q`            | quit                                         |
  28
  29 Use the left mouse button to open or chord a cell, and the right button to flag.
  30
  31 A new game can be started by clicking on the `:D` icon.
  32
  33 ## Command line arguments
  34
  35 | Arg.            | Description                                   |
  36 | --------------- | --------------------------------------------- |
  37 | `-h`            | quick help                                    |
  38 | `-n`            | disable flagging                              |
  39 | `-f`            | enable flagging (default)                     |
  40 | `-q`            | enable question marks                         |
  41 | `-b`            | use the bland (monospace) scheme (default)    |
  42 | `-c`            | use the colored scheme                        |
  43 | `-d`            | use the DEC charset scheme                    |
  44 | *W*`x`*H*`x`*M* | Fieldspec, width \* height \* number of mines |
  45
  46 ## Character Schemes
  47
  48 By default, minesVIiper comes with three schemes; black-and-white, color, and
  49 DECTerm. The first two use unicode characters and therefore require a modern
  50 software terminal emulator like GNOME Terminal, XTerm, or others.
  51 The DEC color scheme uses Digital, Inc.'s proprietary *Special Graphics Character
  52 Set*, which is implemented on the VT220 and later models. (full support for this mode
  53 in terminal emulation software is rare)
  54
  55 ## Compiling and extending
  56
  57 To compile minesVIiper, just run `make`. The phony target `run` will compile and
  58 execute the program with the default settings (monochrome scheme, 30x16x99
  59 field).
  60
  61 While the main source of the program (`mines_2017.c`) is pure ASCII, `schemes.h`
  62 is UTF-8-encoded. Therefore, care must be taken when editing character schemes.
  63
  64 ## License
  65
  66 This program is released under the terms of the GNU GPL version 3.
  67 &copy; 2015-2018 Tobias Girstmair