[1.17] TreeGravity - Tree Feller

[1.17] TreeGravity - Tree Feller -----

Chop entire trees down with just one swing!

Plugin Info

Similar to TreeFeller, Timber, Choptree and TreeAssist, TreeGravity allows you to chop an entire tree and mine entire ore veins in one block break. Below are the main methods available for chopping trees with TreeGravity:

Lumberjack Classic - Chop one log and the entire tree falls down! The number of logs on the tree are dropped in an itemstack.
Lumberjack Natural - Break one log and the entire tree falls down, but each log breaks naturally.
Lumberjack Random - Same as Classic, but the number of logs dropped will be 20% more or less than how many were actually on the tree (so if a tree had 10 logs, 8 to 12 will be dropped).
Gravity - Break a log and any logs directly above it fall like sand/gravel. Warning: This method can't distinguish between logs on a tree or player placed logs. See Update 3.0.0 for a temporary solution.
Experimental Methods - Three experimental methods exist as well, see update 3.9.1 for more info. Use at your own risk as these play around with metadata, and other methods that can induce a lot of lag.

VERSION INFO:

For Spigot/Paper 1.17 servers use version 4.6.1
For Spigot/Paper 1.16 servers use version 4.6.0
For Spigot/Paper 1.15+ servers use versions 4.3.0 to 4.5.0 (link)
For Spigot/Paper 1.13 & 1.14 use versions 4.2.2 and before (link)
For Spigot/Paper 1.12 see link ->(link)

Additional Details:

If you encounter ANY bugs or have ANY suggestions, please let me know here in the discussion section! Thank you!
**Before you ask me about EWG, see my "Notes on EpicWorldGenerator" below.

Current Features

Works on all tree types including mushroom trees!
No logs or leaves left floating in the air whatsoever!
Player structure/house protections, so that buildings with logs & leaves are safe!
Auto sapling-replant, so your forest stays a forest!
Works with anti-grief and region-protection plugins, so trespassers can't chop your trees.
Logs (or mushroom blocks) are the only blocks ever broken, besides items hanging on logs like vines, cocoa beans, etc.
Config settings can be changed in-game, see the config settings below.

Config Settings

(see spoiler "Configuration Details and Settings" for details)

tgType - Sets which method is active
toolsAllowed - List of tools that will fell trees
chopMethod - Whether players need to sneak to fell trees
updateChecker - Checks whether the plugin is up to date
debugger - Whether debugging messages are sent to the server console when trees are chopped down
defaultUserPerm - Whether all players on the server have default TreeGravity permissions (felling trees & /tg command)
sound - Choose the sound that plays when a tree is chopped down
soundFrequency - Set how frequently sounds are made when chopping trees
allowedWorlds - Sets which worlds the plugin logic will work in.

houseProtection - Increases player structure protection, so your houses and buildings are safe!
fairDurability - Makes axe durability decline by the number of logs on the tree
durabilityMultiplier - Increase or decrease the degree of damage logs have on your axe when fairDurability is on
autoReplant - Automatically replants saplings when the tree is cut down
saplingDrop - Drops a stack of saplings with the logs that are dropped at your feet the base of a tree

mcmmoHook- Toggles whether TreeGravity hooks into McMMO
mcmmoXpMultiplier - Change the percent of McMMO xp is given for trees cut using TreeGravity (not implemented yet)

General:

