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`/`b`/`^` | move 1/5/all to the left  |
  17 | `j`/`d`/`G` | move 1/5/all down         |
  18 | `k`/`u`/`g` | move 1/5/all up           |
  19 | `l`/`w`/`$` | move 1/5/all to the right |
  20 | `i`         | flag / unflag             |
  21 | space       | open / chord              |
  22 | `r`         | restart game              |
  23 | Ctrl-L      | redraw screen             |
  24 | `q`         | quit                      |
  25
  26 Use the left mouse button to open or chord a cell, and the right button to flag.
  27
  28 A new game can be started by clicking on the `:D` icon.
  29
  30 ## Command line arguments
  31
  32 | Arg.   | Description                      |
  33 | ------ | -------------------------------  |
  34 | `-h`   | quick help                       |
  35 | `-w N` | set field width to N cells       |
  36 | `-h N` | set field height to N cells      |
  37 | `-m N` | set number of mines to N         |
  38 | `-n`   | disable flagging                 |
  39 | `-f`   | enable flagging (default)        |
  40 | `-q`   | enable question marks            |
  41 | `-c`   | switch to the colored scheme     |
  42 | `-d`   | switch to the DEC charset scheme |
  43
  44 ## Character Schemes
  45
  46 By default, minesVIiper comes with three schemes; black-and-white, color, and
  47 DECTerm. The first two use unicode characters and therefore require a modern
  48 software terminal emulator like GNOME Terminal, XTerm, or others.
  49 The DEC color scheme uses Digital, Inc.'s proprietary *Special Graphics Character
  50 Set*, which is implemented on the VT220 and later models. (full support for this mode
  51 in terminal emulation software is rare)
  52
  53 ## Compiling and extending
  54
  55 To compile minesVIiper, just run `make`. The phony target `run` will compile and
  56 execute the program with the default settings (monochrome scheme, 30x16x99
  57 field).
  58
  59 While the main source of the program (`mines_2017.c`) is pure ASCII, `schemes.h`
  60 is UTF-8-encoded. Therefore, care must be taken when editing character schemes.
  61
  62 ## License
  63
  64 This program is released under the terms of the GNU GPL version 3.
  65 &copy; 2015-2017 Tobias Girstmair