Add towny compatibilty & most other claim plugins partial compatibility.

Author: HydrolienF

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.1.0
+Add towny compatibilty & most other claim plugins partial compatibility.
+
 # 1.0.0
 Break woods & logs connected to the broken block by a face, an edge or a corner.
 Avoid adding block to the queue more than once.

README.md

@@ -9,6 +9,7 @@
 [**Discord**](https://discord.gg/RPNbtRSFqG) | [**Hangar**](https://hangar.papermc.io/Hydrolien/TreeFalls) | [**Modrinth**](https://modrinth.com/plugin/treefalls) | [**GitHub**](https://github.com/Mvndi/TreeFalls)
 
 # TreeFalls
+
 Smooth tree falling Paper/Folia plugin.
 
 <img src="TreeFalls.gif" alt="tree falls" width="640" height="360" loop=infinite>
@@ -28,6 +29,11 @@ In the config you can set :
 - The list of materials that are concidered as trees.
 - The list of tools that are concidered as breaking tree tools.
 
+## Claim plugins
+
+Trees can't be cut in protected area for any protection plugin if it does not have blocks outside of the protected area.
+Towny town get an extra layer of protection, trying to cut a tree half in a foreign town will cut only the half outside of the town.
+
 
 ## Statistics
 [![bStats Graph Data](https://bstats.org/signatures/bukkit/treefalls.svg)](https://bstats.org/plugin/bukkit/TreeFalls/29518)
@@ -38,8 +44,8 @@ Clone the project from [GitHub](https://github.com/Mvndi/TreeFalls).
 Run `./gradlew assemble`
 The plugin jar file will be in build/libs/
 
-You can also start a test server directly from Gradle with `./gradlew runPaper`
+You can also start a test server directly from Gradle with `./gradlew runServer`
 
 ## Thanks
 Thanks to [SmoothTimber](https://github.com/SourceWriters/SmoothTimber) that inspired this project.
-This project is kind of a simplified version of SmoothTimber with modern tools (Maven -> Gradle, Spigot -> Paper, Manual run -> auto run with runPaper), much less dependencies and no legacy support (1.20+).
+This project is kind of a simplified version of SmoothTimber with modern tools (Maven -> Gradle, Spigot -> Paper, Manual run -> auto run with runServer), much less dependencies and no legacy support (1.20+).

build.gradle.kts

@@ -11,12 +11,12 @@ plugins {
 }
 
 group = "net.mvndicraft.treefalls"
-version = "1.0.0"
+version = "1.1.0"
 description = "Smooth tree falling when a log get broken by an axe"
 java.sourceCompatibility = JavaVersion.VERSION_21
 var mainMinecraftVersion = "1.21.11"
 val supportedMinecraftVersions = "1.20 - 1.21.11"
-
+val townyVersion = "0.102.0.7"
 
 repositories {
     mavenLocal()
@@ -25,10 +25,12 @@ repositories {
     // Paper
     maven("https://repo.papermc.io/repository/maven-public/")
     maven("https://repo.aikar.co/content/groups/aikar/")
+    maven("https://repo.glaremasters.me/repository/towny/")
 }
 
 dependencies {
     compileOnly("io.papermc.paper:paper-api:$mainMinecraftVersion-R0.1-SNAPSHOT")
+    compileOnly("com.palmergames.bukkit.towny:towny:$townyVersion")
 
     implementation("org.bstats:bstats-bukkit:3.1.0")
     implementation("co.aikar:acf-paper:0.5.1-SNAPSHOT")
@@ -81,6 +83,9 @@ tasks {
     }
 
     runServer {
+        downloadPlugins {
+            github("TownyAdvanced", "Towny", "$townyVersion", "towny-$townyVersion.jar") // we can't use the latest release because it's inside a zip.
+        }
         minecraftVersion("$mainMinecraftVersion")
     }
     runPaper.folia.registerTask()

src/main/java/net/mvndicraft/treefalls/TownyPerms.java

@@ -0,0 +1,14 @@
+package net.mvndicraft.treefalls;
+
+import com.palmergames.bukkit.towny.object.TownyPermission.ActionType;
+import com.palmergames.bukkit.towny.utils.PlayerCacheUtil;
+import org.bukkit.Location;
+import org.bukkit.Material;
+import org.bukkit.entity.Player;
+
+public class TownyPerms {
+    private TownyPerms() {}
+    public static boolean canBreak(Player player, Location location, Material material) {
+        return PlayerCacheUtil.getCachePermission(player, location, material, ActionType.DESTROY);
+    }
+}

src/main/java/net/mvndicraft/treefalls/TreeFallsPlugin.java

@@ -15,6 +15,7 @@
 import net.mvndicraft.treefalls.listener.FallingLogListener;
 import org.bstats.bukkit.Metrics;
 import org.bukkit.GameMode;
+import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.NamespacedKey;
 import org.bukkit.entity.Player;
@@ -25,6 +26,7 @@ public class TreeFallsPlugin extends JavaPlugin {
     private Set<Material> axes;
     private Set<GameMode> gameModes;
     private NamespacedKey fallingLogKey = new NamespacedKey(this, "falling_log");
+    private boolean townyEnabled;
     @Override
     public void onEnable() {
         new Metrics(this, 29518);
@@ -37,6 +39,8 @@ public void onEnable() {
 
         getServer().getPluginManager().registerEvents(new BrokenLogListener(), this);
         getServer().getPluginManager().registerEvents(new FallingLogListener(), this);
+
+        townyEnabled = getServer().getPluginManager().getPlugin("Towny") != null;
     }
 
     @Override
@@ -59,6 +63,11 @@ public void reloadConfig() {
     public boolean isGameModeOK(Player player) { return gameModes.contains(player.getGameMode()); }
     public NamespacedKey getFallingLogKey() { return fallingLogKey; }
 
+    // true if Towny is not enabled or if the player has Towny perms
+    public boolean hasTownyPerms(Player player, Location location, Material material) {
+        return !townyEnabled || TownyPerms.canBreak(player, location, material);
+    }
+
     private Set<GameMode> getConfigGameMode(String key) {
         if (!getConfig().isList(key)) {
             getLogger().warning(() -> "Invalid GameModes in config at '" + key + "': " + getConfig().get(key));

src/main/java/net/mvndicraft/treefalls/listener/BrokenLogListener.java

@@ -12,6 +12,7 @@
 import org.bukkit.entity.FallingBlock;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
 import org.bukkit.event.block.BlockBreakEvent;
 import org.bukkit.inventory.ItemStack;
@@ -22,7 +23,9 @@
 public class BrokenLogListener implements Listener {
 
     // Towny & most other plugins compatibility works by ignoring cancelled events
-    @EventHandler(ignoreCancelled = true)
+    // HIGHEST priority to allow Towny or other plugin to cancel the event.
+    // Towny get an extra test to avoid breaking trees that are half in a claim.
+    @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
     public void onLogBroken(BlockBreakEvent event) {
         if (TreeFallsPlugin.getInstance().isWood(event.getBlock().getType())
                 && TreeFallsPlugin.getInstance().isAxe(event.getPlayer().getInventory().getItemInMainHand().getType())
@@ -40,15 +43,17 @@ private void cutTree(Block block, Player player) {
         int cuttedBlocks = 0;
         while (!woodQueue.isEmpty() && cuttedBlocks < maxTreeSize && reduceDurability(player)) {
             block = woodQueue.poll();
-            fallBlock(block);
-            TreeFallsPlugin.debug("Falling block: " + block);
-            for (Block nextBlock : getNextBlocks(block)) {
-                if (TreeFallsPlugin.getInstance().isWood(nextBlock.getType()) && !woodQueue.contains(nextBlock)) {
-                    woodQueue.add(nextBlock);
-                    TreeFallsPlugin.debug("Added block to queue: " + nextBlock);
+            if (TreeFallsPlugin.getInstance().hasTownyPerms(player, block.getLocation(), block.getType())) {
+                fallBlock(block);
+                TreeFallsPlugin.debug("Falling block: " + block);
+                for (Block nextBlock : getNextBlocks(block)) {
+                    if (TreeFallsPlugin.getInstance().isWood(nextBlock.getType()) && !woodQueue.contains(nextBlock)) {
+                        woodQueue.add(nextBlock);
+                        TreeFallsPlugin.debug("Added block to queue: " + nextBlock);
+                    }
                 }
+                cuttedBlocks++;
             }
-            cuttedBlocks++;
         }
         TreeFallsPlugin.debug("Cutted " + cuttedBlocks + " blocks");
         TreeFallsPlugin.debug("Can more blocks be cut? " + (cuttedBlocks < maxTreeSize));

src/main/resources/paper-plugin.yml

@@ -6,3 +6,8 @@ folia-supported: true
 authors: [ Hydrolien ]
 description: $description
 website: mvndicraft.net
+dependencies:
+  server:
+    Towny:
+      required: false
+      load: BEFORE