███████╗███████╗████████╗██████╗░███████╗███████╗
██╔════╝╚════██║╚══██╔══╝██╔══██╗██╔════╝██╔════╝
█████╗░░░░███╔═╝░░░██║░░░██████╔╝█████╗░░█████╗░░
██╔══╝░░██╔══╝░░░░░██║░░░██╔══██╗██╔══╝░░██╔══╝░░
███████╗███████╗░░░██║░░░██║░░██║███████╗███████╗
╚══════╝╚══════╝░░░╚═╝░░░╚═╝░░╚═╝╚══════╝╚══════╝
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.4.0
- 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 configurate 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 configurated 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 temporary 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.
- Group specific settings: Want to give your donators some more power? You can by example configurate this plugin so the donator rank is allowed to farm bigger trees then a default ranked player can.
- 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
https://builds.enginehub.org/job/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
1.
Enable WorldGuard integration in EzTree config:
Open the EzTree configuration file (`config.yml`) and set the following parameters to enable the WorldGuard integration:
Code (YAML):
integration:
worldguard:
enabled
: true
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:
Code (Text):
/region flag <region_name> eztree-allowed allow
To block tree-related actions in a region:
Code (Text):
/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 by example allows 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.
Default config.yml
Code (YAML):
# (==================== EzTree ====================)
# Config version 2.3.0
# Enable automatic replanting of saplings
auto-replant:
enabled
: true
# Drop exp when a player breaks down a tree
exp:
enabled
: true
# If false: Experience = logs * amount
fixed
: true
amount
: 5
# The cooldown after usage of the tool
cooldown:
enabled
: false
# The cooldown amount in seconds
amount
: 120
toggle
:
# Enable or disable the toggle feature
enabled
: true
# Send the player an activation/deactivation message when toggled
message
: true
# Show the player an animation when toggled
animation
: true
# List of tools that can be used to activate the toggle
# The custom tool can be added by using "CUSTOM_TOOL"
tools
:
- DIAMOND_AXE
- IRON_AXE
- STONE_AXE
- GOLDEN_AXE
- WOODEN_AXE
- NETHERITE_AXE
- CUSTOM_TOOL
# Keep the tool activated after usage
# This prevents usage of cooldown
keep-activated
: false
# Custom tool only obtainable by command
# This tool has to be enabled under toggle by adding "CUSTOM_TOOL" to the tools
custom-tool:
enable
: true
tool:
material
: IRON_AXE
name
:
"&4TREE BREAKER"
lore
:
-
"This is a custom tool."
-
"It has special properties."
# Enables the check of permission for using and getting the tool
permission:
enabled
: true
# Configuration settings for the integrations
integrations:
worldguard:
enabled
: false
# Allow the plugin only in specific flagged sections
# You can add the flag "eztree-allow" to your section to make such section
allow-sections-only
: false
vault:
enabled
: false
# Give player reward after farming a tree
reward
: 10
# Give player fixed amount or amount relative to the amount of logs farmed
# If fixed is false the rewarded amount is LOG AMOUNT x REWARD
fixed
: false
# Customize messages send to the users
messages:
error:
noPermission
:
"&cYou don't have permission to use this command."
toggle:
activation
:
"&aTree breaking activated"
deactivation
:
"&cTree breaking deactivated"
command:
onlyPlayer
:
"This command can only be run by a player."
customToolDisabled
:
"Custom tools are disabled in the configuration."
invalidTool
:
"&cThe custom tool defined in the configuration is not valid."
receivedTool
:
"&aYou have received the custom tool!"
reloadSuccess
:
"&aEzTree configuration reloaded."
noReloadPermission
:
"You don't have permission to reload the configuration."
# Customize tree settings
# This is used to check if trees are valid trees
tree:
min-count:
enabled
: true
ACACIA_LOG
: 2
BIRCH_LOG
: 2
DARK_OAK_LOG
: 2
JUNGLE_LOG
: 2
OAK_LOG
: 2
SPRUCE_LOG
: 2
MANGROVE_LOG
: 2
CHERRY_LOG
: 2
BAMBOO_BLOCK
: 2
STRIPPED_ACACIA_LOG
: 1
STRIPPED_BIRCH_LOG
: 1
STRIPPED_DARK_OAK_LOG
: 1
STRIPPED_JUNGLE_LOG
: 1
STRIPPED_OAK_LOG
: 1
STRIPPED_SPRUCE_LOG
: 1
STRIPPED_MANGROVE_LOG
: 1
STRIPPED_CHERRY_LOG
: 1
STRIPPED_BAMBOO_BLOCK
: 1
max-count:
enabled
: true
ACACIA_LOG
: 10
BIRCH_LOG
: 10
DARK_OAK_LOG
: 30
JUNGLE_LOG
: 128
OAK_LOG
: 24
SPRUCE_LOG
: 20
MANGROVE_LOG
: 10
CHERRY_LOG
: 32
BAMBOO_BLOCK
: 12
STRIPPED_ACACIA_LOG
: 2
STRIPPED_BIRCH_LOG
: 2
STRIPPED_DARK_OAK_LOG
: 2
STRIPPED_JUNGLE_LOG
: 2
STRIPPED_OAK_LOG
: 2
STRIPPED_SPRUCE_LOG
: 2
STRIPPED_MANGROVE_LOG
: 2
STRIPPED_CHERRY_LOG
: 2
STRIPPED_BAMBOO_BLOCK
: 2
Support:
For support, suggestions, or bug reports, please visit our support thread on SpigotMC.org.