home · contact · privacy
Strongly overhauled keybinding managemment. Window-specific keybindings and a window...
[plomrogue] / README
1 plomrogue
2 =========
3
4 plomlompom tries to build his own roguelike. Currently, it doesn't do much
5 interesting, apart from managing keybindings and some ncurses windows in a
6 bizarre fashion.
7
8 You can move around a player and meet a number of different enemies. They move
9 randomly and will only accidentally hit you. You have 5 hitpoints to lose before
10 death; they have either 1, 3 or 9. Your score grows by killing enemies, to the
11 amount of hitpoints each killed enemy started with.
12
13 The map get generated randomly, too.
14
15 There is only one save file (named "savefile"), and it gets overwritten each new
16 turn. To start over with a new world, delete it.
17
18 Install/run
19 -----------
20
21 Dependencies: the ncurses library.
22
23 git clone https://github.com/plomlompom/plomrogue
24 cd plomrogue
25 make
26 ./roguelike
27
28 Keybindings and window configuration
29 ------------------------------------
30
31 In the default window configuration, globally available keybinings are shown at
32 game start in the three windows on the left of the screen. The lower two windows
33 describe keybindings / actions only available in a window's window configuration
34 views -- hit "w" (per default keybindings) to switch the selected / "active"
35 window to a view that allows changing its geometry. One further hit on "w"
36 switches the window to a view that lists keybindings available specifically for
37 that window -- such as for map scrolling actions in the "map" window. All
38 keybindings can be changed.
39
40 What actions are available globally or only in specific windows can be further
41 manipulated by editing the files config/keybindings_global and
42 config/windows/Win_* that map keycodes to commands to the respective keybinding
43 repositories. While keybindings_global contains merely a list of keycode command
44 mappings, the Win_* files start with the name of the windows to be configured,
45 followed by a one-character line for internal use (mapping the window to one of
46 several internally available window content drawing functions), followed by two
47 lines describing the window's designated height and width, and only then an
48 optional list of keybindings specific to that window.
49
50 Replay game recording
51 ---------------------
52
53 Run "./roguelike -s" to watch a recording of the current game from the
54 beginning. Hit the "next turn / wait" key to increment turns. Keys to
55 manage windows, scroll on the map and quit the program are active; keys
56 to perform player actions are inactive. Append a number to the -s option
57 (like "-s100") to start the recording at the respective turn number.