Merge pull request 'update treechop config' (#2) from treechop-config into main

Reviewed-on: #2

config/treechop-client.toml

@@ -8,7 +8,7 @@
 	#Enable chopping in creative mode (even when false, sneaking can still enable chopping) (can be toggled in-game)
 	chopInCreativeMode = false
 	#Default setting for whether or not the user wishes to chop (can be toggled in-game)
-	choppingEnabled = true
+	choppingEnabled = false
 	#Default setting for whether or not the user wishes to fell tree when chopping (can be toggled in-game)
 	fellingEnabled = true
 

config/treechop-common.toml

@@ -0,0 +1,144 @@
+[mod]
+	#Let TreeChop print to the log
+	printDebugInfo = true
+	#Set to false to disable TreeChop without having to uninstall the mod
+	enabled = true
+
+	[permissions.sneakBehavior]
+		canBeNone = true
+		canBeInvertChopping = true
+		canBeInvertFelling = true
+
+	[permissions.chopInCreativeMode]
+		canBeFalse = true
+		canBeTrue = true
+
+	[permissions.choppingEnabled]
+		canBeFalse = true
+		canBeTrue = false
+
+	[permissions.fellingEnabled]
+		canBeFalse = true
+		canBeTrue = true
+
+	[permissions.treeMustHaveLeaves]
+		canBeFalse = false
+		canBeTrue = true
+
+[general]
+	#If true, chopped logs will drop a log item immediately instead of waiting for the tree to be felled, restoring legacy behavior. Does nothing if dropLootForChoppedBlocks is false
+	dropLootOnFirstChop = false
+	#If false, log items will be destroyed when chopping
+	dropLootForChoppedBlocks = true
+
+[treeDetection]
+	#Destroy leaves when a tree is felled
+	breakLeaves = true
+	#Non-decayable leaves are ignored when detecting leaves
+	ignorePersistentLeaves = true
+	#Maximum number of leaves blocks that can destroyed when a tree is felled
+	#Range: 1 ~ 8096
+	maxLeavesBlocks = 1024
+	#Maximum distance from log blocks to destroy leaves blocks when felling
+	#Range: 0 ~ 16
+	maxBreakLeavesDistance = 7
+	#Maximum number of log blocks that can be detected to belong to one tree
+	#Range: 1 ~ 8096
+	maxTreeBlocks = 1024
+
+	[treeDetection.leaves]
+		#Blocks that should be considered leaves
+		#Specify using registry names (mod:block), tags (#mod:tag), and namespaces (@mod)
+		blocks = ["#treechop:leaves_like", "#minecraft:leaves", "pamhc2trees:pam[a-z]+"]
+		#Blocks that should never be considered leaves, even if included in the list above
+		#Specify using registry names (mod:block), tags (#mod:tag), and namespaces (@mod)
+		exceptions = []
+
+	[treeDetection.logs]
+		#Blocks that should be considered choppable
+		#For block lists, specify using registry names (mod:block), tags (#mod:tag), namespaces (@mod), and Java-style regular expressions
+		#Regular expressions must match the whole resource name, including the colon. Some simple examples are:
+		# - To match any block ending in _log: ".*_log", where .* is a wildcard
+		# - You can also specify a mod: "treemod:.*_log"
+		# - To also match stripped versions: ".*_log(_stripped)?", where ? means that the text in the parenthesis is optional
+		#For more help, see https://github.com/hammertater/treechop/wiki/Configuration
+		blocks = ["#treechop:choppables", "#minecraft:logs"]
+		#Blocks that should never be chopped, even if included in the list above
+		#Specify using registry names (mod:block), tags (#mod:tag), and namespaces (@mod)
+		exceptions = ["minecraft:bamboo", "#dynamictrees:branches", "dynamictrees:trunk_shell"]
+
+[chopCounting]
+	#Felling a tree can require more chops than the number of blocks in the tree
+	canRequireMoreChopsThanBlocks = false
+	#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"
+	#Method to use for computing the number of chops needed to fell a tree
+	#Allowed Values: LINEAR, LOGARITHMIC
+	algorithm = "LOGARITHMIC"
+
+	#See https://github.com/hammertater/treechop/#linear
+	[chopCounting.linear]
+		#The base number of chops required to fell a tree regardless of its size
+		#Range: -10000.0 ~ 10000.0
+		baseNumChops = 0.0
+		#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 ~ 7.0
+		chopsPerBlock = 1.0
+
+	#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
+
+	[compatibility.general]
+		#Prevent chopping when right-clicking blocks
+		preventChoppingOnRightClick = false
+		#Only chop when using a tool that increases block breaking speed (such as axes for logs)
+		choppingRequiresFastBreakingTool = false
+		#Only chop when using the correct tool for drops, if any (does nothing in vanilla, but some mods add tool requirements to logs
+		choppingRequiresCorrectToolForDrops = true
+		#Prevent infinite loops when chopping; fixes crashes when using modded items that break multiple blocks
+		preventChopRecursion = true
+
+		#The chop settings used by non-player entities, such as robots and machine blocks
+		[compatibility.general.fakePlayerChopSettings]
+			treesMustHaveLeaves = true
+			#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
+
+		[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", "@lumberjack", "mekanism:atomic_disassembler", "practicaltools:diamond_greataxe", "practicaltools:golden_greataxe", "practicaltools:iron_greataxe", "practicaltools:netherite_greataxe", "twilightforest:giant_pickaxe"]
+
+	[compatibility.API]
+		#Log information about TreeChop API usage. May be useful for debugging mod compatibility issues.
+		verbose = false
+
+	#A set of alternate tree detection strategies for oddly shaped trees
+	#For block lists, specify using registry names (mod:block), tags (#mod:tag), namespaces (@mod), and Java-style regular expressions
+	#Regular expressions must match the whole resource name, including the colon. Some simple examples are:
+	# - To match any block ending in _log: ".*_log", where .* is a wildcard
+	# - You can also specify a mod: "treemod:.*_log"
+	# - To also match stripped versions: ".*_log(_stripped)?", where ? means that the text in the parenthesis is optional
+	#For more help, see https://github.com/hammertater/treechop/wiki/Configuration
+	[compatibility.trees]
+
+		[compatibility.trees.hugeFungi]
+			leaves = ["#minecraft:wart_blocks", "minecraft:shroomlight"]
+			logs = ["#minecraft:crimson_stems", "#minecraft:warped_stems"]
+
+		[compatibility.trees.hugeMushrooms]
+			leaves = ["#c:mushroom_caps"]
+			logs = ["#c:mushroom_stems"]
+
+		[compatibility.trees.problematicLeavesTrees]
+			leaves = ["tropicraft:.*_leaves(_.*)?", "betternether:.*_leaves", "regions_unexplored:brimwood_leaves", "alexscaves:.*_branch", "alexscaves:pewen_pines"]
+			logs = ["tropicraft:.*_log(_.*)?", "mysticbiomes:.*_log", "betternether:.*_bark", "betternether:.*_log", "alexscaves:.*_log", "alexscaves:pewen_wood"]

index.toml

@@ -59,7 +59,11 @@ hash = "af85f2909fde8c0dbea201fb6fb4afc5070be875c24266b47887f33f03c19321"
 
 [[files]]
 file = "config/treechop-client.toml"
-hash = "b03b349044903a4e07956a31142161b8f6eb2c6ea161f3a4ebfaf90f7644c4f2"
+hash = "1ff3f0e2ce95ea1561eb80b69b1a18599adffd262566fb9befa2a49c9c33efbe"
+
+[[files]]
+file = "config/treechop-common.toml"
+hash = "eed9b2f6253d3adfee6feab7ef50d7ffca2237279c8e419d5b1e6ecb3a4c78f1"
 
 [[files]]
 file = "config/voicechat/voicechat-client.properties"

pack.toml

@@ -6,7 +6,7 @@ pack-format = "packwiz:1.1.0"
 [index]
 file = "index.toml"
 hash-format = "sha256"
-hash = "a2985766c05bd7b0ecb323d69a815492842b4145509f728ef3dc9c8265edf25b"
+hash = "e06008b1783e6d7cc38015020420fad6a3fead241af989b5838748c420e21a98"
 
 [versions]
 minecraft = "1.20.1"