Skip to content

Configuration

Adam edited this page Oct 16, 2020 · 11 revisions

The default configuration contains less detailed comments about node usage, but is guaranteed to be up to date.

chunk-flag-radius

  • A square radius around each player's position that is periodically marked as visited.
  • default: 4

seconds-per-flag

  • Interval between periodic flagging of chunks around players in seconds.
  • default: 10

days-till-flag-expires

  • Duration to flag chunks as visited. Chunks that are reported to be last visited longer than this many days ago are eligible to be deleted.
  • Set to 0 to disable flagging entirely.
  • default: 7

delete-new-unvisited-chunks

  • If false, chunks are permanently flagged until they have been visited. Supports map pre-generation and reduces time wasted deleting untouched area.
  • If true, chunks are automatically flagged as visited using days-till-flag-expires when generated.
  • default: false

ticks-per-deletion

  • Recovery delay between chunk batch deletion attempts in ticks (1/20 of a second). Guaranteed to wait between region deletions, otherwise depends on which operations are required to determine a chunk's protection state.
  • default: 5

chunks-per-deletion

  • The number of chunks heavily checked between deletion recovery delays (ticks-per-deletion). If a chunk's state can be determined with inexpensive checks, it will not count towards the total.
  • Values above 1024 have no effect - a region is 1024 chunks, and the recovery delay is always used between regions.
  • default: 128

hours-between-cycles

  • The amount of time to wait between deletion attempts in the same world in hours.
  • default: 12

remember-next-cycle-time

  • Whether or not next cycle time should persist across server restarts. If false, deletion cycles will attempt to start immediately on server start.
  • default: false

worlds

  • List of worlds in which Regionerator is enabled.
  • default: []

hooks

  • Child nodes are all supported plugins.
  • If the hook is enabled and the plugin is not present, Regionerator assumes you do not intend to use the plugin. If the plugin is present and fails usability, Regionerator will pause deletion automatically so as to not accidentally wipe out a protected area.
    • If you are using an unsupported plugin that shares a name with a supported plugin, disable the hook to prevent Regionerator always starting paused.
  • default: true for all child nodes

debug-level

  • Enable increasingly verbose logging.
    • OFF: No debug information.
    • LOW: Minimal status messages, periodic deletion reports.
    • MEDIUM: Errors print full traces when logged.
    • HIGH: Heavy debugging mode. Do not enable this unless you're having a serious issue - the extra logging WILL cause your server to lag.
    • EXTREME: Ultra-heavy debugging mode. Prints a full trace of chunk loading if it coincides with Regionerator checking chunks. Good for tracking down poorly-behaved hooks.
Clone this wiki locally