Skip to content

World Engine Cleanup

Quick Start: Scale up for big servers.

Used cells are never reused, so match regions accumulate on disk. Cleanup prunes them automatically on server load, before any worlds are loaded.

It removes the region, entity, and POI files for every flagged cell in both the overworld and nether, supporting both legacy (region/, DIM-1, world_nether/) and modern (dimensions/minecraft/...) layouts.

Configuration

world-engine:
  cleanup:
    enabled: true
    schedule: "0 0 */3 * *"   # every 3 days at midnight
  • enabled: turns cleanup on. The first load only stamps the schedule; actual pruning begins after the first window passes.
  • schedule: standard five-field cron (minute hour day month weekday). Supports *, lists, ranges, and steps. Day-of-month plus day-of-week means either matches.

Changing the schedule re-stamps on the next load so the new cadence starts clean.

Behavior notes

The engine tracks every allocated cell in engine.db.

  • A mapping change (world, cell size, layout, or scatter seed) orphans drifted flags and logs a warning. Orphaned files are never pruned, so keep cell size stable while cleanup is enabled.
  • A region that only partially overlaps a cell is still fully pruned.
  • Stale buffered drops are orphaned immediately.

Console output

Cleanup reports:

  • Start line with the number of flagged cells
  • Progress every 10%
  • Final status: SUCCESS, PARTIAL SUCCESS (some files locked, skipped cells retry next cycle), or FAILURE (stopped after repeated locks)
  • Gigabytes freed

Invalid schedules or missing world folders produce a warning and are skipped.