Skip to content

Worldkeeper v0.1.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 05 Oct 18:06
· 56 commits to main since this release
v0.1.0
6f8e32f
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

The first release of Worldkeeper: automatic backups for Minecraft: Java Edition worlds.

Status: a personal project, shared as-is. I use it myself. There are no guarantees on support or response time.

Highlights

  • Backs up when you exit a world. Worldkeeper notices when the game releases a world's session.lock and saves the world right away. On startup it also catches up on worlds you played while it was not running.
  • Finds your worlds: official launcher (including custom profile game directories), Prism Launcher, CurseForge, and Modrinth App on Windows, macOS, and Linux, plus any folder you add.
  • Save slots. Name a save before something risky. Load any save, either replacing the world (a safety save of the current state is taken first) or as a new world next to it.
  • What's inside each save. Open a save to see its world info and advancement tree as of that moment, even if the world is gone from this computer.
  • World info read from the files: version, mode, difficulty, seed, day, weather, player, statistics, advancements, dimensions, data packs, and game rules. Supports the Minecraft 26.x world layout.
  • Advancement tree with your progress, drawn by mcwidgets. This is opt-in, because it loads from mcwidgets.kaban.sh.
  • Storage: plain zip files in any folder (a NAS share, or a Google Drive / OneDrive folder). Optionally a restic repository: encrypted and deduplicated. restic must be installed.
  • Tray / menu bar icon with status, Back up now, and an auto-backup toggle. A red dot shows when a backup fails.
  • UI in English and Russian.

Install

Download the archive for your system, unpack it, and run worldkeeper. The web UI opens at http://127.0.0.1:25599 on the first start.

System Archive
Windows (most PCs) windows_amd64.zip
Windows on ARM windows_arm64.zip
macOS, Apple Silicon (M1–M4) darwin_arm64.tar.gz
macOS, Intel darwin_amd64.tar.gz
Linux linux_amd64.tar.gz / linux_arm64.tar.gz

The binaries are not signed:

  • Windows: SmartScreen will warn on the first run. Click More info → Run anyway.
  • macOS: clear the quarantine flag first: xattr -d com.apple.quarantine ./worldkeeper.

To start Worldkeeper with your computer, see the README.

Known limitations

  • Java Edition only.
  • The menu bar and tray icon have been checked by building only. They have not been run by hand on Windows and Linux yet.
  • Minecraft 1.13–1.21 worlds are supported based on the known file format, but only 26.x has been checked against real saves.
Assets 9
Loading