AreaForge

AreaForge is a modern and powerful standalone area management and restoration plugin, developed to save areas within a selection at the stage of their creation, to then restore them at a later moment, either manually or automatically.

AreaForge is born to consolidate the features and functionalities of AreaReloader and AreaReloader-FAWE into a single solution.

The plugin is designed with cross-platform compatibility in mind, supporting both Spigot and Paper while providing version-specific implementations when possible.

AreaForge utilises asynchronous implementations and separate threads to better distribute its workload, preventing excessive overheading on the main thread.

Generally speaking, the plugin will perform better on servers running Paper; moreover, for Paper only servers and specific game versions it's possible to enable NMS implementations to perform a more direct block placement, drastically reducing the overhead and significantly improving performance during large-scale area operations.

NMS versions

• 1.21.8
• 1.21.9
• 1.21.10

Key features

Block management

AreaForge allows area management by creating a copy of a selected area, restorable at any moment both manually and automatically, all at the ease of a wooden axe and a command!

Containers and entities management

AreaForge doesn't stop at simple blocks restoration but allows to save and later load both entities and containers.

Player teleportation

After setting a safe location through /af settings location set, all players standing in the loading area will be teleported to the set safe location.

PlaceHolderAPI compatibility

AreaForge supports PlaceHolderAPI to display various information about areas:

SQLite & MySQL system

Information about areas is saved to database; by default SQLite will be enabled as the engine to use but it's also possible to select MySQL by setting it up in the config.yml

Interactive text

Most of the plugin's texts are interactable by left clicking, providing shortcuts to commands, settings and links! Interactable texts from commands: Help, Settings, Version, Info.

Example

The plugin finds its largest use in the restoration of pvp and pve arenas, as well as restoring limited event chests containing tresures.

Compatibility

AreaForge has been compiled in Java 21 and officially tested in versions 1.20.5 – 1.21.11, the plugin should be compatible with any other version as long as the server running it uses Java 21 or similar.

Configuration

Config file

The configuration file is really is to setup and primarly contains language settings.
Important fields:

Category	Field	Default	Values	Description
Metrics	Enabled	true	true/false	Enables metrics from bStats to gather data about the plugin's usage.
Storage	Engine	SQLITE	SQLITE/MYSQL	Sets the engine to use for the database connection.
Budget	Interval	1	Any number > 0	Sets the interval between area loading ticks.
Budget	Time	0.02	Any number > 0	Sets the maximum time dedicated to AreaForge for area creations and loadings.
Loading	Apply physics	false	true/false	Decides whether or not apply physics to blocks when loading areas. Keeping this diabled may improve performance in certain situations.
NMS	Enabled	true	true/false	Whether or not to use NMS implementations. NMS implementations can drastically improve the loading speed of areas by using interal structures. While it can benefit server's performance it may create entity and/or light glitches in certain scenarios.

Commands

• /af help [page, topic] A generic help command, provides a list of available commands and description when one is specified.
  
• /af create [save containers] [save entities]
  Allows for the creation of an area within the created selection.
  save containers whether or not inventories should be saved upon the creation of the area.
  save entities whether or not entities should be saved upon the creation of the area.
  
• /af reload Reloads the plugin's configurations and mechanisms.
  
• /af cancel Cancels the loading of one or all areas.
  
• /af settings <auto_load, auto_time, location> <true/false, time, set> Allows to manage an area's settings to manage auto loading and safe location.
  
• /af load Allows the loading of the specified area.
  
• /af list [page] Provides a list of all created areas.
  
• /af delete Deletes an existing area from the database and the folder.
  
• /af info Shows information about an existing area.
  
• /af version Shows the current plugin's version and provides useful links.
  

Permissions

• areaforge.command.admin
  Gives access to all permissions below
• areaforge.command.cancel
  Gives access to the /af cancel command
• areaforge.command.list
  Gives access to the /af list command
• areaforge.command.create
  Gives access to the /af create command
• areaforge.command.load
  Gives access to the /af load command
• areaforge.command.delete
  Gives access to the /af delete command
• areaforge.command.help
  Gives access to the /af help command
• areaforge.command.version
  Gives access to the /af version command
• areaforge.command.reload
  Gives access to the /af reload command
• areaforge.command.info
  Gives access to the /af info command
• areaforge.command.settings
  Gives access to the /af settings command

Issues

Open a new issue here.
When opening a new issue please add and specify:

• Provider's version (spigot, paper, bukkit) - /version;
• AreaForge's version - /af version;
• Nature of the issue: command, auto reloading, loading, creation, settings, etc.
• Error trace of the issue (logged to console).

Support

<br>
<i>I do my best to provide support for my projects over discord.
  <br>If you'd have questions or support requests feel free to join!</i>

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.