From: Christian Heller Date: Thu, 12 Mar 2015 03:25:50 +0000 (+0100) Subject: Update file names in documentation. X-Git-Url: https://plomlompom.com/repos/?p=plomrogue;a=commitdiff_plain;h=436d36515ec10f31ab89e6867f59023177f560a2 Update file names in documentation. --- diff --git a/README b/README index e03e08d..1411572 100644 --- a/README +++ b/README @@ -63,14 +63,14 @@ Replay game recording --------------------- Once you start a new world, every move of yours is recorded in a file called -"record". It gets overwritten when a new game world is started after deletion -of the "savefile" file. Run "./roguelike -s" to watch the current game's +"record_save". It gets overwritten when a new game world is started after +deletion of the "save" file. Run "./roguelike -s" to watch the current game's recording from the beginning. Hit any player action key to increment turns (they -will not trigger the actions usually mapped to them, only repeat the actions -done at that point in the game as defined in the "record" file). Keys to manage -windows, scroll on the map and quit the program do their usual thing. Append a -number to the -s option (like "-s100") to start the recording at the respective -turn number. +will not trigger the actions usually mapped to them, only repeat theactions +done at that point in the game as defined in the "record_save" file). Keys to +manage windows, scroll on the map and quit the program do their usual thing. +Append a number to the -s option (like "-s100") to start the recording at the +respective turn number. Hacking / server internals and configuration -------------------------------------------- @@ -78,7 +78,8 @@ Hacking / server internals and configuration The game world is set up and made subject to player commands by ./roguelike-server. It's controlled by commands explained in the file ./SERVER_COMMANDS. The server usually reads these from the files ./server/in -(written to by ./roguelike-client), ./confserver/world, ./record and ./savefile. +(written to by ./roguelike-client), ./confserver/world, ./record_save and +./save. All source files are thoroughly documented to explain more details of plomrogue's internals. The ./roguelike-server executable can be run with a -v diff --git a/SERVER_COMMANDS b/SERVER_COMMANDS index c9468e9..0a011ce 100644 --- a/SERVER_COMMANDS +++ b/SERVER_COMMANDS @@ -4,33 +4,34 @@ Command reading and writing Normal mode ----------- -In normal mode, the server on start up checks for the existence of ./savefile -and, on success, reads all commands from it. If no savefile exists, commands -from ./confserver/world are read instead – and written to the file ./record. +In normal mode, the server on start up checks for the existence of ./save and, +on success, reads all commands from it. If no save file exists, commands from +./confserver/world are read instead – and written to the file ./record_save. Afterwards, the command "MAKE_WORLD" with the current Unix time as argument is -interpreted (and also written to ./record). +interpreted (and also written to ./record_save). In any case, from then on, further commands are read in from ./server/in. New commands must be appended to the file – which is what the client does. All -commands from ./server/in except meta commands are also written to ./record. +commands from ./server/in except meta commands are also written to +./record_save. -Every fifteen seconds, if any turns have passed, ./savefile is written – with a -list of all god commands necessary to recreate the current world state. On each -world state change, ./server/worldstate is updated and a message "WORLD_UPDATED" +Every fifteen seconds, if any turns have passed, ./save is written – with a list +of all god commands necessary to recreate the current world state. On each world +state change, ./server/worldstate is updated and a message "WORLD_UPDATED" written to ./server/out. Replay mode ----------- -In replay mode, commands from ./record are read. If a turn number is given as an -argument, the file is read until the given turn is reached, or, if the turn -number is higher than the last turn of the recorded play, the last turn. If no -turn number is given as argument, the record file is replayed until turn 1 is -reached. Meta commands in ./record are not understood. +In replay mode, commands from ./record_save are read. If a turn number is given +as an argument, the file is read until the given turn is reached, or, if the +turn number is higher than the last turn of the recorded play, the last turn. If +no turn number is given as argument, the record file is replayed until turn 1 is +reached. Meta commands in ./record_save are not understood. From then on, ./server/in is also read. Meta commands sent by the client are interpreted normally, but any player and god command merely furthers reading of -./record by one line and is otherwise ignored. +./record_save by one line and is otherwise ignored. Command list ============