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