From a2c274cf96ed665fc44d21778c0e595334882c6d Mon Sep 17 00:00:00 2001 From: HybridDog Date: Sat, 4 Jan 2025 12:36:33 +0100 Subject: [PATCH] Update documentation in the README --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2726b4a..3aa10b6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -[Mod] treecapitator [treecapitator] +With the treecapitator mod for Luanti, +when a player digs part of a tree's stem, the whole tree is felled at once. + +There are many settings, for example an option to control whether leaves are +dropped, too, or only saplings, resembling leafdecay behaviour. +Support for moretrees is disabled by default and can be enabled with a setting. + +If players want to dig single trunk nodes instead of whole trees, they can hold +the shift key. +When felling a tree, neighbouring trees are detected and left unharmed. -This mod is makes digging a trunk node of a tree destroy the whole tree -including the leaves and the fruits. There are many settings, such as dropping -no leaves but only saplings (as leafdecay does it).
-Holding shift you can avoid its function to dig the single trunk node.
-Neighbour trees are detected and preserved.
This mod is based on Jeja's timber mod, however, the code was revised over and over, so it became a different mod (according to the [broom theory](https://www.youtube.com/watch?v=51n-EBigXmg) that is).