]> git.gir.st - minesVIiper.git/blob - README.md
add note that sending drcs breaks vt220
[minesVIiper.git] / 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 | `p` | chord all open adjacent cells |
22 | space | modeful, either open or flag |
23 | `s` | toggle mode for space (open/flag) |
24 | `r` | restart game |
25 | Ctrl-L | redraw screen |
26 | `:h` | show keybindings (Ctrl-L to hide) |
27 | `:r` | resize playfield |
28 | `:q` | quit |
29
30 Use the left mouse button to open or chord a cell, and the right button to flag.
31
32 A new game can be started by clicking on the `:D` icon.
33
34 ## Command line arguments
35
36 | Arg. | Description |
37 | --------------- | --------------------------------------------- |
38 | `-h` | quick help |
39 | `-n` | disable flagging |
40 | `-f` | enable flagging (default) |
41 | `-q` | enable question marks |
42 | `-b` | use the bland (monospace) scheme (default) |
43 | `-c` | use the colored scheme |
44 | `-d` | use the DEC charset scheme |
45 | *W*`x`*H*`x`*M* | Fieldspec, width \* height \* number of mines |
46
47 ## Character Schemes
48
49 By default, minesVIiper comes with three schemes; black-and-white, color, and
50 DECTerm. The first two use unicode characters and therefore require a modern
51 software terminal emulator like GNOME Terminal, XTerm, or others.
52 The DEC color scheme uses Digital, Inc.'s proprietary *Special Graphics Character
53 Set*, which is implemented on the VT220 and later models. (full support for this mode
54 in terminal emulation software is rare)
55
56 ## Compiling and extending
57
58 To compile minesVIiper, just run `make`. The phony target `run` will compile and
59 execute the program with the default settings (monochrome scheme, 30x16x99
60 field).
61
62 While the main source of the program (`mines_2017.c`) is pure ASCII, `schemes.h`
63 is UTF-8-encoded. Therefore, care must be taken when editing character schemes.
64
65 ## License
66
67 This program is released under the terms of the GNU GPL version 3.
68 © 2015-2018 Tobias Girstmair
Imprint / Impressum