Regionerator 2.1.2

Gradual deletion of unvisited terrain

  1. Jikoo
    Native Minecraft Version:
    1.13
    Tested Minecraft Versions:
    • 1.16
    Source Code:
    https://github.com/Jikoo/Regionerator
    Disclaimer
    Regionerator deletes chunks from your world by directly modifying and deleting region files. This cannot be undone. Keep regular backups. The author is not responsible for any damages to your world or server incurred by using this plugin. Use at your own risk!

    Functions
    Regionerator deletes unused chunks and regions, allowing you to free up disk space and get rid of old builds or devastated land.
    Players in Spectator gamemode do not cause land to be marked visited, as they are not actually physically there.
    Commands require the regionerator.command permission.
    /regionerator - Report current status of all worlds.
    /regionerator reload - Reload the configuration and restart all deletion tasks.
    /regionerator pause - Pause deletion tasks. To prevent issues, the plugin will finish the region it is currently checking before pausing.
    /regionerator resume - Resume deletion tasks.
    /regionerator check - Check the status of a chunk.
    /regionerator cache - Check cache/queue counts.
    /regionerator flag - Permanently flag the relevant area as visited.
    /regionerator unflag - Unflag the relevant area.

    Flagging parameters
    • No parameters (e.g. /regionerator flag)
      • Player-only
      • Edit flag on current chunk
    • Chunk x and chunk z (e.g. /regionerator unflag 0 0)
      • Player-only
      • Edit flag on specified chunk
    • World name, chunk x, chunk z (e.g. /regionerator flag world 0 0)
      • Player/console supported
      • Edit flag on specified chunk in world
    • Selection (e.g. /regionerator unflag selection)
      • Player-only
      • Edit flags on all chunks within selection
      • Requires WorldEdit
    Developers
    If you're looking to support Regionerator deleting area in which you have data stored, wipe data when the ChunkPopulateEvent is fired. Regionerator does not guarantee that chunks are deleted on first attempt, so there is no sense firing an unreliable event when an attempt is made.

    Configuration
    Code (YAML):
    # Square around each player's current chunk to flag.
    chunk-flag-radius
    : 4

    # Every x seconds, chunks around each player online are flagged.
    seconds-per-flag
    : 10

    # Flags older than x days can be ignored and the region deleted.
    # To disable flagging, set this to 0.
    # days-till-flag-expires must be greater than 0 to be used with delete-new-unvisited-chunks
    days-till-flag-expires
    : 7

    # Chunks generated after the plugin is installed are automatically flagged.
    # If false, these chunks will be permanently flagged until visited.
    # Setting this value to false will allow you to pre-generate your maps for reduced load from exploration.
    # It will also reduce the amount of time wasted deleting untouched areas.
    delete-new-unvisited-chunks
    : false

    # Time in between deleting regions in ticks (20 ticks = 1 second)
    ticks-per-deletion
    : 5

    # Chunks checked for deletion per interval. Default (128) handles an entire region every 9 intervals.
    # If this value is 1024 or lower (1 or fewer regions per cycle) an entire run cycle is dedicated to deletion to prevent lag.
    chunks-per-deletion
    : 128

    # Hours between deletion cycles
    hours-between-cycles
    : 12

    # Whether or not to remember time for next cycle on plugin load
    remember-next-cycle-time
    : false

    # Worlds the plugin is able to delete regions in
    worlds
    : []

    # Hooks to attempt to check for protections from.
    # If your protection plugin of choice isn't here, ask!
    hooks
    :
      Civs
    : true
      Factions
    : true
      Feudal
    : true
      GriefDefender
    : true
      GriefPrevention
    : true
      Kingdoms
    : true
      Landlord
    : true
      Lands
    : true
      PreciousStones
    : true
      RedProtect
    : true
      Residence
    : true
      Towny
    : true
      WorldGuard
    : true
      UltimateClaims
    : true
      VanillaSpawnProtection
    : true

    # Debug-level enables more and more verbose logging of actions as increased.
    # OFF - no debug messages
    # LOW - Minimal debug messages, periodic deletion reports
    # MEDIUM - More debug messages. Spammy, not recommended.
    # HIGH - Lots of debug messages. Don't enable this unless you have a serious issue.
    debug-level
    : LOW
    FAQ
    My server is lagging! What can I do?
    Try reducing chunks-per-deletion. Deletion must be done on the main thread to prevent potential world corruption, so there isn't much else that can be done. After the initial run, during which there's a lot of area to delete, it runs a lot more smoothly.

    Why is it taking so long to start deleting area?
    Regionerator doesn't magically know what has and hasn't been visited. It needs to gather data for as long as it takes chunks to become unvisited before it can tell what's safe to delete. Regionerator does fall through to Minecraft's internal last modification timestamp, but this requires the chunk to have actually been modified (entity movement, block changes, etc.), not just visited.

    Why does regeneration take so long?
    If cycles are taking too long for your taste, try increasing chunks-per-deletion or decreasing ticks-per-deletion.

    Do you support custom world generators?
    Regionerator doesn't actually regenerate area, it deletes it. Whatever world generator you're using will then provide the chunk when it generates again.

    Will you add support for this protection plugin?
    Sure, point me to it. Provided it has a way I can efficiently check for claims in a chunk, I'll do it. I can't guarantee it'll happen soon, but Regionerator is open source, you're free to submit a pull request. I also can't effectively test plugins that I do not use myself, so I cannot guarantee that it will function properly.

    Which protection systems are supported?
    I only test hooks which I have an environment set up for. I'd advise you not to put a plugin of this nature on a live server without testing period anyway, but be even more cautious if you are using an untested hook.
    If you're using one of the hooks, please tell me if you've tested it and can confirm it works - it'll save future users the initial worry (though I recommend still testing anyway).

    How can I test a protection system effectively?
    There are two easy ways to go about it:
    1. Use `/regionerator check` ingame to test the chunk you're standing in. All active hooks will display the chunk's status.
    2. Force deletion to run early. When complete, log in and examine protections.
    How can I force deletion to run early?
    There are two methods:
    1. Set visit duration to 0 days prior to enabling worlds
    2. Manually set the world's next-cycle to a low number above 0 prior to starting the server.

    Source
    Available on GitHub.
    [​IMG]
    This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

    amsedal, Resoluciones, Lazo and 5 others like this.

