🌾 EzFarming

EzFarming is a small plugin that speeds up crops harvesting and trees cutting inside of configured regions. A custom WorldGuard flag is used to determine if saplings and crops should be regenerated after their growth.

Showcase

Crops.mp4

Trees.mp4

The plugin is a project for a private server; it will not be uploaded to Bukkit/SpigotMC. If you want to suggest a new feature or improvement, open a PR. Join my Discord server for support.

Dependencies

WorldGuard on a Java 17 1.20+ Bukkit environment is required to run the plugin. Older versions may work too, but they have not been tested.

Setup

A bunch of messages can be configured in the plugin's config.yml file. Italian translations can be found in src/main/resources/messages-italian.yml. Remember to perform a /ezfarming reload every time you edit the messages.

Configuring regions

Create a claimed region using WorldGuard and set its ezfarming flag to true using /region flag <region> ezfarming true, then execute /region flag <region> block-break allow to allow breaking crops and wood.

This flag allows players to break every block inside the region, but the plugin cancels the event unless they break one of the following blocks:

• crops: beetroots, carrots, potatoes, wheat, nether warts
• logs: oak, birch, acacia, cherry, dark oak, jungle, spruce

Because of this, make sure that your region does not contain any of those blocks unless you want players to be able to break them.

Sprinklers

To create sprinklers to regenerate crops, type /ezfarming addsprinkler. You should have at least one sprinkler for every harvesting area inside the region.

Trees

Saplings' locations are automatically saved to config when they grow inside of a region. The sapling will be replanted after the first log is removed. To manually remove a sapling from the config, simply destroy it.

Permissions

The plugin currently has only one permission node: ezfarming.admin. It is used to check if players are allowed to execute the /ezfarming command and to check if they are allowed to break blocks when the block-break flag is set to allow.

Building

Gradle is used to speed up the process of building from source. To build the project, download the repository using Git or the green "<> Code" button, then open the main folder and run the following command:

gradlew build

You will find the compiled JAR at EzFarming/build/libs/EzFarming-X.x.x.jar.