Tree Harvester

Download

You can download Tree Harvester on CurseForge and Modrinth:

  CurseForge:   https://curseforge.com/minecraft/mc-mods/tree-harvester
  Modrinth:      https://modrinth.com/mod/tree-harvester

Issue Tracker

To keep a better overview of all mods, the issue tracker is located in a separate repository.
  For issues, ideas, suggestions or anything else, please follow this link:

    -> Issue Tracker

Pull Requests

Because of the way mod loader files are bundled into one jar, some extra information is needed to do a PR.
  A wiki page entry about it is available here:

    -> Pull Request Information

Mod Description

Requires the library mod Collective.

   This mod is part of The Vanilla Experience modpack and Serilum's Quality of Life Bundle mod.
Tree Harvester is a configurable mod which allows harvesting trees, warped trees and huge mushrooms instantly by chopping down one base block. This can be any part of the tree. The sapling will automatically be replaced, by using what the tree drops. There are many checks in the mod, from preventing accidental harvesting of houses made from logs to what leaves should decay.

By default the harvesting only works when holding the crouch button, but this can be toggled in the config. For more feature examples see below. There are lots of config options to tweak the mod exactly to your liking.

Developed to work alongside my Ore Harvester mod.


Features with the default configuration settings:
◉   All trees, vanilla and modded, can be harvested quickly by crouching and chopping down one block.
◉   The time it takes to chop down a tree is determined by the amount of logs in it.
◉   Leaves will decay very quickly after harvesting a tree.
◉   Saplings will be replaced after the last leaf has been decayed.
◉   Warped trees, in the nether, can be harvested quickly.
◉   Huge mushrooms can also be harvested quickly
◉   Certain axe types can be exempted from harvesting trees via a blacklist.
◉   Many checks to determine what is a tree and what isn't. No accidental destroying of houses.
◉   When two types of trees are next to each other, only the leaves of the tree broken will decay.
◉   Compatible with other mods.



Configurable: ( how do I configure? )
mustHoldAxeForTreeHarvest (default = true): If enabled, tree harvesting only works when a player is holding an axe in the main hand.
treeHarvestWithoutSneak (default = false): If enabled, tree harvesting works when not holding the sneak button. If disabled it's reversed, and only works when sneaking.
automaticallyFindBottomBlock (default = true): Whether the mod should attempt to find the actual bottom log of the tree and start there. This means you can break a tree in the middle and it will still completely be felled.

enableFastLeafDecay (default = true): If enabled, the leaves around a broken tree will quickly disappear.
enableNetherTrees (default = true): If enabled, the warped stem/crimson trees in the nether will also be chopped down quickly.
enableHugeMushrooms (default = true): If enabled, giant/huge mushrooms will also be chopped down quickly.
ignorePlayerMadeTrees (default = true): If enabled, trees with leaves placed by players won't be destroyed.

replaceSaplingOnTreeHarvest (default = true): If enabled, automatically replaces the sapling from the drops when a tree is harvested.
replaceMushroomOnMushroomHarvest (default = true): If enabled, automatically replaces the sapling from the drops when a huge mushroom is harvested and 'enableHugeMushrooms' is enabled.

loseDurabilityPerHarvestedLog (default = true): If enabled, for every log harvested, the axe held loses durability.
loseDurabilityModifier (default = 1.0, min 0.001, max 1.0): Here you can set how much durability chopping down a tree should take from the axe. For example if set to 0.1, this means that every 10 logs take 1 durability.

increaseExhaustionPerHarvestedLog (default = true): If enabled, players' exhaustion level increases 0.005 per harvested log (Minecraft's default per broken block) * increaseExhaustionModifier.
increaseExhaustionModifier (default = 1.0, min 0.001, max 1.0): This determines how much exhaustion should be added to the player per harvested log. By default 0.005 * 1.0.

increaseHarvestingTimePerLog (default = true): If enabled, harvesting time will increase per existing log in the tree. The amount is determined by 'increasedHarvestingTimePerLogModifier'.
increasedHarvestingTimePerLogModifier (default = 0.1, min 0.01, max 10.0): How much longer it takes to harvest a tree with 'increaseHarvestingTimePerLog' enabled. The actual speed is: newSpeed = originalSpeed / (1 + (logCount * increasedHarvestingTimePerLogModifier)).

amountOfLeavesBrokenPerTick (default = 3, min 1, max 16): How many leaves should be broken per tick after a tree has been harvested. Increasing this will speed up the fast leaf decay, but costs more processing power per tick.



Axe Blacklist Feature:
It's possible to only allow certain axes to harvest trees. On first load of the mod a blacklist file is generated. It is located at ./config/treeharvester/harvestable_axe_blacklist.txt. This works for modded axe items as well.



Some GIFs:
Harvesting a birch tree next to another oak. Only the birch leaves are decaying:

 
A big oak tree:

 
A 2x2 spruce tree. The time it takes to break the tree is longer, and all 4 saplings are replaced correctly:

 
Works with warped (nether) trees:

 
Also for huge mushrooms, here's a brown one:

 
And a red mushroom:

------------------

You may freely use this mod in any modpack, as long as the download remains hosted within the CurseForge or Modrinth ecosystem.

Serilum.com contains an overview and more information on all mods available.

Comments are disabled as I'm unable to keep track of all the separate pages on each mod.
For issues, ideas, suggestions or anything else there is the Github repo. Thanks!