Server Backup
- By
Automatic zipped backups of your server world on a timer, with retention and a final backup on shutdown. /serverbackup now, list, status.
Server Backup
Automatic zipped backups of the server's world data, with retention. The thing every server owner sets up on day one. Server-side only.
Features
- Zips the server's
universefolder (worlds, player data, universe resources) every N minutes (default 60) intobackup-YYYYMMDD-HHmmss.zip. - Keeps only the newest
keeparchives (default 10); older ones are deleted after each run. - Finds the real universe folder from the running server, so a custom
--universepath is picked up automatically;sourceDiroverrides it. - Skips the timer run when nobody is online and nothing changed since the last backup, so an idle server does not fill the disk with identical archives.
- Tells online players "Backup starting..." and "Backup done (12.3 MB, 4.1 s)"; prefix and colour are configurable.
- Runs one final backup on server shutdown (after letting a running one finish).
- Live-safe: files that vanish or are being written mid-walk are retried once, then skipped and counted, never aborting the archive. Archives are written as
.partand renamed when complete. /serverbackup nowstarts a backup,/serverbackup listshows the newest ten with sizes,/serverbackup statusshows the last run, next run and archive count. Alias/sbackup. Operator-only.
Why not /backup? The Hytale server reserves that name for its own --backup command-line option. Server Backup works without any server flags and can run alongside it.
Settings
serverbackup.properties in the mod's data directory (created on first start):
| Key | Default | Meaning |
|---|---|---|
intervalMinutes |
60 |
Minutes between timer backups; 0 = manual only (/serverbackup now and the shutdown backup still work) |
keep |
10 |
How many newest archives to keep; older ones are deleted after each run (minimum 1) |
targetDir |
backups |
Where archives go; relative paths are inside the mod's data directory |
sourceDir |
(empty) | Folder to archive, relative to the server working directory; empty = the running server's universe folder |
onlyWhenPlayersOnline |
true |
Skip a timer backup when nobody is online and no file changed since the last backup |
announce |
true |
Broadcast start / done / failed lines to online players |
backupOnShutdown |
true |
Run one final backup when the server shuts down |
prefix |
[Backup] |
Text in front of every announcement; empty for none |
color |
#55FF55 |
Announcement colour |
The server log records every run at INFO: source, archive path, size, file count, duration and how many old archives were pruned.
Restore: stop the server, unzip the archive next to the server jar (it contains the universe/ folder), start the server.
Install: drop the jar into the server's mods/ folder and restart. Licence: MIT.
Need something custom? I build small server plugins to order from $35 (fixes) and $90 (a new one-feature plugin): https://ko-fi.com/molonlav3/commissions . If this mod saved you time, a coffee helps keep the updates coming: https://ko-fi.com/molonlav3
Updating Hytale? Run the free Update-Ready Check first to see which of your mods will break: https://molonlav3.itch.io/hytale-update-check
Server Backup Team
