EzTree - Simplify tree farming in Minecraft

EzTree is a lightweight yet highly configurable Minecraft plugin designed to make the process of farming trees faster and easier. Ideal for both server administrators and players, EzTree enhances the tree farming experience while maintaining a minimal footprint on your server's resources.

Features of EzTree 2.3.1

Toggle tree breaking

Easily activate or deactivate the tree breaking feature by right-clicking with a customizable tool. No more tedious tree chopping!
- Configurable optional message after toggling the tree tool.
- Optional animation on toggling the tool.

Permission-based access:

Control who can use the tree breaking feature with the eztree.use permission, perfect for rewarding specific ranks or groups.

Intelligent tree detection:

The plugin smartly detects if the broken wood is part of a tree by checking its attachment to leaves, preventing accidental destruction of wooden structures.
- Able to detect 2x2 trees
- Able to detect unusual trees
- Able to configure minimum and maximum tree sizes per type

Flexible permissions:

Option to disable the required permission, allowing all players to use the tree breaking feature freely.

Automatic activation:

Option to disable the toggle functionality, enabling automatic tree breaking without the need for a specific tool.
Option to leave the tool on after usage

Experience drops:

Earn experience points from breaking trees, enhancing the reward for your wood farming efforts.
Drops can be configured in fixed or nonfixed amounts.

Auto replant:

Automatically replant saplings where trees have been broken, ensuring sustainable tree farming and maintaining the beauty of your world.
Replants 2x2 saplings back after farming a 2x2 tree
The replanting only works after farming the first level of the tree. If you farmed from higher up it will not replant since it's not detecting the ground.

Customizable messages:

Personalize in-game messages with customizable texts and chat colors to match your server's theme and style.

Cooldowns:

Configurable optional option to delay the next usage of the breaking feature. The cooldown is temporarily stored within the plugin itself and resets for all players with a restart.

WorldGuard regions:

The plugin has 2 WorldGuard region flags, these can be used to make the plugin only usable in a specific region or can be used to block the usage in a specific region.

Economy support:

Vault integration makes it possible to send the player fixed and nonfixed amounts of money after farming a tree.

Auto update message:

Through the API of SpigotMC the plugin checks for updates, if there is a newer version available the plugin will send a message in the console on server start up.

Versioning

EzTree Version 1.x.x ~ Minecraft version 1.20.6
EzTree version 2.x.x ~ Minecraft version 1.21

WorldGuard

EzTree integrates with WorldGuard to control where tree-related actions can occur in your Minecraft world. This integration utilizes WorldGuard regions and custom flags to allow or deny these actions.

WorldGuard Flags

EzTree introduces two custom WorldGuard flags:

eztree-allowed: Allows tree-related actions within the specified region.
eztree-use: Blocks tree-related actions within the specified region.

Setting Up the Integration

Step-by-Step Guide

Enable WorldGuard integration in EzTree config:

Open the EzTree configuration file (config.yml) and set the following parameters to enable the WorldGuard integration:


integration: -> worldguard: -> allow-sections-only: false

Setting allow-sections-only to true will restrict the usage of the plugin to regions with the eztree-allowed flag set to allow.

2. Register the custom flags: EzTree automatically registers the custom flags with WorldGuard when the plugin is enabled. You should see a confirmation in the console stating that the flags have been registered.

3. Using the flags in regions: Use the following commands to set the custom flags in your WorldGuard regions:

To allow tree-related actions in a region:

 
/region flag <region_name> eztree-allowed allow

To block tree-related actions in a region:


/region flag <region_name> eztree-use deny


4. Checking Player Location for Flags: EzTree checks if a player is within a region with the eztree-allowed or eztree-use flags before performing tree-related actions.

If allow-sections-only is set to false: If the eztree-allowed flag is set to allow, tree-related actions are permitted. If the eztree-use flag is set to deny, tree-related actions are blocked.

If allow-sections-only is set to true: Tree-related actions are only permitted in regions where the eztree-allowed flag is set to allow. In all other regions, tree-related actions will be blocked.

Roadmap

Planned features and enhancements:

Player statistics:

Track player statistics and enforce tree size limits based on player rank. This feature will help balance gameplay and reward progression.

Biome-specific settings:

Allow different settings and behaviors based on the biome. For example, chopping trees might be harder in certain biomes, or players could receive extra rewards in others, creating a more dynamic and immersive environment.

Visual tree falling animation:

Add a visual animation of the tree falling over when it’s chopped. This enhancement will improve immersion and provide satisfying visual feedback for players.

Add custom trees:

Make an option to, for example, allow generation of 3x3 trees.

We are committed to continually improving EzTree, making it more versatile and enjoyable for all players. If you have any suggestions or feedback, please let us know! Your input is invaluable in shaping the future of this plugin.