Skip to content
ReallocAllPublic

About

Crash-safe incremental world backup plugin for Endstone.

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

EndKeep

Build

EndKeep is an incremental world backup plugin for Endstone. It backs up Minecraft Bedrock worlds while the server is running, keeps recovery points without storing a complete world copy each time, and lets you restore an earlier version.

Installation

Requires Endstone 0.11 and Python 3.12–3.15.

Download the plugin .whl from Releases. Installation requires internet access.

Windows: stop Endstone, activate the Python environment used to run it, and install the downloaded wheel (replace VERSION with its actual version):

python -m pip install --upgrade "./endstone_endkeep-VERSION-py3-none-any.whl"

Remove any EndKeep wheel from plugins/, then restart Endstone. Use the same steps for updates.

Linux: use the command above, or place the wheel in plugins/ and restart Endstone to install dependencies automatically.

Python 3.15 currently requires compiler tools to build Zstandard. Before using the Linux plugins/ method with Python 3.15, install it in the server's Python environment: python -m pip install "zstandard>=0.23,<1".

See Using EndKeep for commands and configuration.

Quick start

Run these commands in the server console or as an operator:

/backup status
/backup create
/backup list

/backup create takes a snapshot. EndKeep processes pending snapshots during maintenance, which can also be started manually with /backup maintenance. Automatic backups are enabled by default.

Features

  • Online backups — capture snapshots without shutting down your server.
  • Incremental storage — save changes between recovery points to reduce disk usage.
  • Scheduled backups — set backup times, retention and maintenance in a configuration file.
  • Verification — check that stored recovery points can be read correctly.
  • Restore and export — recover a world even when the server cannot start.

Storage efficiency

In a real-world Bedrock server test spanning 156.2 hours, 38 recovery points used just 0.721 GiB with EndKeep, compared with 23.009 GiB for 38 independently compressed full backups (TAR + Zstd-6).

That's 96.87% less storage — 31.90× smaller than independent full backups. Savings depend on world activity and backup history.

Cumulative storage for 38 EndKeep recovery points compared with independently compressed full backups.

Benchmark results and methodology

Documentation

For server owners:

For contributors:

License

EndKeep's source code is MIT licensed. Its dependencies have separate terms. In particular, Amulet-LevelDB has restrictions affecting some commercial uses. Check the dependency license before using EndKeep on a commercial server.

About

Crash-safe incremental world backup plugin for Endstone.

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages