HT's TreeChop for Minecraft

Special support for the following mods:

• (1.18.2) Tinker's Construct: broad axes perform extra chops. All axes perform more chops with "expanded" upgrades.
• (1.18.2+) Silent Gear: saws perform extra chops
• (1.18.2+) Project MMO: chopping grants woodcutting XP
• (1.18.2+) Jade, WTHIT, TheOneProbe: show number of log blocks in trees and the number of chops needed to fell.
• And added compatibility with various other mods.

Known issues:

• (1.18.2 and earlier) Multi Mine: choppable blocks need to be added to Multi Mine's blacklist. This should be fixed for 1.19+ versions. See #106
• Some modded trees leave floating blocks when felled. See #44. Some cases can be fixed using the config files.

Doesn't affect Dynamic Trees.

Want to make your mod compatible with TreeChop? See the wiki.

1. How do I turn off chopping?
Press n to open TreeChop's in-game settings, then toggle off the "chopping" setting. A key can also be bound to toggle chopping without opening the settings screen; go to Options > Controls and find the section labeled "HT's TreeChop".

2. How do I keep chopping off and only turn it on while sneaking?
By default, sneaking inverts your current chop setting, so just toggle chopping off (press n to access the settings screen) so that chopping will be enabled by sneaking.

3. How do I keep chopping even when sneaking?
Press n to open TreeChop's in-game settings, then toggle off the "Sneaking inverts chopping" setting.

4. How do I keep from chopping my house down?
There's a setting to disable chopping if the "tree" is not connected to leaves. Press n to open TreeChop's in-game settings, then toggle "trees must have leaves".

5. I started chopping my house down. How do I stop?
If you find yourself chopping a block when you just wanted to break it normally, try breaking the block while sneaking, or toggle off chopping (press n to access the settings screen).

6. I was chopping something and the game crashed! What's up with that?
Probably the item you used to chop the tree doesn't play nice with TreeChop. Go to [your minecraft folder]/config/treechop-common.toml and add the item's registry name to choppingToolsBlacklist, or ask the server owner to, and then maybe let me know about the conflict and I'll try to fix it.

7. Why can't I chop anymore?
Maybe chopping is turned off; press n to open TreeChop's in-game settings, then toggle on the "chopping" setting. If chopping is enabled and changing tools doesn't help, then there might be a conflict with another mod. If you send me a recent log, I'll try to fix it.

8. Why do some trees leave behind floating leaves when felled?
Either
a) it's a modded tree and its leaves are not set up properly. Let me know what type of tree is misbehaving, and I'll politely inform the mod owners.
b) there are too many leaves! You can increase the max number of leaves by going to [your minecraft folder]/config/treechop-common.toml and increasing maxLeavesBlocks.

9. Why do some trees leave behind floating logs when felled?
Either
a) it's a modded tree and is weirdly shaped. Let me know, and I'll try to make TreeChop do a better job of detecting that type of tree.
b) the tree is too big! You can increase the max tree size by going to [your minecraft folder]/config/treechop-common.toml and increasing maxTreeBlocks.

10. How do I disable mushroom and fungus chopping?
Go to [your minecraft folder]/config/treechop-common.toml and change
    blockTagForDetectingLogs = "treechop:choppables"
to
    blockTagForDetectingLogs = "treechop:choppables_except_mushrooms"
