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