Recent Updates

  1. Update RedProtect hook, minor bugfixes
  2. Updated Lands Hook
  3. Regionerator 2.1.0

Recent Reviews

  1. Gustavo_Player
    Gustavo_Player
    5/5,
    Version: 2.0.2
    Good plugin. =)
  2. _MR_Blocker
    _MR_Blocker
    5/5,
    Version: 2.0.2
    Very responsive developer that works fast on any issues, even if they aren't his fault. Been using this for years, life saver for server owners like me that despise resets but need fresh chunks A++++
  3. XiangZi
    XiangZi
    5/5,
    Version: 2.0.0-BETA-5
    Very good plugin, I want to reprint this plugin to China's largest MineCraft forum MCBBS www.mcbbs.net, I hope you agree, I promise not to leak the.jar file, they will download this plugin to SpigotMc, I will provide the Chinese tutorial to them, I will send you the reprint link when finished.
    1. Jikoo
      Author's Response
  4. LoneDev
    LoneDev
    5/5,
    Version: 2.0.0-BETA-3
    "Works really well :)"
    again same review as 2016, still working great !
  5. LuckyPlayz01_
    LuckyPlayz01_
    5/5,
    Version: 2.0.0-BETA-3
    It is a great plugin, I have been using it for a while, it works great for its intended purpose. Thank you.
  6. Mel_instagibson
    Mel_instagibson
    5/5,
    Version: 2.0.0-BETA-1
    Thanks for this plugin, its exactly what i need to refresh my servers wilderness without loosing builds. Ur the best man, i love you :*
  7. Resoluciones
    Resoluciones
    5/5,
    Version: 2.0.0-BETA-1
    Unique plugin and absolute necessary for any survival server. Thank you Developer!
  8. Sun_Light
    Sun_Light
    5/5,
    Version: 2.0.0-BETA-1
    perfect plugin´╝üWhat all I need is what this plugin can provide to me.
    Keeping up this nice job thx
  9. LLIcocoman
    LLIcocoman
    5/5,
    Version: 2.0.0-BETA-1
    Work very well with custom generator EpicWorldGenerator!
    Thank's for this useful plugin!
  10. LoneDev
    LoneDev
    5/5,
    Version: 1.5.5
    "Works really well :)"
    same review as 2016, still working great !