Add WorldsListener for integration with Worlds plugin

Registers `WorldsListener` to handle `WorldDeleteEvent` when the Worlds plugin is present. Adds dependency and configuration updates for proper integration.

Author: NonSwag

build.gradle.kts

@@ -1,10 +1,10 @@
 import io.papermc.hangarpublishplugin.model.Platforms
 import net.minecrell.pluginyml.bukkit.BukkitPluginDescription
+import net.minecrell.pluginyml.paper.PaperPluginDescription
 
 plugins {
     id("idea")
     id("java")
-    id("java-library")
     id("com.gradleup.shadow") version "9.0.0-rc2"
     id("com.modrinth.minotaur") version "2.+"
     id("de.eldoria.plugin-yml.paper") version "0.7.1"
@@ -32,13 +32,14 @@ repositories {
 dependencies {
     paperweight.paperDevBundle("1.21.8-R0.1-SNAPSHOT")
 
-    api("org.bstats:bstats-bukkit:3.1.1-SNAPSHOT")
+    compileOnly("net.thenextlvl:worlds:3.2.5")
 
-    api("net.thenextlvl.core:adapters:2.0.2")
-    api("net.thenextlvl.core:i18n:3.2.0")
-    api("net.thenextlvl.core:paper:2.2.1")
+    implementation("net.thenextlvl.core:adapters:2.0.2")
+    implementation("net.thenextlvl.core:i18n:3.2.0")
+    implementation("net.thenextlvl.core:paper:2.2.1")
+    implementation("org.bstats:bstats-bukkit:3.1.1-SNAPSHOT")
 
-    api(project(":api"))
+    implementation(project(":api"))
 
     testImplementation(platform("org.junit:junit-bom:6.0.0-SNAPSHOT"))
     testImplementation("org.junit.jupiter:junit-jupiter")
@@ -62,7 +63,6 @@ sourceSets.main {
 
 tasks.shadowJar {
     archiveBaseName.set("per-worlds")
-    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
     relocate("org.bstats", "net.thenextlvl.perworlds.bstats")
 }
 
@@ -109,6 +109,13 @@ paper {
         register("perworlds.command.group.spawn.unset") { children = listOf("perworlds.command.group.spawn") }
         register("perworlds.command.group.teleport") { children = listOf("perworlds.command.group") }
     }
+
+    serverDependencies {
+        register("Worlds") {
+            load = PaperPluginDescription.RelativeLoadOrder.BEFORE
+            required = false
+        }
+    }
 }
 
 val versionString: String = project.version as String
@@ -128,6 +135,9 @@ hangarPublish { // docs - https://docs.papermc.io/misc/hangar-publishing
         platforms.register(Platforms.PAPER) {
             jar.set(tasks.shadowJar.flatMap { it.archiveFile })
             platformVersions.set(versions)
+            dependencies {
+                hangar("Worlds") { required.set(false) }
+            }
         }
     }
 }
@@ -140,4 +150,7 @@ modrinth {
     uploadFile.set(tasks.shadowJar)
     gameVersions.set(versions)
     loaders.add("paper")
+    dependencies {
+        optional.project("worlds-1")
+    }
 }

src/main/java/net/thenextlvl/perworlds/PerWorldsPlugin.java

@@ -11,6 +11,7 @@
 import net.thenextlvl.perworlds.listener.RespawnListener;
 import net.thenextlvl.perworlds.listener.TeleportListener;
 import net.thenextlvl.perworlds.listener.WorldListener;
+import net.thenextlvl.perworlds.listener.WorldsListener;
 import net.thenextlvl.perworlds.version.PluginVersionChecker;
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
@@ -49,12 +50,6 @@ public PerWorldsPlugin() {
     public void onLoad() {
         versionChecker.checkVersion();
         addCustomCharts();
-
-
-        provider.getLogger().warn("PerWorlds is nearing the end of beta");
-        provider.getLogger().warn("Although pretty stable, please be sure to always use the latest version");
-        provider.getLogger().warn("We still suggest taking backups of your player data before using this plugin");
-        provider.getLogger().warn("Please report any issues you encounter to {}", ISSUES);
         registerServices();
         loadGroups();
     }
@@ -82,6 +77,9 @@ private void registerListeners() {
         getServer().getPluginManager().registerEvents(new RespawnListener(provider), this);
         getServer().getPluginManager().registerEvents(new TeleportListener(provider), this);
         getServer().getPluginManager().registerEvents(new WorldListener(provider), this);
+
+        if (getServer().getPluginManager().getPlugin("Worlds") == null) return;
+        getServer().getPluginManager().registerEvents(new WorldsListener(provider), this);
     }
 
     private void warnWorldManager() {
@@ -93,7 +91,7 @@ private void warnWorldManager() {
         getComponentLogger().warn("Download at: https://modrinth.com/project/gBIw3Gvy");
         getComponentLogger().warn("Since Worlds already ships with PerWorlds, you have to uninstall this plugin when switching");
     }
-    
+
     private void loadGroups() {
         var suffix = ".dat";
         var files = provider.getDataFolder().listFiles((file, name) -> name.endsWith(suffix));
@@ -103,7 +101,7 @@ private void loadGroups() {
             if (!provider.hasGroup(name)) provider.createGroup(name);
         }
     }
-    
+
     private void persistGroups() {
         var groups = new ArrayList<>(provider.getGroups());
         groups.add(provider.getUnownedWorldGroup());
@@ -118,7 +116,8 @@ private void registerCommands() {
                 event.registrar().register(WorldCommand.create(this)));
     }
 
-    final Set<String> knownWorldManagers = Set.of( // list ordered by likelihood of a plugin being used
+    private final Set<String> knownWorldManagers = Set.of( // list ordered by likelihood of a plugin being used
+            "Worlds", // https://github.com/TheNextLvl-net/worlds
             "Multiverse-Core", // https://github.com/Multiverse/Multiverse-Core/
             "My_Worlds", // https://github.com/bergerhealer/MyWorlds
             "MultiWorld", // https://dev.bukkit.org/projects/multiworld-v-2-0 // https://modrinth.com/plugin/multiworld-bukkit

src/main/java/net/thenextlvl/perworlds/listener/WorldsListener.java

@@ -0,0 +1,24 @@
+package net.thenextlvl.perworlds.listener;
+
+import net.thenextlvl.perworlds.group.PaperGroupProvider;
+import net.thenextlvl.worlds.api.event.WorldDeleteEvent;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+
+public class WorldsListener implements Listener {
+    private final PaperGroupProvider provider;
+
+    public WorldsListener(PaperGroupProvider provider) {
+        this.provider = provider;
+    }
+
+    @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
+    public void onWorldDelete(WorldDeleteEvent event) {
+        provider.getGroup(event.getWorld()).ifPresent(group -> {
+            if (group.removeWorld(event.getWorld())) return;
+            provider.getLogger().error("Failed to remove deleted world {} from group {}",
+                    event.getWorld().getName(), group.getName());
+        });
+    }
+}