Cristichi's Tree Capitator
Tested on 1.21!
The latest build has been tested and works for 1.21.*, 1.20.*, 1.19.*, 1.18.*, 1.17.*, 1.16.*, 1.15.*, 1.14.* and 1.13.*. I recommend using the latest build always in servers running on those Minecraft versions. I'm also still around so please feel free to leave here any issues you may encounter or your suggestions if you want to, I'll read them.
Features
Please note that only the latest build supports ALL of the following features.
- Let users destroy entire trees by breaking only 1 log. Even the biggest tree will fall!
- Works on nether trees (If server is +1.16).
- Auto-update. You will get a notification if a new update is out and you don't need to come back here to download the plugin again when new features come out.
- It also destroys all leaves around.
- Auto-replant. Replanted saplings can also be automatically protected so they cannot be broken until they grow a tree.
- Switch on/off if an axe is required and/or damaged.
- VIP mode. Use it to restrict access to the benefits of this plugin, for premium users for example.
- Each player can toggle on/off the plugin for themselves. You can also configure if you want a message to remind players of their current setting when they log in.
- Players are not able to break logs in protected areas (by WorldGuard or other protection plugins using WorldGuard as a dependency).
- Axes are damaged accordingly.
- Switch on/off if axes should be prevented from being broken. So that you can repair that nice axe with Mending or an anvil and never worry about it being broken. (only works when breaking logs with it, breaking anything else will destroy the axe anyway)
- Switch on/off if tree leaves should be ignored by the plugin. Enabling it will make the plugin take down only connected logs, reducing the lag and balancing a little bit.
- Crouch mode. Use true in this configuration so that crouching players not trigger this plugin. Use inverted to make standing players not trigger this plugin, or false to make crouching not change how this plugin works.
- Customize what are trees! Configure any block to be treated as tree logs or as tree leaves for this plugin. Scroll down to see more specific steps on this page.
- Ask for new features by DM or by commenting here! I'll try to consider and answer every suggestion.
Commands/Configuration
- /tc help: Lists all commands.
- /tc toggle: Toggles the plugin for you. Just in case you made your home using lots of logs.
- /tc update: Checks for new updates, and updates if able.
- /tc reload: Reload config.yml changes.
- /tc setLimit <number>: Sets the limit of blocks this plugin can destroy at once. (-1 for unbounded)
- /tc setReplant <true/false>: Sets if trees should be replanted. True by default.
- /tc setInvincibleReplant <true/false>: Sets if replanted saplings should be unbreakable by survival players. False by default.
- /tc setAxeNeeded <true/false>: Sets if an axe is required for the plugin to work. True by default.
- /tc setDamageAxe <true/false>: Sets if the axe used is damage (only takes place if an axe is needed). True by default.
- /tc setBreakAxe <true/false>: Sets if the axe used can be broken (only takes place if an axe is needed and damaged). False by default.
- /tc setVipMode <true/false>: Sets if vip mode is on. False by default.
- /tc setNetherTrees <true/false>: Sets if the plugin works on the new nether "trees". False by default.
- /tc setStartActivated <true/false>: Sets if this plugin is activated for players when they enter the server. If false, players will need to use /tc toggle to activate it for themselves. True by default.
- /tc setJoinMsg <true/false>: Enables or disables the join message that remind players about /tc toggle. True by default.
- /tc setIgnoreLeaves <true/false>: Makes the plugin ignore or not the leaves aroung logs. False by default.
- /tc setCrouchPrevention <true/false/inverted>: Defines if crouching allows players to break logs individually. If set to inverted, players must crouch to break multiple logs with this plugin. False by default.
You may also use /treecap or /treecapitator as valid aliases for the /tc command.
Permission nodes
- cristreecapitator.user: Always required to take down trees fast.
- cristreecapitator.admin: Required to change options by commands.
- cristreecapitator.vip: Required to take down trees fast when Vip Mode is enabled.
How to Install
- Place your downloaded .jar file into YourServerDirectory/plugins/.
- Start or reload server.
- Then you may configure the plugin just the way you want, either using commands OR editing the config file and then typing /tc reload in the in-game chat (with cristreecapitator.admin permission/OP) or in the server console.
How to use VIP mode
VIP Mode enables an easy switch for the plugin. If VIP Mode is enabled regular users won't be able to use this plugin by default because they will also need an additional permission.
- Enable vip mode (/tc setVipMode true).
- Give 'cristreecapitator.vip' permission node to VIP players.
- It's already done! VIP players will be the only ones allowed to cut down trees faster! Don't worry, average players can still get wood, but the vanilla way.
How to add blocks as logs or leaves
You can configure other blocks to be detected as if they were logs or leaves, like the stripped logs or blocks from mods, or any block you want.
- Make sure you are using v6.4.0 or higher of this plugin.
- Check the name of the blocks in this link https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html.
- Go to the folder YourServerDirectory/plugins/CrisTreeCapitator where the configuration file is and open extra_logs.json or extra_leaves.json, and edit the files to include the blocks you want (as named in the previously mentioned link). Be careful to follow the format.
- Reload the server OR type /tc reload to apply the changes.
Keep it always up to date!
During startup you will receive a notification in the chat and the server console if the plugin needs to be updated. With a simple command you will be able to check new updates and update the plugin in-game.
I always recommend to keep the plugin up to date to make sure that you are benefiting from new features, general improvements and any bug fixes.
Compatibility with older versions.
If your server is running a Minecraft version older than 1.13, please click here to download v3.0.1 instead. It won't have all the advantages and performance of the latest version so please consider updating your server to at least Minecraft 1.13.
Need help?
Please feel free to contact me through DM or by commenting in this page. I do not have much free time to answer, but I will be sure to answer you as soon as possible. I will be happy to help on any issues that you are having, and consider every feature request that would make the plugin better for your server.
Future plans
My intention for the future of the plugin is to keep providing updates for new Minecraft versions, especially if there are any significant changes to the game like new trees or new features that would help this plugin's implementation. Additionally, I will provide support for any issues or bugs encountered by players, and I will consider any new features suggested as well. Please, feel free to let me know your feedback, good or bad.
Thank you for reading, and happy minecrafting!
In reply to yellopikachu:
Hi! It does, you have to enable it in the configuration.
Im trying to use this in my server and it's listening to every command except the axe needed command, whether its set to true or false my friend and I can still break whole trees with our bare hands or any other item.
In reply to CorruptedFate13:
Thank you for the heads up! I seem to have overlooked that in my last update. I'm fixing it today asap.
In reply to Cristichi:
awesome! I can't wait to see it fixed! Thank you for the super quick reply btw!
In reply to CorruptedFate13:
Hello. Sorry for responding late to this one. The update was published by the time you responded. Please update if you haven't yet, and thank you for your kind response.
Edit: Actually I think it was almost at the same time xD
In reply to Cristichi:
Yeah, I checked right away and it was there, it worked perfectly as soon as I updated! I have absolutely zero complaints with the plugin now, I love it for my server! Thanks so much for being so on top of updates and replies! Keep being awesome dude!
hi, great plugin,
so i have a question, to prevent a bunch of trees from just disappearing when i cut down onw.
the only option is to set `ignore leaves: true` right?
asking cos, it seems like the number of logs that are cut is greater than what the axe is supposed to allow, according to its type,
In reply to user4302:
Hello! Thank you very much.
I reckon the best way right now to prevent tons of trees to just go pop is to either set a limit or, yes, set it to ignore leaves.
At the moment I'm investigating a possible bug/mistake on my part where some limits like the durability of the axe (sometimes it seems like the axe is broken but it keeps on going instead of stopping) or the configured block limit is bypassed by the plugin, so if it is happening to you as well I'm sorry for the inconvenience and I promise a fix is coming asap.
In reply to Cristichi:
OH a limit! That sounds like a good solution.
So if I set it as 1, it should be good right?
oh the limit id of the no of blocks. not trees, hmmm
In reply to user4302:
That limit represents the number of blocks the plugin will destroy at once. After reaching the limit, it will stop. You can set it in-game using /tc setlimit (number). It is not an ideal solution, since using a low value like 10 or 20 can result in jungle trees floating, and the plugin priorices some directions to look for blocks more than others, so dense forest can get wanky. It will stop anyway once the server can't handle more blocks destroyed, so a high value will change nothing.
I think the most ideal solution is ignore leaves and maybe set a limit like 40 or 50 just in case too many trees are touching. I hope it helps.
Just a question: is there a way to change the namespace of the plugin because I’m using towny on my server and they both use “tc”
In reply to mrmirchi:
Hi! Sorry to hear that. If it's my plugin the one you can't use, try using /treecap instead. If it's towny the one you can't use, I don't know if I could do something about it. Could you please tell me which towny are you using? I quickly checked https://www.spigotmc.org/resources/towny-advanced.72694/ but I didn't see any /tc command. I don't have a lot of time to check it further. Thank you in advance and have a nice day.
In reply to Cristichi:
I'm using towny chat with towny, sorry, I should have said that earlier. And thanks for the treecap thing I didn't know that was there lol
In reply to mrmirchi:
Don't worry! I believe it says so nowhere, I should add the different aliases in the main page of this plugin (oops). Thank you for the warning!
I'm still looking for a plugin that can increase the time it takes to chop the base, depending on the size of the tree, so it isn't quite as easy to log a forest.
Is it possible to require a specific type of axe? I see that the /tc setAxeNeeded is a boolean operation, but I'd love to do something like /tc setRequiredAxe wooden so that players can only destroy entire trees with that specific axe. This circumvents the need to use a protection plugin when players are chopping down logs that are part of structures they have built (since they could swap to another axe).
In reply to heymatt:
I submitted a pull request for this feature albeit with a slightly different command syntax: https://github.com/Cristichi/CrisTreeCapitator/pull/9.
In reply to heymatt:
Hi there. Thanks for the suggestion, it is something I considered at first, but after some thinking I though that the basic block limit does that function as well and limiting the kind of axes would be more confusing to players that enter the server than useful so I never added it.
In reply to Cristichi:
The block limit doesn't allow a non-admin player to prevent a tree from falling down ad hoc. There's not an effective way to use the block limit to create the same functionality since block limits are arbitrary. Imo, it seems more confusing to have to explain to players that there's an arbitrary block limit to how many blocks their axe can destroy (since there's no real reason other than "it's arbitrary") compared to just telling players "Use a wooden axe if you want trees to fall instantly. Otherwise, use any other axe if you don't, like when working on your own buildings."
In reply to heymatt:
I guess players can just use /tc toggle if they want to achieve this same functionality.