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