home · contact · privacy
Add TODO.
[plomrogue] / SERVER_COMMANDS
1 Command reading and writing
2 ===========================
3
4 Normal mode
5 -----------
6
7 In normal mode, the server on start up checks for the existence of ./savefile
8 and, on success, reads all commands from it. If no savefile exists, commands
9 from ./confserver/world are read instead – and written to the file ./record.
10 Afterwards, the command "MAKE_WORLD" with the current Unix time as argument is
11 interpreted (and also written to ./record).
12
13 In any case, from then on, further commands are read in from ./server/in. New
14 commands must be appended to the file – which is what the client does. All
15 commands from ./server/in except meta commands are also written to ./record.
16
17 At the end of each turn, ./savefile is written – with a list of all god commands
18 necessary to recreate the current world state.
19
20 Replay mode
21 -----------
22
23 In replay mode, commands from ./record are read. If a turn number is given as an
24 argument, the file is read until the given turn is reached, or, if the turn
25 number is higher than the last turn of the recorded play, the last turn. If no
26 turn number is given as argument, the record file is replayed until turn 1 is
27 reached. Meta commands in ./record are not understood.
28
29 From then on, ./server/in is also read. Meta commands sent by the client are
30 interpreted normally, but any player and god command merely furthers reading of
31 ./record by one line and is otherwise ignored.
32
33 Command list
34 ============
35
36 Each command is of a single line. It consists at least of one command stringe,
37 in some cases followed by an obligatory argument. Argument fields are described
38 below in square brackets. Number ranges are described by the first legal number,
39 followed by " to ", followed by the last legal number. "[string]" means any text
40 string is expected, which must be enclosed in single quotes if it contains
41 whitespaces. "[char]" means a single ASCII character is expected. If one of a
42 set of pre-defined strings is expected, the legal strings are divided by pipe
43 symbols ("|").
44
45 Meta commands
46 -------------
47
48 PING
49 Write "PONG" line to ./server/out file.
50
51 QUIT
52 Shut down server.
53
54 STACK
55 Write line-by-line list of items the player stands on into ./server/out file,
56 enclosed by two lines "THINGS_BELOW_PLAYER START" and "THINGS_BELOW_PLAYER END".
57
58 Player commands
59 ---------------
60
61 ai
62 Do what the AI would do.
63
64 wait
65 Make player character wait one turn.
66
67 move [east|south-east|south-west|west|north-west|north-east]
68 Make player character move into direction described by argument, or attack into
69 that direction if there is an enemy.
70
71 pick_up
72 Make player character pick up topmost thing it is standing on.
73
74 drop [0 to 255]
75 Make player character drop to the ground item of argument's position in the
76 player character's inventory.
77
78 use [0 to 255]
79 Make player character use item of argument's position in player character's
80 inventory.
81
82 God commands
83 ------------
84
85 TURN [0 to 65535]
86 Set world turn to argument. (Initial value: 0.)
87
88 PLAYER_TYPE [0 to 255]
89 Set to argument ID of thing type into which a new world's player character will
90 be generated. (Initial value: 0.)
91
92 SEED_RANDOMNESS [0 to 4294967296]
93 Set randomness seed to argument. (Initial value: 0.)
94
95 SEED_MAP [0 to 4294967296]
96 (Re-)generate map to seed of argument and map size.
97
98 MAKE_WORLD [0 to 4294967296]
99 Set map seed and randomness seed to argument. Remove all things. (Re-)generate
100 map. Add to map things specified in thing types table in quantity defined there
101 by START_NUMBER command, with first thing (of thing ID of 0) of type defined as
102 player type by PLAYER_TYPE command. Set world turn to 1. Activate world.
103
104 MAP_LENGTH [1 to 256]
105 Deactivate world. Remove ./server/worldstate file. Remove all things. Remove
106 map. Set map edge length to argument. (Initial value: 64.)
107
108 WORLD_ACTIVE [0 to 255]
109 Set world activity state to argument. If 0, remove ./server/worldstate file.
110 Else, if world was so far inactive, a map exists, at least one "wait" thing
111 action is defined, and a thing of ID 0 (= a player character) that is not part
112 of any other thing's inventory, (re-)build all animate things' fields of view and
113 activate world. (Initial value: 0.)
114
115 TA_ID [0 to 255]
116 Select thing action to manipulate by argument as ID. If argument is 0, change it
117 to the lowest unused thing action ID greater than 0. If action of ID does not
118 exist yet, create it with default name "wait" and default effort 1.
119
120 TA_EFFORT [0 to 255]
121 Set to argument the number of turns finishing the selected thing action takes.
122
123 TA_NAME [wait|move|use|drop|pick_up]
124 Set selected thing action's name (and thereby function, equal to player
125 command). Legal worlds need at least one action of name "wait", so if this
126 unsets the world's only "wait" action, the world is deactivated, and the
127 ./server/worldstate file removed.
128
129 T_ID [-32768 to 32767]
130 Select thing to manipulate by argument as ID. If argument is <0 or >255, change
131 it to the lowest unused thing ID. If thing of ID does not exist yet, create it
132 with default position of y=0/x=0, the first thing type's ID, and that type's
133 lifepoints value; if world is active and the thing is animate, build its field
134 of view.
135
136 T_TYPE [0 to 255]
137 Set selected thing's type ID to argument.
138
139 T_POSY [0 to 255]
140 Set selected thing's map row position to argument. Delete thing's field of view
141 and, if world is active, rebuild it.
142
143 T_POSX [0 to 255]
144 Set selected thing's map column position to argument. Delete thing's field of
145 view and, if world is active, rebuild it.
146
147 T_COMMAND [0 to 255]
148 Set to argument the action thing is currently performing, as identified by its
149 thing action ID, if a thing action of that ID is defined. If argument is 0, the
150 thing's command ID is set to that, implying that it is not performing any
151 action.
152
153 T_ARGUMENT [0 to 255]
154 Set selected thing's action argument value to argument.
155
156 T_PROGRESS [0 to 255]
157 Set selected thing's action progress (number of turns already invested in
158 performing the action) value to argument.
159
160 T_LIFEPOINTS [0 to 255]
161 Set selected thing's lifepoints to argument.
162
163 T_CARRIES [0 to 255]
164 Add thing of ID in argument to inventory of selected thing, if said thing is
165 available for carrying and not the selected thing.
166
167 T_MEMMAP [0 to 255] [string]
168 Set part of selected thing's memory of the game map to string argument: the line
169 of the argument's number.
170
171 T_MEMTHING [0 to 255] [0 to 255] [0 to 255]
172 Add to selected thing's memory of things on map thing of ID of first argument,
173 y position of second argument and x position of third argument.
174
175 TT_ID [-32768 to 32767]
176 Select thing type to manipulate by argument as ID. If argument is <0 or <255,
177 change it to the lowest unused thing type ID. If thing type of ID does not exist
178 yet, create it with default name "(none)", corpse ID equal to the new thing
179 type's ID, and remaining thing type attributes to 0.
180
181 TT_CONSUMABLE [0-255]
182 Set selected thing type's consumability value to argument – the number of
183 lifepoints earned by consuming/using things of that type.
184
185 TT_START_NUMBER [0-255]
186 Set selected thing type's number of things of type to spawn on successful
187 MAKE_WORLD command to argument.
188
189 TT_LIFEPOINTS [0-255]
190 Set selected thing type's initial lifepoints value to argument. Things of 0
191 lifepoints are considered inanimate, otherwise animate.
192
193 TT_SYMBOL [char]
194 Set to argument symbol by which things of the selected type are represented on
195 the map.
196
197 TT_NAME [string]
198 Set selected thing type's name to argument. This name identifies things in the
199 game log and the inventory.
200
201 TT_CORPSE_ID [0-255]
202 Set to argument the ID of the thing type that things of the selected type
203 transform into when their state changes from animate to inanimate.
204
205 TT_PROLIFERATE [0-255]
206 If non-zero, there is a chance of 1 divided by the given value each turn for any
207 thing of the selected type to emit an offspring to a random neighbor cell if one
208 is available that is passable and not inhabited by a thing of the same same type
209 or, if the proliferating thing is animate, any other animate thing.