SaveData

The player's settings and the progress of three players, kept as key=value lines in savedata.txt.

Location

Purpose

SaveData is the game's persistent profile. It holds the global settings of the Setup screen (sound, volumes, controls, 3D terrain, 3D effects level, frame rate, texture size, full screen) and three independent player slots, shown in the main menu as players A, B and C. Each slot remembers the lives, the mission and world last played, whether there is progress to resume, and 200 door flags: one per mission number, set when that mission has been won, which is what opens the hubs' mission bars and the main hub's golden posts.

The original game stored a fixed 640-byte binary blob. Galaxy Eggbert deliberately does not copy that layout: savedata.txt is plain text, one key=value per line, readable and hand-editable. Each player's own galaxy has a second, separate progress record (galaxyN.* keys), so playing a galaxy never touches the campaign's doors and lives.

Collaborators

Uses

• UserFolder (UserPathString("savedata.txt")) for the file's path.

Used by

• GalaxyEggbertGame (member saveData_): loads it in its constructor (the full-screen preference is needed before the window opens), checkpoints progress at Win and Lost, stores the mission on every LoadMission, applies the Setup's toggles, and reads the door flags when it adapts a hub's doors (HubDoors).
• InputPad: the Setup and gamer-select screens report which toggle or slider changed; the host writes it into SaveData.
• ResumeLog and DemoReplay: a resume log and a demo carry the output of Write() as their start settings and feed it back through Read().
• TextureScale.hpp reads GetTextureScale() at start.

Key members

A selection of the public API declared in src/GalaxyEggbert/Game/SaveData.hpp. Most setters have a matching getter that is not listed separately.

The file: savedata.txt

Write() produces the lines in this order (shown here with the default values; the door strings are 200 characters of 0/1 and are shortened):

soundEnabled=1
jumpRight=1
autoZoom=1
accelActive=0
effectsVolume=100
musicVolume=100
accelSensitivity=50
fullscreen=0
terrainRelief=0
effectsLevel=0
frameRate=60
textureScale=0
selectedGamer=0
gamer0.lives=3
gamer0.missionNumber=0
gamer0.lastWorld=1
gamer0.hasProgress=0
gamer0.doorsUnlocked=0000...0000
gamer1.lives=3
...
gamer2.doorsUnlocked=0000...0000

Reading is tolerant: lines without = and unknown keys are skipped, an out-of-range selectedGamer is ignored, volumes are clamped, and an unknown frame rate falls back to 60.

Where the file lives

Since 2026-11-10 the player's files (savedata.txt, resume.txt, demos/, customworlds/) live in a per-user folder chosen at start (ChooseUserFolder() in src/GalaxyEggbertCNA/main.cpp):

• Desktop: CNA's storage root for "Galaxy Eggbert", i.e. $XDG_DATA_HOME or ~/.local/share/Galaxy Eggbert on Linux and %LOCALAPPDATA%\Galaxy Eggbert on Windows. --user DIR or the environment variable GALAXY_USER_DIR overrides it (the test scripts use their run folder).
• Web: /save, the browser-persisted (IDBFS) mount.
• Android: the app's private storage (its working folder).

A player of an earlier build, which kept these files in the working folder, has them copied (never moved or overwritten) the first time, when the new folder has no savedata.txt yet (CopyOldUserFiles()).

How it is used

The host never calls Save() directly but goes through GalaxyEggbertGame::SavePlayerData(), which refuses to write while a resume log is being reconstructed or a main-menu demo plays: both run the normal simulation with someone else's settings, and neither may change the player's profile. The checkpoint at the end of a mission looks like this (src/GalaxyEggbertCNA/GalaxyEggbertGameUpdate.cpp):

if (interaction_.GameOverCount() > gameOverCountBeforeUpdate)
{
    // Real MemorizeGamerProgress() checkpoint ...
    if (!editorPlayTestActive_)
    {
        saveData_.SetLives(interaction_.Lives());
        saveData_.SetMissionNumber(worldRuntime_.GetMissionNumber());
        saveData_.SetHasProgress(true);
        SavePlayerData();
    }
    SetPhase(GalaxyEggbert::Def::GamePhase::Lost);
}

At start-up the Resume screen is offered when resume.txt holds a valid resume log or when the selected slot's hasProgress is set; the log wins, the checkpoint (mission number and lives) is the fallback.

Rules and invariants

• Settings are global; progress is per slot. The single-slot accessors (GetLives() ...) always act on gamers_[selectedGamer_], or on the galaxy record in galaxy mode, which is why SetSelectedGamer() and Read() both keep the index in range.
• An editor play-test never writes progress: a custom world has no real mission number.
• Door flags are indexed by mission number directly, as the original's m_doors[].
• The text format is the contract shared with resume logs and demos: they embed the full Write() output, so adding a key is safe (old readers skip it), renaming one is not.

Tests

• VerifyGESaveData (tools/VerifyGESaveData.cpp): defaults without a file, round trips of every setting (full screen, sound, 3D terrain, the Setup toggles, volumes and their clamping), Reset(), progress and door flags, three independent slots, rejection of an out-of-range selectedGamer, and the galaxy records (no galaxy lines until a galaxy is played, campaign and galaxy progress kept apart, gate counts). It runs in its own directory of the build tree (verify-savedata/) because it creates and deletes savedata.txt where it runs.

Related pages

• Save Data & Resume
• ResumeLog, DemoReplay
• GalaxyEggbertGame, InputPad, HubDoors
• CustomWorldStorage (the galaxy's worlds; its progress is here)
• Configuration, Your Own Galaxy