NatureRevive-Brilliant

NatureRevive - Brilliant

Compatible versions: 1.17 ~ 26.1.2

-> Click here to contact us for support <-

Player: "The resource world is such a hassle, you have to keep teleporting back and forth."
Player: "Can't we just use the same world for both resource gathering and building?"
A certain dev: "But then you couldn't reset the world — resources would just keep running out."
Player: "Couldn't the places we've explored periodically revert back to how they were?"

And so, this plugin was born.

A plugin that does away with a pointless separate resource world, letting you enjoy the convenience of unlimited resources in a single world!

— Features —

• Regenerates chunks that haven't been visited by players for a long time
• Optional regeneration engine to avoid chunk-boundary seams
• Optional land-claim regeneration protection mode
  • Do not regenerate chunks containing RES (Residence) claims
  • Regenerate chunks containing RES claims, but do not regenerate blocks within the RES claim area
  • Do not regenerate chunks containing GP (GriefPrevention) claims
  • Regenerate chunks containing GP claims, but do not regenerate blocks within the GP claim area
  • Do not regenerate chunks containing GD (GriefDefender) claims
  • Regenerate chunks containing GD claims, but do not regenerate blocks within the GD claim area
• Optional dependency plugins:
  • CoreProtect
  • Residence
  • GriefPrevention
  • GriefDefender
  • FastAsyncWorldEdit (required for use on 1.21+)
• Randomly regenerating mineral/ore resources
• Randomly regenerating loot chests and elytra resources
• Config file that accounts for server performance:
  • Pause regeneration based on TPS, until TPS returns to normal
  • Pause regeneration based on player count, until the count drops below a specified number
  • Adjust how many chunks are regenerated per tick
  • Adjust the maximum number of blocks placed per regeneration
  • Restrict the time window in which regeneration occurs
  • Adjust the chunk generation strategy and how aggressive it is:
    • aggressive — if a chunk is expired, it is automatically loaded and regenerated
    • average (balanced) — when a player loads a chunk, nearby chunks (3×3) are regenerated if expired
    • passive (gentle) — only the specific chunk loaded by the player is regenerated, if expired
  • Limit the maximum number of elytra regenerated per day
  • Adjust which biomes and worlds are eligible for regeneration
  • Add extra regeneration delay after regeneration, to stop players farming resources from a fixed spot
  • Adjust whether regenerated ores are randomly distributed, to stop players farming resources from a fixed spot
  • Limit the height at which ore obfuscation occurs and which blocks get obfuscated
  • Restrict loot chests so that regeneration doesn't spawn loot, to stop players farming resources from a fixed spot
  • Adjust how often (in ticks) non-expired chunk data is saved and synced to the local or remote database
  • Adjust how often (in ticks) database commands are executed
  • Adjust how often (in ticks) chunks are checked for expiry
  • Adjust how often (in ticks) event-affected chunk calculations are processed
  • Adjust how often (in ticks) to check and restore blocks that must be preserved — this avoids the visual glitch where the End-center gateway portal appears to vanish and reappear
  • Limit the maximum number of blocks processed per chunk-marking operation
• Multiple data storage methods:
  • yaml — local
  • sqlite — local
  • mysql — remote, requires a configured MySQL server
• Ways for developers to interface with the resource-regeneration process:
  • Regeneration triggers a Bukkit event for developers to hook into
  • IIntegrationManager handles the integration of land-claim protection, block logging, regeneration, and similar features
  • IAPIMain is the plugin's own interface, from which other classes can be obtained

— How to Use —

• Download this plugin
• Place plugin.jar into your server's plugins folder (plugins)
• Done! (If you use a plugin loader, remember to load the plugin)

⚠️ When using this plugin, always remember to back up your map to guard against unexpected problems!!!

— Configuration —

Once the plugin starts up correctly, in the plugins/NatureRevive directory you'll find the config.yml file, which contains all of this plugin's settings.

— Plugin Commands —

• /nr forceregenall — Force-regenerate all expired chunks
• /nr regenchunk <bukkit/fawe> — Force-regenerate the chunk you're currently in (on 1.21+, bukkit is automatically disabled)
• /nr reload — Reload the plugin
• /nr pause — Pause the resource-regeneration process
• /nr resume — Start the resource-regeneration process
• /nr migrate <yaml/sqlite/mysql> — Migrate the database to the specified data store
• /nr debug — Debug messages; please don't use unless necessary

— Plugin Permissions —

• naturerevive.forceregenall — Permission to use /nr forceregenall
• naturerevive.regenthischunk — Permission to use /nr regenchunk
• naturerevive.togglerevive — Permission to use /nr pause / resume
• naturerevive.reloadreviveconfig — Permission to use /nr reload
• naturerevive.navmigrate — Permission to use /nr migrate
• naturerevive.debug — Permission to use /nr debug

— Open Source —

Github

— Displayed in BlueMap —

Github

— How It Works —

• After a player has been active in a given area, it is marked as an "expired chunk"
• When no other player "performs any activity" there within a certain time period, regeneration is carried out.
• (By default, chunks containing land claims are excluded.)
  • "Performing activity" includes:
    1. BlockBreakEvent
    2. BlockBurnEvent
    3. BlockCookEvent
    4. LeavesDecayEvent
    5. EntityDeathEvent (specific condition: the killer is a player and the victim is not a player)
    6. BrewEvent
    7. FurnaceBurnEvent
    8. EntityExplodeEvent
    9. BlockExplodeEvent
    10. BlockPlaceEvent
    11. BlockRedstoneEvent
    12. BlockGrowEvent
    13. PlayerInteractEvent

— Credits —

— Disclaimer —

Please do not sell plugins developed by the Brilliant Team, nor sell their functionality. All of our plugins are provided free of charge for any server to use, so we earn no actual revenue from developing them.

Such behavior would, to some degree, reduce our willingness to keep developing, and may even lead us to consider turning free, open-source plugins into paid, closed-source ones. We appreciate your understanding.