home · contact · privacy
Client: In "Standing on", mark emptiness against lack of server input.
[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 STACK
57 Write line-by-line list of items the player stands on into ./server/out file,
58 enclosed by two lines "THINGS_BELOW_PLAYER START" and "THINGS_BELOW_PLAYER END".
59
60 Player commands
61 ---------------
62
63 ai
64 Do what the AI would do.
65
66 wait
67 Make player character wait one turn.
68
69 move [east|south-east|south-west|west|north-west|north-east]
70 Make player character move into direction described by argument, or attack into
71 that direction if there is an enemy.
72
73 pick_up
74 Make player character pick up topmost thing it is standing on.
75
76 drop [0 to 255]
77 Make player character drop to the ground item of argument's position in the
78 player character's inventory.
79
80 use [0 to 255]
81 Make player character use item of argument's position in player character's
82 inventory.
83
84 God commands
85 ------------
86
87 TURN [0 to 65535]
88 Set world turn to argument. (Initial value: 0.)
89
90 PLAYER_TYPE [0 to 255]
91 Set to argument ID of thing type into which a new world's player character will
92 be generated. (Initial value: 0.)
93
94 SEED_RANDOMNESS [0 to 4294967296]
95 Set randomness seed to argument. (Initial value: 0.)
96
97 SEED_MAP [0 to 4294967296]
98 (Re-)generate map to seed of argument and map size.
99
100 MAKE_WORLD [0 to 4294967296]
101 Set map seed and randomness seed to argument. Remove all things. (Re-)generate
102 map. Add to map things specified in thing types table in quantity defined there
103 by START_NUMBER command, with first thing (of thing ID of 0) of type defined as
104 player type by PLAYER_TYPE command. Set world turn to 1. Activate world. Answer
105 with 'NEW_WORLD' message in ./server/out file.
106
107 MAP_LENGTH [1 to 256]
108 Deactivate world. Remove ./server/worldstate file. Remove all things. Remove
109 map. Set map edge length to argument. (Initial value: 64.)
110
111 WORLD_ACTIVE [0 to 255]
112 Set world activity state to argument. If 0, remove ./server/worldstate file.
113 Else, if world was so far inactive, a map exists, at least one "wait" thing
114 action is defined, and a thing of ID 0 (= a player character) that is not part
115 of any other thing's inventory, (re-)build all animate things' fields of view and
116 activate world. (Initial value: 0.)
117
118 TA_ID [0 to 255]
119 Select thing action to manipulate by argument as ID. If argument is 0, change it
120 to the lowest unused thing action ID greater than 0. If action of ID does not
121 exist yet, create it with default name "wait" and default effort 1.
122
123 TA_EFFORT [0 to 255]
124 Set to argument the number of turns finishing the selected thing action takes.
125
126 TA_NAME [wait|move|use|drop|pick_up]
127 Set selected thing action's name (and thereby function, equal to player
128 command). Legal worlds need at least one action of name "wait", so if this
129 unsets the world's only "wait" action, the world is deactivated, and the
130 ./server/worldstate file removed.
131
132 T_ID [-32768 to 32767]
133 Select thing to manipulate by argument as ID. If argument is <0 or >255, change
134 it to the lowest unused thing ID. If thing of ID does not exist yet, create it
135 with default position of y=0/x=0, the first thing type's ID, and that type's
136 lifepoints value; if world is active and the thing is animate, build its field
137 of view.
138
139 T_TYPE [0 to 255]
140 Set selected thing's type ID to argument.
141
142 T_POSY [0 to 255]
143 Set selected thing's map row position to argument. Delete thing's field of view
144 and, if world is active, rebuild it.
145
146 T_POSX [0 to 255]
147 Set selected thing's map column position to argument. Delete thing's field of
148 view and, if world is active, rebuild it.
149
150 T_COMMAND [0 to 255]
151 Set to argument the action thing is currently performing, as identified by its
152 thing action ID, if a thing action of that ID is defined. If argument is 0, the
153 thing's command ID is set to that, implying that it is not performing any
154 action.
155
156 T_ARGUMENT [0 to 255]
157 Set selected thing's action argument value to argument.
158
159 T_PROGRESS [0 to 255]
160 Set selected thing's action progress (number of turns already invested in
161 performing the action) value to argument.
162
163 T_LIFEPOINTS [0 to 255]
164 Set selected thing's lifepoints to argument.
165
166 T_CARRIES [0 to 255]
167 Add thing of ID in argument to inventory of selected thing, if said thing is
168 available for carrying and not the selected thing.
169
170 T_MEMMAP [0 to 255] [string]
171 Set part of selected thing's memory of the game map to string argument: the line
172 of the argument's number.
173
174 T_MEMTHING [0 to 255] [0 to 255] [0 to 255]
175 Add to selected thing's memory of things on map thing of ID of first argument,
176 y position of second argument and x position of third argument.
177
178 TT_ID [-32768 to 32767]
179 Select thing type to manipulate by argument as ID. If argument is <0 or <255,
180 change it to the lowest unused thing type ID. If thing type of ID does not exist
181 yet, create it with default name "(none)", corpse ID equal to the new thing
182 type's ID, and remaining thing type attributes to 0.
183
184 TT_CONSUMABLE [0-255]
185 Set selected thing type's consumability value to argument – the number of
186 lifepoints earned by consuming/using things of that type.
187
188 TT_START_NUMBER [0-255]
189 Set selected thing type's number of things of type to spawn on successful
190 MAKE_WORLD command to argument.
191
192 TT_LIFEPOINTS [0-255]
193 Set selected thing type's initial lifepoints value to argument. Things of 0
194 lifepoints are considered inanimate, otherwise animate.
195
196 TT_SYMBOL [char]
197 Set to argument symbol by which things of the selected type are represented on
198 the map.
199
200 TT_NAME [string]
201 Set selected thing type's name to argument. This name identifies things in the
202 game log and the inventory.
203
204 TT_CORPSE_ID [0-255]
205 Set to argument the ID of the thing type that things of the selected type
206 transform into when their state changes from animate to inanimate.
207
208 TT_PROLIFERATE [0-255]
209 If non-zero, there is a chance of 1 divided by the given value each turn for any
210 thing of the selected type to emit an offspring to a random neighbor cell if one
211 is available that is passable and not inhabited by a thing of the same same type
212 or, if the proliferating thing is animate, any other animate thing.