For the complete documentation index, see llms.txt. This page is also available as Markdown.

World Backups

BuildSystem includes a database-linked backup subsystem. Backups copy region files and world configurations, sending them to local or remote storage drivers.


Backup Scheduling

Automatic Backups

If configured in config.yml (world.backup.auto-backup.enabled), backups run on a recurring schedule.

  • Interval: Set in seconds via interval (e.g., 900 for 15 minutes).

  • Active World Filtering: If only-active-worlds is set to true, background timer counts increment only when a registered builder is present in the world.

Manual Backups

Administrators or builders can force an immediate backup of their current world:

  • Command: /worlds backup create

  • Permission: buildsystem.backup.create


Viewing & Restoring Backups

To view the history of backups for the current world:

  • Command: /worlds backup

  • Permission: buildsystem.backup (requires being the world creator or having the buildsystem.admin bypass permission).

World Backups List

Restoration

  1. Open the backups list (/worlds backup).

  2. Click on the target backup item (named with the timestamp of creation).

  3. Confirm the restoration prompt.

Last updated