Saves
The server can save the whole mission and bring it back where it left off — that is vanilla persistence, and the lobby feeds its own data into it. Since 1.6.0.
What it is for: the server crashed or had to be restarted in the middle of a fight, and the mission does not start over. People come back to their slots, their characters and their vehicles, the state and the timers carry on, and the replay keeps being written into the same file.
Setting up the server
Section titled “Setting up the server”In the server config, under game → gameProperties, add a persistence block:
"gameProperties": { "persistence": { "autoSaveInterval": 3, "saveRetention": 10, "loadSessionSave": true, "keepSessionSave": false, "hiveId": 0 }}| Field | What it sets |
|---|---|
autoSaveInterval |
how often the server saves, in minutes |
saveRetention |
how many saves are kept |
loadSessionSave |
whether the previous session’s save is loaded at startup. This is what continues the mission |
keepSessionSave |
whether the session save is kept after the mission ends normally |
hiveId |
a save storage shared by several servers; 0 means its own, separate one |
Setting up the mission
Section titled “Setting up the mission”The mission’s Mission header must have Configs/Systems/EchoLobbySystems.conf in the Systems Config field. That is the mod’s config: it switches the persistence system on and tells it how to save the lobby’s own data. Without it the server starts the mission from scratch after a restart.
What survives a restart
Section titled “What survives a restart”- the mission state and how long it has been running — the freezetime, the zone timers and the messages schedule carry on from where they stopped;
- the slots — who sat where. A slot is held for its player until he is back, and once he joins he gets his own character again. People are recognised by armaid, so a new player ID on reconnect breaks nothing;
- the characters — position, health, gear, alive or dead, and with them the slot’s own settings: the role and its place in the list;
- the groups — members, faction, AI waypoints;
- the vehicles — their position and state, and the squad they are assigned to;
- the map — player markers, mission markers and zones;
- Game Master edits — whatever was spawned and changed in the editor during the game;
- the replay — the recording continues in the same file instead of starting over;
- the mission statistics — kills, shots, time spent unconscious and the alive players graph, so the results after the fight are still complete.
Right after the load the world stands still for a minute and a half: AI and vehicles wait while players reconnect, so the fight does not run away without half of the people in it. Everybody sees a countdown on screen. The length is the Restore Freeze Seconds field in the gamemode settings.
Slot locks and the spawn points squads picked are not saved — after a restart the slots are open again and the spawns fall back to what the mission sets.
Starting the mission over
Section titled “Starting the mission over”As long as the save is there, the server will bring it back up. There are two ways to start clean:
#restartin the chat — an admin command on the server itself, the mission starts over;- delete the save before starting the server — it lives in the server’s profile folder, under
.save/, in a subfolder named after the mission.
See also
Section titled “See also”- Mission header — the Systems Config field
- Replays — the recording that survives a restart
- Gamemode settings — Restore Freeze Seconds
- Administration