tgType [1, 4, 2.1, 4.1, 4.2] - Sets which TreeGravity method is active. Setting tgType to 1 will implement the Lumberjack method, setting it to 4 will implement the Gravity method. You can also try out experimental methods [2.1, 4.1, 4.2], see Update 3.9.1 for more info on the experimental methods.
toolsAllowed [all tools should work, but I'd suggest only using axes] - Set a list of tools that TreeGravity works with. Only add tools to avoid any errors.
chopMethod [default, stand, sneak, sneak.notify] - Sets whether players need to sneak in order to fell trees, or if they can fell trees in any position. See Update 3.8.0 for more info.
updateChecker [true or false] - Whether you want the plugin to check for updates. If true, the following link is accessed: https://textuploader.com/d7v57/raw
debugger [true or false] - When set to true, when you chop down a tree the following will be printed in your server's console: the tree's log type, location, and the number of logs the tree has. Only shows these values with Lumberjack methods enabled.
defaultUserPerm [true or false] - Whether all players on the server have default TreeGravity permissions (felling trees & /tg command). Set this to true if your server doesn't have a permissions plugin.
sound [none, scream, falling, treefiddy, creepy, LOTR] - Choose the sound that plays when a tree is chopped down. See Update 3.10.0 for more info.
soundFrequency [decimals from 0 to 1] - Set how frequently sounds are made when chopping trees. (not implemented yet)
allowedWorlds - Sets which worlds the plugin logic will work in. See update 4.1.0 for more info.

Lumberjack:

autoReplant [true or false] - Toggles whether saplings are replanted or not once you chop down a tree. Once you fell a tree there is about a 3 second delay before sapling(s) are replanted. See Update 3.5.0 for more info.
houseProtection [0,1, 2, 3, 4, 5] - Determines how strict the plugin is when deciding whether a structure is manmade or a tree. There are six levels, integers 0 to 5. Using 0 turns the settings off, 1 is low and 5 is high. Set to 3 by default. 1 should work fine, but if you're worried about player-built structures made from logs and leaves getting chopped down by accident, keep the setting on 3 or above. See Update 3.7.0 for details about the logic behind this setting.
fairDurability [true or false] - Toggles whether your axe durability declines by the amount of logs that are harvested from the tree chopped down. See Update 1.13.v3 for more info.
durabilityMultiplier [decimals from 0.1 to 5] - The degree of durability damage each log has on your axe/tool. The default value (1) is same as vanilla MC. Changing the value up or down indirectly affects the tool's life when felling trees. For example, setting to .5 will make your axe degrade twice as slow, but setting to 2 will make your axe degrade twice as fast (when using TreeGravity methods to chop trees). If you change this setting directly in the config.yml file, then you can set any number you want. BUT I wouldn't suggest setting this higher than 5. The following are my recommended settings for this setting: [0.5, 1, 2, 3]
saplingDrop [true or false] - Drops a stack of saplings immediately with the tree's logs at the base of a tree. Only applies to Lumberjack Classic and Random. Saplings dropped should include 1 sapling for every ~20 logs the tree has.
fallMethod [pop, break, natural] - This This config variable replaced tgType 2 in major update #4, see update 4.1.0 for more info.
dropMethod [itemdrop, inventory] - This determines whether the logs itemstack is dropped on the ground (set to 'itemdrop'), or the itemstack is put directly into the player's inventory (set to 'inventory'. See update 4.1.0 for more info.
randomLogDrop [true or false] - This This config variable replaced tgType 3 in major update #4, see update 4.1.0 for more info.

Other:

mcmmoHook [true or false] - Toggles whether TreeGravity hooks into McMMO. See Update 3.11.0 for more info.
mcmmoXpMultiplier [decimals from 0 to 1] - Change the percent of McMMO xp is given for trees cut using TreeGravity. (not implemented yet)
oreSweeper [true or false] - My take on a quick-mining plugin. When you mine an ore block with a pickaxe, all ores of the same kind around it will break naturally. See update 4.1.0 for more info.

Code (YAML):

Treegravity : #by Dudenn
General:
tgType : 1
toolsAllowed :
- STONE_AXE
- IRON_AXE
- GOLDEN_AXE
- DIAMOND_AXE
chopMethod : default
updateChecker : true
debugger : false
defaultUserPerm : true
sound : none
soundFrequency : 1.0
allowedWorlds :
- all
Lumberjack:
houseProtection : 5
fairDurability : true
durabilityMultiplier : 1.0
autoReplant : true
saplingDrop : false
fallMethod : pop
dropMethod : itemdrop
randomLogDrop : false
LeafDecay:
enabled : false
speed : 4
radius : 2
Other:
pileSpread : 1
mcmmoHook : true
mcmmoXpMultiplier : 1.0
OreSweeper:
enabled : false
pickaxesAllowed :
- WOODEN_PICKAXE
- STONE_PICKAXE
- IRON_PICKAXE
- GOLDEN_PICKAXE

Commands

/tg - Provides this list of TreeGravity commands

/tg help - Explains what the commands and settings are
/tg info - Provides general info about the plugin

/tg settings - Shows the server's current settings in the TreeGravity config.yml
/tg toggle - Player by player toggling of TreeGravity on or off

/tg reload - Reloads the plugin
/tgconfig - Shows list of sub-commands for /tgconfig
/tgconfig [enable, disable] - Turns plugin on or off
/tgconfig set type [lumberjack, gravity] - Changes the current plugin's method
/tgconfig set durabilitymultiplier [0.5, 1.0, 2.0] - Sets the durability factor (any decimal works, not just the ones listed)
/tgconfig set houseprotection [0, 1, 2, 3, 4, 5] - Sets the level of house protection (any manmade structures)
/tgconfig set chopmethod [default, stand, sneak, sneak.notify] - Sets whether players need to sneak to fell trees
/tgconfig set fallmethod [pop, break, natural] - Sets what fall animation happens when a tree is felled
/tgconfig set dropmethod [itemdrop, inventory] - Where the tree's logs go: dropped on ground or player's inventory
/tgconfig tools add/remove [tool] - Adds or Removes a tool on the allowed tools list in the config
/tgconfig worlds add/remove [world] - Adds or Removes a world on the allowed worlds list in the config
/tgconfig toggle [fairdurability, updatechecker, autoreplant, sapling drop, defaultpermissions, randomlogdrop, mcmmohook, oresweeper] - Turns the setting ON or OFF

/tgconfig toggle [debugger]- Turns the debugger in the server console ON or OFF
/tgd - Gives the player a diamond axe
/tgd g - Gives the player a golden axe
/tgd a - Gives the player one of each type of axe

Permissions

tg.user - Allows player to fell trees and use /tg commands except /tg reload. Given to every player by default.
tg.operator - Gives access to /tgconfig commands and /tg reload. Given to every operator by default.

Community Suggestions

PRIORITY TO DO:
- Make plugin compatible with jobs reborn
- Add whitelist for wood types/ore types
- Add more customization:
  - messages.yml
  - max log amount variable in config
  - config variable for default off/on for players
  - Add whitelist for custom item names, similar to the allowedTools config setting (custom tool names/lore)
  - Auto replant chance % (For example, I would like 50% chance of auto replant)

BACK-BURNER TO DO:
- Require that the entire trunk be cut through before tree falls.
- Add "mining fatigue" that depends on how many logs are on the tree (similar to "Add a method to allow trees to act like mobs/entities, so you have to chop a log a certain number of times before it fells")
IMPLEMENTED
- Make plugin compatible with coreprotect - implemented with 4.5.0 on 6/14/2020
- Make plugin compatible with custom enchants plus (specifically oresweeper) - implemented with 4.4.0 on 6/5/2020
- Add a method where if you chop in the middle of the tree, only logs above the chopping point are broken completed on 11/23/19, implemented with 4.3.0
- Support immediate leaf decay completed on 8/17/19, implemented with 4.2.1
- Make the OreSweeper work with Fortune and Silk Touch completed on 8/17/19, implemented with 4.2.1
- Have another method like tgType 4.2, that instead of applying simple gravity to all logs on a tree, drops all logs in a conical pile beneath the tree. implemented with 4.2.0 on 8/17/19
- Have a config option which removes leaves or drops them (only leaves in a reasonable cubic area around the tree). implemented with 4.2.0 on 8/17/19
- Add an allowed worlds list to the config.yml implemented with 4.1.0 on 5/26/19
- Add option to ignore houseProtection so that spruce trees with minimal leaves can be felled. implemented with 4.1.0 on 5/26/19
- Config setting where logs go directly from the tree into player inventory implemented with 4.1.0 on 5/26/19
- Hook the plugin in with MCMMO implemented with 3.11.0 on 2/16/19
- Add an altered lumberjack method to have leaves break along with the logs implemented to 3.9.1 on 11/21/18
- Add an altered gravity method to have all logs on the tree fall down when one block is chopped implemented with 3.9.1 on 11/21/18
- Add a player by player option to toggle TreeGravity on and off implemented with 3.9.1 on 11/21/18
- Add an option to "chopMethod" where when you sneak, trees do not fell when hit with an axe implemented with 3.9.1 on 11/21/18
- Add an option to auto plant saplings left on the ground? So no more holes in the forest... implemented 10/8/18
- Add a config setting that implements RNG to decide whether the player receives more, less, or the exact number of logs a tree has. implemented 10/6/18

Random Notes

Notes on EpicWorldGenerator:

I have been told my plugin is incompatible with EWG. There is nothing in the TreeGravity code that would prevent trees in EWG from felling, besides the "HouseProtection" config setting. If you are attempting to use TG with EWG, set HouseProtection to 0.

To figure out what the compatibility issues were between plugins, I contacted minelazz, creator of EWG, to get a free developer copy of the EWG jar file to test both plugins on the same server. I contacted minelazz multiple times, and he has never responded to my messages. Unfortunately, until I have an EWG jar file to do testing with, I will not know what is causing the plugins to be incompatible, and so I cannot solve issues for which the cause is unknown. I am not willing to pay the $40 to test why EWG is incompatible with my plugin, as I have never used EWG and don't intend to use it on the servers I play.

The only suggestion i have is to set HouseProtection=0. If that doesn't work, you can either contact minelazz directly about allowing developers to test their plugins with EWG, or use minelazz's treefeller built for EWG.

All future comments/questions/issues regarding Treegravity and EWG compatibility should be directed to minelazz.