Documentation

Chunk tools

Premium

This is part of ScriptedEssentials Premium. See what's in each edition.

Use /chunksave to save an area before a take and load it afterwards. /chunkrestore is different: it uses recorded block changes to roll an area back to an earlier time.

yaml
chunk-tools:
  enabled: true

Saving an area (/chunkwand, /chunksave)

commands
/chunkwand                  # the selection wand
/chunksave pos1
/chunksave pos2
/chunksave create <name>
/chunksave list
/chunksave load <name>
/chunksave info <name>
/chunksave delete <name>

With the wand, left-click a block for position 1, right-click for position 2. The two blocks define the corners of the saved area, including its height. It doesn't automatically expand the selection to whole chunks.

You can also use /chunksave pos1 and /chunksave pos2 at your current position. Saves go in backups/chunks/; list shows the saved areas and info gives details about one. Loading a save changes the original area, not the place where you're standing now.

Rolling back in time (/chunkrestore)

commands
/chunkrestore t:30m          # this chunk, 30 minutes ago
/chunkrestore r:5 t:1h       # 5 chunk radius, an hour ago
/chunkrestore r:10 t:2d      # 10 chunk radius, two days ago

You don't need a named chunk save, but the relevant changes must already be in the block log. Turning logging on after something was destroyed won't recreate the missing history.

r: is a radius in chunks, not blocks. Omit it for the current chunk, or use 1 to 250. A radius of 5 covers an 11 by 11 chunk square, so start small. t: is required and uses s, m, h or d.

Supported WorldEdit and FAWE commands can be logged when their integration is active, but logging has area and timing limits. Axiom support also depends on the installed plugin and events. See Integrations before relying on either for recovery.

Restoration also removes entities

When a restore has changes to apply, it removes non-player entities in the affected chunks before restoring blocks. That includes things like mobs, dropped items and armour stands. Make a backup and check the area before running it.

The database grows

The current rollback log is in database/chunk_restore.db. On a busy build server that gets big. chunk-tools.enabled: false if you don't need rollback.