Skip to content

Commit

Permalink
Add readme and fix inconsistency in config file naming
Browse files Browse the repository at this point in the history
  • Loading branch information
Rakambda committed Oct 27, 2019
1 parent 2ea5b34 commit 2e11a5a
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Falling Tree

Minecraft mod to break the whole tree in one cut.
This mod will allow you to break a full tree by only breaking one log off of it. Sneaking will disable this functionality.

![Demonstration of breaking a tree](https://github.com/RakSrinaNa/FallingTree/raw/1.14.4/assets/demo.gif)

Several options are available in the config file:
* logs_whitelisted: A list of the log blocks you want the mod to work on.
* tools_whitelisted: A list of tools you can break a tree with for the mod to apply.
* ignore_durability: If activated breaking down a tree won't damage your tool.
* max_log_count: The maximum number of log a tree can be mad of (if more the mod won't apply).
* preserve_tools: If this option is enabled your tool won't be broken by chopping down a big tree, it'll instead be left with 1 of durability.
Binary file added assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main/java/fr/raksrinana/fallingtree/FallingTree.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
public class FallingTree{
public static final String MOD_ID = "falling_tree";
public static final String MOD_NAME = "Falling Tree";
public static final String VERSION = "1.0.2";
public static final String VERSION = "1.0.3";
public static final Logger LOGGER = LogManager.getLogger(MOD_NAME);

public FallingTree(){
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public CommonConfig(ForgeConfigSpec.Builder builder){
whitelistedTools = builder.comment("List of tools that can be used to chop down a tree").defineList("tools_whitelisted", Lists.newArrayList("minecraft:wooden_axe", "minecraft:golden_axe", "minecraft:stone_axe", "minecraft:iron_axe", "minecraft:diamond_axe"), Objects::nonNull);
ignoreDurabilityLoss = builder.comment("Ignore the durability loss of breaking all the logs. If set to true, no harm will be done to the tool").define("ignore_durability", false);
maxTreeSize = builder.comment("The maximum size of a tree. If there's more logs than this value the tree won't be cut.").defineInRange("max_log_count", 100, 1, Integer.MAX_VALUE);
preserveTools = builder.comment("When set to true, when a tree is broken and the tool is about to break we will just break one block and not the whole tree.").define("preserve-tools", false);
preserveTools = builder.comment("When set to true, when a tree is broken and the tool is about to break we will just break one block and not the whole tree.").define("preserve_tools", false);
}

public Stream<Block> getWhitelistedLogs(){
Expand Down

0 comments on commit 2e11a5a

Please sign in to comment.