If you want more control over which blocks can be chopped, you have to make your own datapack and fiddle with the block tags (see https://minecraft.gamepedia.com/Tag for more info).

12. Why am I not seeing the [fill in the blank] feature?
Only the newest version of Minecraft 1.16 is fully supported. Some older versions, especially 1.12.2, lack some of the fancier features.

11. Can I include this in a modpack?
Yes!

0.18.7
- Added a thwack
- Fixed flickering
- Fixed invisible blocks when using Cobblemon
- Fixed conflict with Twilight Forest's giant pickaxe
- Fixed chopped log visuals not updating when using /data commands
- Various minor improvements

0.18.6
- Significantly optimized tree detection
- Added compatibility with Apotheosis chainsaw enchantment
- Fixed tree blocks not showing with Jade
- (Via configs) Fixed Biomes o' Plenty's palm tree leaving floating leaves

0.18.5
- Fixed occasional crashes
- Fixed Jade compatibility
- Fixed floating leaves for Regions Unexplored's brimwood trees (via config/treechop-common.toml defaults)
- "problematicLeavesTrees" (set in config/treechop-common.toml) now break persistent blocks
- Expanded API

0.18.4
- Fixed conflicts with AOE tools from various mods

0.18.3
- Fixed conflicts with MultiMine
- Fixed shroomlights etc. being mistaken for leaves
- Added configurable detection of modded trees, fixing many cases of floating leaves
- Added API support for different tree shapes
- In configs, allow blocks and items to be specified using regular expressions
- Allow leaves to be detected more than 7 blocks away
- Various optimizations and fixes

0.18.2
- Fix mixin errors

0.18.1
- Fix crash for some users

0.18.0
- Fix some chopped block desyncs
- Fix & limit block break effects
- Optimized tree detection, especially on server side
- Fix error messages in Jade popups
- Various small fixes and tweaks
- (Forge) Fix "missing chop settings" errors on respawn

0.17.9
- Added Simplified Chinese localization
- Minor fixes for Jade, WTHIT, TheOneProbe plugins
- Moved TheOneProbe logic to the client
- Improvements to chop counting

0.17.8
- (Forge) Fix chop indicator performance issue

0.17.7
- Fix some API functions
- (Forge) Fix crashes in Tinker's Construct compatibility on remote servers
- (Forge) Add Silent Gear compatibility

0.17.6
- (Forge 1.18.2) Added Tinker's Construct compat
- (Fabric) Fix crashes with updated Fabric API + Sodium
- (Fabric) Disabled bark removal visual when using Sodium without Indium
- (Forge) Fix compatibility issues with Optifine
- (Forge) Fix Tetra tools not getting honed when chopping
- Fix lighting when smooth shading is disabled
- Decay leaves instead of breaking them (to play nicer with mods like Immersive Weathering)
- Various minor fixes and optimizations

0.17.4:
- (Forge) Fix crash for some users upgrading from 0.16.3
- (Forge) Restore Project MMO compatibility

0.17.3:
- Print fewer log messages
- Move chop indicator for left-handed players
- Add config to disable log messages
- Various compatibility and API fixes
- Various rendering fixes
- [Forge] Disable Project MMO compat due to crashes - will be restored soon

0.17.2:
- (Forge) Fix conflict with CarryOn causing crashes

0.17.1:
- (Forge) Fixed startup crash (yikes)

0.17.0:
- Add The One Probe support
- (Forge 1.19) Restore Jade & WTHIT support
- Better configuration for tree blocks and chopping tools
- Expanded API
- Fix spillover chops not getting visualized
- Fix textures for chopped mushroom stems
- Fix textures for bark removal on mismatched blocks
- Fix chop detector appearing for spectators
- Fix client-side rendering-related crashes due to mod conflicts
- Fix WTHIT widget for trees with multiple log types
- Fix conflicts with William Wythers' Overhauled Overworld
- Fix conflicts with trees from TerraformersMC mods
- Fix chopping XP awards for Project MMO

0.16.3:
- Fix server crash
- Fix logger not mentioning "TreeChop"
- [Fabric] Fix lighting issues with Starlight (https://modrinth.com/mod/starlight)
- [Fabric] Better rendering with Sodium (https://modrinth.com/mod/sodium)
- [Fabric 1.18.2] Add support for Jade (https://www.curseforge.com/minecraft/mc-mods/jade)
- [Fabric 1.18.2] Add support for WTHIT (https://www.curseforge.com/minecraft/mc-mods/wthit)

0.16.2:
- Fix minor visual issues
- Remove unnecessary config settings

0.16.1:
- [Fabric] Fix invisible logs when using Sodium (https://modrinth.com/mod/sodium)
- [Fabric] Fix crash when using Sodium + Iris Shaders (https://modrinth.com/mod/iris)
- [Fabric] List Forge Config API Port as a dependency (https://www.curseforge.com/minecraft/mc-mods/forge-config-api-port-fabric)

0.16.0:
- Optimize Jade/WTHIT plugins
- Remove overrides system (other mods can use TreeChop's API to adapt item behavior)
- Spruce up tooltips

0.15.8:
- Update to Minecraft 1.19.1
- Add Jade support
- Add WTHIT support
- Minor bug fixes

0.15.7:
- Fixed particle textures

0.15.6:
- Fixed conflicts with CarryOn
- Fixed chopping issues on interior logs
- Fixed chopped logs sometimes not dropping loot
- Fixed texture issues when chopping stripped logs
- Fixed conflict with No Tree Punching
- Fixed rendering conflicts when chop indicator appears

0.15.5:
- Fixed crash on Forge 39.0.45+

0.15.4:
- Fixed chopped log textures not persisting across save/load

0.15.3:
- Fixed chop indicator not reappearing after sneaking

0.15.2:
- Fixed crashes when chopping for some users

0.15.1:
- Fixed inability to chop blocks with empty hands
- Fixed chop indicator flickering

0.15.0:
- Use the appropriate stripped log textures for chopped logs
- Chopped blocks inherit the properties (such as break speed) of the original block (mostly affects mushrooms)
- Chopped blocks can overlap with water
- Fixed items being dropped on first chop; they are now dropped when the chopped log block is destroyed
- Added tooltips in settings screen
- Removed excessive error messages

0.14.6:
- Added Botania's Terra Truncator to the default tools blacklist

0.14.5:
- Added Russian localization
- Fixed missing loot table
- Allow requiring more than one chop per block when using the `linear` algorithm

0.14.4:
- Fixed leafless trees not getting chopped when `treesMustHaveLeaves` is off
- (0.12.2 only) Add ProjectMMO compatibility

0.14.3:
- Fixed tags-related conflict with various mods, including The Undergarden

0.14.2:
- Disabled chopping for non-player entities (e.g. modded machines) by default
- Added configurable chop settings for non-player entities

0.14.1:
- Fixed conflict with Dynamic Trees
- Fixed conflict with Project MMO 1.16.5

0.14.0:
- Added on-screen chop indicator
- Added in-game settings screen (press N to open)
- Requiring trees to have leaves is now the default setting
- Ignore leaves placed by players (this is configurable)
- Added config option to change chopping items blacklist to a whitelist
- Better compatibility with Tinker's Construct and other mods
- Added configurable overrides list to change how items behave when chopping
- Added configurable permissions for player settings
- Added localization for all text
- Added API for other mods to make use of TreeChop's chopping mechanics

0.13.0:
- Changed how TreeChop computes the number of chops required to fell a tree
- Added more configuration options for computing the number of chops required to fell a tree
- Better compatibility with Carry On versions carryon-1.16.5-1.15.2.9 and up

0.12.1:
- Fixed server crash on startup

0.12.0:
- Added procedural chopped log models
- Added compatibility with Project MMO
- Added option to show chopped texture on interior tree blocks instead of bark
- Added option to allow persistent leaves to be broken when felling
- Added option to disable chopping in creative
- Fixed issues with chopping interior logs on really big (3x3+) trees
- Fixed chopping getting semi-permanently deactivated for specific players
- Fixed sneak settings not getting saved
- Fixed mod display name
- Organized configs

0.11.3:
- Fixed conflict with CarryOn that caused pickup attempts to trigger chops

0.11.2:
- Fixed non-standard keys causing unbound controls to trigger
- Prevent players from disabling felling when `canChooseNotToChop=true`
- Show players a message when trying to change chop behavior when `canChooseNotToChop=false`

0.11.1:
- Fixed a crash when using Mekanism tools (and probably other modded items)
- Fixed the chopping tools blacklist getting reset to the default value on startup

0.11:
- Added client-side config option to only chop "trees" with "leaves"
- Added optional `treechop:choppables_except_mushrooms` block tag to disable chopping on mushrooms
- Let xp-dropping logs drop xp when felled
- Fixed fortune and silk touch enchantment effects not getting applied (only for blocks you chop, not felled blocks)
- Fixed occasional crashes when chopping with modded log-breaking items
- Fixed client-side config sometimes not syncing properly when joining a server
- Rewrote tree detection code to be more stable and maintainable
- Ported to 1.12.2

0.10:
- Fixed startup crash on dedicated servers

0.9:
- Fixed chopped blocks not spawning drops (again)
- Added keybinding to toggle chopping on and off
- Added keybinding to toggle felling on and off
- Added keybinding to change the effect sneaking has on chopping
- Added configurable blacklist to prevent chopping when holding certain items

0.8:
- Added config option `enabled` to disable chopping
- Added config option `canChooseNotToChop` to prevent players from not chopping
- Fixed crash when using tools from Silent's Gear (and possibly other mods)
- Fixed inability to break chopped logs without chopping

0.7:
- Fixed chopped blocks not spawning drops

0.6:
- Fixed chopping not draining item durability
- Fixed chopping not causing exhaustion
- Fixed chopping not dropping experience

0.5:
- Mushroom caps, fungus warts, and shroomlights break when felling
- Diagonal tree junctions are now choppable
- Breaking a single log destroys connected leaves
- Don't spawn drops in creative
- Any blocks with minecraft:leaves or treechop:leaves_like tags are treated as leaves
- Any blocks with minecraft:logs or treechop:choppable tags are treated as logs
- Can configure the block tag used to detect logs and leaves

0.4:
- Added configurability

0.3:
- Added limit to number of sounds played when a tree is felled
- Improved chop overflow block selection

treechop-common.toml

[permissions]
 #Whether this mod is enabled or not
 enabled = true

 [permissions.choppingEnabled]
  canBeFalse = true
  canBeTrue = true

 [permissions.fellingEnabled]
  canBeFalse = true
  canBeTrue = true

 [permissions.sneakBehavior]
  canBeNone = true
  canBeInvertFelling = true
  canBeInvertChopping = true

 [permissions.treeMustHaveLeaves]
  canBeFalse = true
  canBeTrue = true

 [permissions.chopInCreativeMode]
  canBeFalse = true
  canBeTrue = true

[general]
 #Whether to drop loot for blocks that have been chopped
 loseLootForChoppedBlocks = true

[treeDetection]
 #Maximum number of log blocks that can be detected to belong to one tree
 #Range: 1 ~ 8096
 maxTreeBlocks = 320
 #Maximum number of leaves blocks that can destroyed when a tree is felled
 #Range: 1 ~ 8096
 maxLeavesBlocks = 1024
 #Whether to destroy leaves when a tree is felled
 breakLeaves = true
 #Whether non-decayable leaves are ignored when detecting leaves
 ignorePersistentLeaves = true
 #Maximum distance from log blocks to destroy non-standard leaves blocks (e.g. mushroom caps) when felling
 #Range: 0 ~ 16
 maxBreakLeavesDistance = 7
 #The tag that blocks must have to be considered choppable (default: treechop:choppables)
 blockTagForDetectingLogs = "treechop:choppables"
 #The tag that blocks must have to be considered leaves (default: treechop:leaves_like)
 blockTagForDetectingLeaves = "treechop:leaves_like"

[chopCounting]
 #Method to use for computing the number of chops needed to fell a tree
 #Allowed Values: LINEAR, LOGARITHMIC
 algorithm = "LOGARITHMIC"
 #How to round the number of chops needed to fell a tree; this is more meaningful for smaller trees
 #Allowed Values: DOWN, NEAREST, UP
 rounding = "NEAREST"
 #Whether felling a tree can require more chops than the number of blocks in the tree
 canRequireMoreChopsThanBlocks = false

 #See https://github.com/hammertater/treechop/#logarithmic
 [chopCounting.logarithmic]
  #Determines the number of chops required to fell a tree; higher values require more chops for bigger trees
  #Range: 0.0 ~ 10000.0
  a = 10.0

 #See https://github.com/hammertater/treechop/#linear
 [chopCounting.linear]
  #The number of chops per block required to fell a tree; if chopsPerBlock = 0.5, it will take 50 chops to fell a 100 block tree
  #Range: 0.0 ~ 1.0
  chopsPerBlock = 1.0
  #The base number of chops required to fell a tree regardless of its size
  #Range: -10000.0 ~ 10000.0
  baseNumChops = 0.0

[compatibility]

 [compatibility.general]
  #Whether to prevent chopping during right-click actions
  preventChoppingOnRightClick = false
  #Whether to prevent infinite loops when chopping; fixes crashes when using modded items that break multiple blocks
  preventChopRecursion = true

  [compatibility.general.blacklist]
   #Whether the listed items should be blacklisted or whitelisted
   #Allowed Values: BLACKLIST, WHITELIST
   blacklistOrWhitelist = "BLACKLIST"
   #List of item registry names (mod:item), tags (#mod:tag), and namespaces (@mod) for items that should not chop when used to break a log
   #- Items in this list that have special support for TreeChop will not be blacklisted; see https://github.com/hammertater/treechop/blob/main/docs/compatibility.md#blacklist
   items = ["botania:terra_axe", "mekanism:atomic_disassembler", "@lumberjack", "practicaltools:iron_greataxe", "practicaltools:golden_greataxe", "practicaltools:diamond_greataxe", "practicaltools:netherite_greataxe"]

  [compatibility.general.overrides]
   #List of item registry names (mod:item), tags (#mod:tag), and namespaces (@mod) for items that should not perform their default behavior when chopping
   #- Add "?chops=N" to specify the number of chops to be performed when breaking a log with the item (defaults to 1)
   #- Add "?override=always" to disable default behavior even when chopping is disabled
   #- Add "?override=never" to never disable default behavior
   #- Items in this list that have special support for TreeChop will not be overridden; see https://github.com/hammertater/treechop/blob/main/docs/compatibility.md#overrides
   #- This might not work as expected for some items; see https://github.com/hammertater/treechop/blob/main/docs/compatibility.md#caveats
   items = ["#tconstruct:modifiable/harvest", "silentgear:saw?chops=3,override=always"]

  #The chop settings used by non-player entities, such as robots and machine blocks
  [compatibility.general.fakePlayerChopSettings]
   #Use with caution! May cause conflicts with some mods, e.g. https://github.com/hammertater/treechop/issues/71
   choppingEnabled = false
   #Felling only matters if chopping is enabled; probably best to leave this on
   fellingEnabled = true
   treesMustHaveLeaves = true

treechop-client.toml

[chopping]
 #Default setting for the effect that sneaking has on chopping (can be cycled in-game)
 #Allowed Values: NONE, INVERT_CHOPPING, INVERT_FELLING
 sneakBehavior = "INVERT_CHOPPING"
 #Whether to ignore trees without connected leaves
 treesMustHaveLeaves = true
 #Whether to enable chopping when in creative mode (even when false, sneaking can still enable chopping)
 chopInCreativeMode = false
 #Default setting for whether or not the user wishes to chop (can be toggled in-game)
 choppingEnabled = true
 #Default setting for whether or not the user wishes to fell tree when chopping (can be toggled in-game)
 fellingEnabled = true

[visuals]
 #Whether to use procedural chopped log models; disable to use models added by a resource pack
 useProceduralChoppedModels = true
 #Whether to replace the interior sides of logs with a chopped texture instead of bark
 removeBarkOnInteriorLogs = true

 [visuals.choppingIndicator]
  #Vertical location of the indicator relative to the player's crosshairs; positive values move the indicator down
  #Range: -256 ~ 256
  yOffset = 0
  #Horizontal location of the indicator relative to the player's crosshairs; positive values move the indicator to the right
  #Range: -256 ~ 256
  xOffset = 16
  #Whether to show an on-screen icon indicating whether targeted blocks can be chopped
  enabled = true

[settingsScreen]
 #Whether to show chat confirmations when using hotkeys to change chop settings
 showFeedbackMessages = true
 #Whether to show in-game options for enabling and disable felling
 showFellingOptions = false
 #Whether to show tooltips in the settings screen
 showTooltips = true