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