Updates And Recovery
Three different things get called an update: you redeploying your own changes, players getting a new release, and you adopting changes from the KAGRENAC template. Each keeps your settings and data, and each starts from a backup.
Three Kinds Of Update
- Your own changes. Commit them and ask your agent to deploy again. DwemerDistro backs up the server, then moves it to exactly that commit. Deploying the same commit again leaves code, config and data unchanged, but still repairs settings-file ownership if needed.
- A player's release update. Players update the mod's server from the launcher. Their private config, memories and data stay. Tell them in your release notes if the game mod download changed too.
- Template changes. Your mod has its own history, so KAGRENAC changes never arrive by themselves. Ask your agent to compare the template with your mod, bring over what you want and test again.
Versions
Control Panel > Diagnostics shows the server version, the protocol between game and server, the template baseline and the database schema. They are separate numbers and never stand in for each other. Bump the protocol only together with the game mod.
Backups Versus Checkpoints
| Kind | Contains |
|---|---|
| Full backup | The whole database and the private config |
| Dashboard backup, Control Panel > Backups | The database only |
| Checkpoint, Roleplay > Checkpoints | One session's conversation and notes, inside the same database |
Deploys and updates that change the code make a backup first. A checkpoint is lost with the database, so it is not a backup. Backups contain your token and keys: keep them private and out of Git. Checkpoints are covered in Characters & memory.
Database Changes
Updates only move the database forward, and running them twice is safe. If a step fails, the earlier ones stay and the backup is kept. Nothing downgrades a database automatically: the code and the database must match, and a mismatch shows not_migrated or schema_too_new. To go back, return to the older code and restore the backup made with that update.
Restore A Backup
Restoring replaces the database, so stop the game first. Verify restore on Control Panel > Backups checks a backup in a separate copy without touching the live database. The exact restore steps are in SETUP.md, Back up and update; your agent can walk you through them.
Legacy Installs And Branches
- Installs from earlier guides, including
mainanddevbranch installs, keep working and keep their own update route. - A release package never takes over an existing branch install with the same id. Keep your developer install separate when testing a player release.
- If you offer more than one branch, make every database change additive so players can switch both ways.
Full reference: SETUP.md, Back up and update and LAUNCHER_CUSTOM_MOD.md.
Next step: Publish your mod.
KAGRENAC
Get started