AreaReloader
Create and restore areas at any time at the glance of a command or set them to automatically regenerate!
Features
This plugin lets you turn any WorldEdit selection into a restorable region.
AreaReloader creates a schematic copy of the selection, split in smaller sections in order to distribute server's load, allowing smoother pasting/regeneration.
Each saved area can be restored manually with a command or automatically on a timed schedule.
The restore interval is fully customizable, making it ideal for regenerating resource areas, PvP arenas, dungeons, or any place that needs resetting.
Compatibility
This version of the plugin will only work with WorldEdit, if you use FastAsyncWorldEdit (FAWE) you must use the mirror plugin, AreaReloader-FAWE.
Commands
Commands
- /ar - Shows plugin's help lines
- /ar help
- Shows general help or specific help when a command is specified - /ar version - Shows the current plugin's version
- /ar create
- Creates a new copy of the selected area. The copy entities parameter will accept a true or false value, which will decide whether or not to copy entities inside the selected area at the moment of creation. If set to true, whenever the area gets loaded, saved entities will be respawned. - /ar load
- Loads an existing area - /ar delete
- Deletes an existing area - /ar list - Lists all existing areas
- /ar hook - Shows a help interface for the plugin's hooks and dependencies
- /ar info - Shows information about a specific existing area
- /ar reload - Reloads AreaReloader's configuration file
- /ar display
- Displays particles around areas - /ar cancel <AreaName, ALL> - Cancels the loading of one or all areas.
- /ar location
<set, teleport> - Allows you to create a safe location for players.
Permissions
Permissions
- areareloader.command.help - Gives access to the /ar help command
- areareloader.command.version - Gives access to the /ar version command
- areareloader.command.create - Gives access to the /ar create command
- areareloader.command.load - Gives access to the /ar load command
- areareloader.command.delete - Gives access to the /ar delete command
- areareloader.command.list - Gives access to the /ar list command
- areareloader.command.hook - Gives access to the /ar hook command
- areareloader.command.info - Gives access to the /ar info command
- areareloader.command.reload - Gives access to the /ar reload command
- areareloader.command.display - Gives access to /ar display command
- areareloader.command.cancel- Gives access to /ar cancel command
- areareloader.command.location - Gives access to /ar location command
- areareloader.command.admin - Gives access to all commands
Configuration
There are two main configuration files; config.yml allows you to customise language and general settings, whereas the areas.yml config contains all the areas' details and custom settings per area, such as auto loading and intervals.
config.yml
| Setting | Default value | Values | Description |
|---|---|---|---|
| Debug | true | true/false | If enabled prints all the plugin's processes to the debug file located at /AreaRealoder/debug.txt. |
| Updater | true | true/false | If enabled, automatically checks for plugin updates. |
| Metrics | true | true/false | If enabled retrieves anonymous server's statistics to help keep track of the plugin's usage. |
| Announcer | true | true/false | If enabled announces the plugin's branding message. |
AreaLoading settings
| Setting | Default value | Values | Description |
|---|---|---|---|
| Global interval | 500 | Any value above 0 | Sets an interval (in milliseconds) all areas use to wait between section loads if using the global option. |
| Fast mode | true | true/false | Whether or not to use FAWE's fast mode; depending on your server performance you may enable or disable this function. |
| Percentage | 15 | Any value above 0 | Sets the area loading progress percentage to broadcast to the player when loading an area. |
AutoReload settings
| Setting | Default value | Values | Description |
|---|---|---|---|
| Checker | true | true/false | Enable or disable the area scheduler function. |
| Notify admins | true | true/false | Whether or not to notify players with the admin permission whenever an area automatically loads. |
| Notify console | true | true/false | Whether or not to notify console whenever an area automatically loads. |
areas.yml
Loading interval settings| Setting | Default value | Values | Description |
|---|---|---|---|
| Global | true | true/false | Whether or not the area should use the global interval between section loads. |
| Time | 200 | Any value above 0 | The time interval (in milliseconds) the area must wait between section loads. Note: Global interval must be disabled for this area to use its custom interval. |
| Setting | Default value | Values | Description |
|---|---|---|---|
| Enabled | true | true/false | Enables/disables the area to automatically reload. |
| Time | 200000 | Any value above 0 | Sets the interval (in milliseconds) for the area to automatically reload. |
Issues
Open a new issue here.
When opening a new issue please add and specify:
- Debug's file (located at AreaReloader\debug.txt, can be enabled through the config).
- Provider's version (spigot, paper, bukkit) - /version;
- AreaReloader's version - /ar version;
- WorldEdit's version;
- Where/when you met the issue, as in what action had been fired at the time (command, auto reloading, etc.).
- Error log (either from console or debug file).
Dependencies
The plugin depends on WorldEdit, it will work with any WE's version your server supports.
Support
I do my best to provide support for my projects over discord.
If you'd have questions or support requests feel free to join!
Metrics
This plugin collects anonymous server statistics which helps me keep track of the plugin's usage.
I invite you to keep this setting on as it contributes to boosting my dedication and work towards my projects!
Provided by bStats.
