home · contact · privacy
Add to TODO.
[plomrogue] / README
1 plomrogue
2 =========
3
4 plomlompom tries to build his own roguelike. It doesn't do much yet (although
5 plomlompom has insanely ambitious long-term plans).
6
7 You can move around a player on an island and meet different enemies. You have 5
8 hitpoints to lose before death. Enemies start with different amounts of
9 hitpoints, depending on their species. Dead enemies become dirt, skeletons or
10 "magic meat" -- such objects can be collected, and "magic meat" can be consumed
11 to gain hitpoints. Note that different kinds of movements/actions take different
12 numbers of turns to finish.
13
14 Enemies' AI is very dumb so far: Each turn, they try to move towards their
15 shortest-path-wise nearest enemy visible to them. If they see no enemy, they
16 just wait.
17
18 Every move of yours re-writes a file "savefile" that describes the new state of
19 the world. Once you re-start the game, the game state is recreated from the
20 "savefile" file. To start over in a new world, simply delete this file.
21
22 System requirements / installation / running the game
23 -----------------------------------------------------
24
25 The game is expected to run on Linux systems that contain the ncurses library.
26 (It may also work on other Unix-like systems with ncurses, who knows.) Do the
27 following steps:
28
29 $ git clone https://github.com/plomlompom/plomrogue
30 $ cd plomrogue
31 $ ./redo
32 $ ./roguelike
33
34 (If you got a redo build system installed and in your $PATH, you could also do a
35 simple "redo" instead of "./redo". The ./redo script calls a simple partial
36 shell script implementation of redo stored below build/redo_scripts/, written by
37 Nils Dagsson Moskopp a.k.a. erlehmann.)
38
39 ./redo generates two executables ./roguelike-server and ./roguelike-client.
40 ./roguelike is a pre-existing shell script that merely executes both of them,
41 with the server as a background job. You can also ignore the script and start
42 the two by hand.
43
44 Client's keybindings and window management
45 ------------------------------------------
46
47 In the client's default window configuration, the window appearing on the left
48 sports a list of keybindings available globally, and additionally via the window
49 selected as active.
50
51 Hit "W" (per default keybindings) to switch the "active" window to a view that
52 allows changing its geometry. One more hit on "W" switches the window to a view
53 that allows changing its window-specific keybindings. The global keybindings can
54 be changed in the "Global keys" window, those of the window geometry
55 configuration in the "Window geometry keys" window, and those of the
56 window-specific keybindings configuration in the "Window keybinding keys"
57 window; by default, these three windows are not visible, but may be turned on by
58 (per default keybindings) hitting the "F6", "F7" and "F8" keys.
59
60 Keybindings and default window selection / visibilities / geometries are read
61 from the textfile ./confclient/interface_conf by default, or by another one
62 named by the -i command line option of the client. Some other default window
63 configurations are stored below ./confclient/single_windows/: "map", "info",
64 "inventory" and "log". Each of these opens up only a single window into the
65 client, filling up the entire terminal. This may be useful for running multiple
66 clients in parallel in multiple terminal windows that can be managed by one's
67 own window manager choice, instead of relying on plomrogue-client's bizarre
68 in-client window management.
69
70 Replay game recording
71 ---------------------
72
73 Once you start a new world, every move of yours is recorded in a file called
74 "record". It gets overwritten when a new game world is started after deletion
75 of the "savefile" file. Run "./roguelike -s" to watch the current game's
76 recording from the beginning. Hit any player action key to increment turns (they
77 will not trigger the actions usually mapped to them, only repeat the actions
78 done at that point in the game as defined in the "record" file). Keys to manage
79 windows, scroll on the map and quit the program do their usual thing. Append a
80 number to the -s option (like "-s100") to start the recording at the respective
81 turn number.
82
83 Hacking / server internals and configuration
84 --------------------------------------------
85
86 [THIS SECTION IS OUT OF DATE (but kept as long as there's nothing better yet)]
87
88 The ./confserver/world file defines the thing types, actions available to them,
89 the map geometry and the thing type (species) of the player. Each definition
90 consists of a single- or multi-line block wherein each line sets one attribute.
91
92 Here's a typical action definition block:
93
94 ACTION 1
95 NAME move
96 EFFORT 5
97
98 A line of "ACTION" followed by a number starts an action definition block and
99 sets the action's id (must be > 0) for internal use to 1. The number after
100 "EFFORT" determines how many turns this action takes for the actor performing
101 it. The string after "NAME" names the action. Furthermore, if it is one of
102 "move", "pick_up", "drop" or "use", it matches internal functions described by
103 these strings to this action. All other names (including "wait") currently are
104 matched to a do-nothing wait function.
105
106 Here's a typical thing type definition block: 
107
108 THINGTYPE 2
109 NAME ZOMBIE
110 SYMBOL z
111 LIFEPOINTS 3
112 CORPSE_ID 5
113 CONSUMABLE 0
114 START_NUMBER 9
115
116 A line of "THINGTYPE" followed by a number starts it, and the number sets the
117 thing type's internal id. The number after "CONSUMABLE" defines the thing as
118 consumable (and to so many hitpoints gain). The character after "SYMBOL" is the
119 one shown on the map to represent to thing type. "LIFEPOINTS" is the start
120 hitpoints value for this thing type and defines it as animate if it is non-zero.
121 The string after "NAME" sets the thing type's name. "CORPSE_ID" sets the id of
122 the thing type that things of this type degrade to if their hitpoints drop to
123 zero if they start out as inanimate (what is not implemented yet: or if they are
124 inanimate, but are otherwise crushed). Note that the "CORPSE_ID" must match the
125 id of a thing type defined in the file (before or after, it may even be the
126 same). "START_NUMBER" sets the number of things that are to appear of the
127 given type on the map on game start.
128
129 The map is defined by a single-line block. Its number value sets the map
130 square's edge length. It must be >= 1 and <= 256:
131
132 MAP_LENGTH 64
133
134 The player type / species is also defined by a single line block. Its number
135 value sets the player's creature's thing type by its id:
136
137 PLAYER_TYPE 0
138
139 All these definition block members must be present within their respective
140 blocks, but only "ACTION" and "THINGTYPE" must be positioned at their respective
141 blocks' first line; the others may appear in whatever order and even multiple
142 times. If a thing or action definition block is finished, however, it cannot
143 be re-defined by starting a new block with the same thing type or action id.
144
145 Tokens in this config file are separated by whitespace. Single quotes can be
146 put around string values that are to include whitespace by themslves. Note that
147 all numbers must be decimal representations of unsigned 8 bit integers, i.e.
148 >= 0 and < 256 and sans preceding "+".
149
150 All source files are thoroughly documented to explain more details of
151 plomrogue's internals. The ./roguelike-server executable can be run with a -v
152 option for helpful debugging info (mostly: what messages the client sends to the
153 server). Server and client communicate via files in the ./server/ directory
154 (generated when the server is first run). The ./server/in file is read by the
155 server for newline-delimited commands. The ./server/out file contains server
156 messages to be read by clients. The ./server/worldstate file contains a
157 serialized representation of the game world's data as it is to be visible to
158 the player / the player's client.