home · contact · privacy
Updated README.
[plomrogue] / README
1 plomrogue
2 =========
3
4 plomlompom tries to build his own roguelike. Currently, it doesn't do much
5 interesting.
6
7 You can move around a player and meet a number of different enemies. You have 5
8 hitpoints to lose before death; they start with different amounts of hitpoints
9 depending on their species. Your score grows by killing enemies, to the amount
10 of hitpoints each killed enemy started with. Dead enemies become dirt,
11 skeletons or "magic meat"--such objects can be collected, and "magic meat" can
12 be consumed to gain hitpoints. Note that different kinds of moves take different
13 numbers of turns to finish.
14
15 Enemies' AI is very dumb so far: Each turn, they
16 try to move in the (beeline) direction of the nearest enemy, so they often bump
17 into obstacles.
18
19 There is only one save file (named "savefile"), and it gets overwritten each new
20 turn. To start over with a new world, delete it.
21
22 Install/run
23 -----------
24
25 Dependencies: the ncurses library.
26
27 git clone https://github.com/plomlompom/plomrogue
28 cd plomrogue
29 make
30 ./roguelike
31
32 Keybindings and window configuration
33 ------------------------------------
34
35 In the default window configuration, the window appearing on the left sports a
36 list of keybindings available globally and additionally via the window currently
37 selected as active.
38
39 Hit "w" (per default keybindings) to switch the "active" window to a view that
40 allows changing its geometry. One further hit on "w" switches the window to a
41 view that allows changing its window-specific keybindings. The global
42 keybindings may be changed in the "Global keys" window, those of the window
43 geometry configuration in the "Window geometry keys" window" and those of the
44 window-specific keybindings configuration in the "Window keybinding keys"
45 window; by default, these three windows are not visible, but may be turned on by
46 hitting the "F6", "F7" and "F8" keys.
47
48 What actions are available globally or only in specific windows can be further
49 manipulated by editing the files config/keybindings_global and
50 config/windows/Win_* that map keycodes to commands to the respective keybinding
51 repositories. While keybindings_global contains merely a list of keycode command
52 mappings, the Win_* files start with the name of the windows to be configured,
53 followed by a one-character line for internal use (mapping the window to one of
54 several internally available window content drawing functions), followed by two
55 lines describing the window's designated height and width, and only then an
56 optional list of keybindings specific to that window.
57
58 Replay game recording
59 ---------------------
60
61 Run "./roguelike -s" to watch a recording of the current game from the
62 beginning. Hit the "next turn / wait" key to increment turns. Keys to
63 manage windows, scroll on the map and quit the program are active; keys
64 to perform player actions are inactive. Append a number to the -s option
65 (like "-s100") to start the recording at the respective turn number.
66
67 Hacking
68 -------
69
70 The movements/actions available to the player and the enemies are defined and
71 can be changed in config/map_object_actions. Each line consists of, first, a
72 numerical ID used internally to manage the action, secondly the number of turns
73 the action takes, and thirdly a string representing the action internally.
74
75 The different map object types, i.e. species (including the player's human one)
76 and item types, can be edited in config/defs. Here the first value is a
77 numerical ID that represents the object type, the second one describes what type
78 this object decomposes to when it gets destroyed/killed, the third value is the
79 character used to represent the object visually on the map, the fourth value is
80 the number of hitpoints the object starts with (items are dead and start with
81 zero hitpoints, anything else moves), the fifth is the string that names the
82 object in the game log.