Update for Plex 2.0

Author: Telesphoreo

build.gradle.kts

@@ -16,18 +16,18 @@ repositories {
 }
 
 dependencies {
-    compileOnly("org.projectlombok:lombok:1.18.38")
-    annotationProcessor("org.projectlombok:lombok:1.18.38")
-    compileOnly("io.papermc.paper:paper-api:1.21.7-R0.1-SNAPSHOT")
-    compileOnly("dev.plex:server:1.5")
+    compileOnly("org.projectlombok:lombok:1.18.46")
+    annotationProcessor("org.projectlombok:lombok:1.18.46")
+    compileOnly("io.papermc.paper:paper-api:26.1.2.build.+")
+    compileOnly("dev.plex:api:2.0-SNAPSHOT")
 }
 
 group = "dev.plex"
-version = "1.0"
+version = "2.0-SNAPSHOT"
 description = "ExampleModule"
 
 java {
-    toolchain.languageVersion.set(JavaLanguageVersion.of(21))
+    toolchain.languageVersion.set(JavaLanguageVersion.of(25))
 }
 
 publishing {
@@ -53,4 +53,4 @@ tasks {
     processResources {
         filteringCharset = Charsets.UTF_8.name()
     }
-}
+}

src/main/java/dev/plex/ExampleModule.java

@@ -10,7 +10,10 @@ public class ExampleModule extends PlexModule
     public void enable()
     {
         registerCommand(new ExampleCommand());
-        registerListener(new ExampleListener());
+        registerListener(new ExampleListener(this));
+        api().logging().info("{0} enabled with Plex API compatibility {1}",
+                getPlexModuleFile().getName(),
+                api().compatibility().version());
     }
 
     @Override

src/main/java/dev/plex/command/ExampleCommand.java

@@ -1,42 +1,91 @@
 package dev.plex.command;
 
-import dev.plex.command.annotation.CommandParameters;
-import dev.plex.command.annotation.CommandPermissions;
-import java.util.Arrays;
-import java.util.Collections;
 import java.util.List;
+import java.util.Locale;
+import java.util.concurrent.atomic.AtomicInteger;
 import net.kyori.adventure.text.Component;
+import org.bukkit.Location;
+import org.bukkit.Particle;
+import org.bukkit.Sound;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-@CommandParameters(name = "examplemodule", description = "An example command provided by Plex's example module")
-@CommandPermissions(permission = "plex.module.command")
-public class ExampleCommand extends PlexCommand
+public class ExampleCommand extends SimplePlexCommand
 {
+    public ExampleCommand()
+    {
+        super(command("examplemodule")
+                .description("An example command provided by Plex's example module")
+                .usage("/<command> [info | sparkle]")
+                .aliases("example")
+                .build());
+    }
+
     @Override
-    protected Component execute(@NotNull CommandSender commandSender, @Nullable Player player, @NotNull String[] strings)
+    protected Component execute(@NotNull CommandSender sender, @Nullable Player player, @NotNull String[] args)
     {
-        return Component.text("Example module command");
+        if (args.length == 0)
+        {
+            return help();
+        }
+
+        return switch (args[0].toLowerCase(Locale.ROOT))
+        {
+            case "info" -> info();
+            case "sparkle" -> sparkle(player);
+            default -> usage();
+        };
     }
 
     @Override
-    public @NotNull List<String> smartTabComplete(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args) throws IllegalArgumentException
+    protected @NotNull List<String> suggestions(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args)
     {
-        if (silentCheckPermission(sender, this.getPermission()))
+        if (args.length == 1)
         {
-            if (args.length == 1)
-            {
-                return Arrays.asList("option1", "option2", "option3");
-            }
+            return List.of("info", "sparkle");
+        }
+        return List.of();
+    }
+
+    private Component help()
+    {
+        return mmString("""
+                <gold><bold>Plex Example Module</bold></gold>
+                <gray>Try <yellow>/example info</yellow> or <light_purple>/example sparkle</light_purple>.</gray>
+                """);
+    }
+
+    private Component info()
+    {
+        int compatibility = api().compatibility().version();
+        int loadedModules = api().modules().loadedModules().size();
+        return mmString("<gold>Plex API compatibility:</gold> <yellow>" + compatibility
+                + "</yellow> <dark_gray>•</dark_gray> <gold>Loaded modules:</gold> <yellow>"
+                + loadedModules + "</yellow>");
+    }
+
+    private Component sparkle(@Nullable Player player)
+    {
+        if (player == null)
+        {
+            return mmString("<red>Only players can sparkle.</red>");
+        }
 
-            if (args.length == 2)
+        AtomicInteger bursts = new AtomicInteger();
+        api().scheduler().runEntityTimer(player, task ->
+        {
+            int burst = bursts.incrementAndGet();
+            Location origin = player.getLocation().add(0, 1, 0);
+            player.getWorld().spawnParticle(Particle.END_ROD, origin, 12, 0.6, 0.7, 0.6, 0.02);
+            player.playSound(origin, Sound.BLOCK_NOTE_BLOCK_CHIME, 0.7f, 1.2f + burst * 0.15f);
+            if (burst >= 4)
             {
-                return Arrays.asList("option3", "option4");
+                task.cancel();
             }
-            return Collections.emptyList();
-        }
-        return Collections.emptyList();
+        }, null, 1L, 5L);
+
+        return mmString("<rainbow>A tiny celebration!</rainbow>");
     }
-}
+}

src/main/java/dev/plex/listener/ExampleListener.java

@@ -1,17 +1,28 @@
 package dev.plex.listener;
 
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.format.NamedTextColor;
+import dev.plex.ExampleModule;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.player.PlayerJoinEvent;
 
 public class ExampleListener extends PlexListener
 {
+    private final ExampleModule module;
+
+    public ExampleListener(ExampleModule module)
+    {
+        this.module = module;
+    }
+
     @EventHandler
     public void onPlayerJoin(PlayerJoinEvent event)
     {
         Player player = event.getPlayer();
-        player.sendMessage(Component.text("This is a message from Plex's example module!").color(NamedTextColor.GOLD));
+        player.sendMessage(module.api().messages().miniMessage(
+                "<gold>ExampleModule is awake!</gold> "
+                        + "<click:run_command:'/examplemodule sparkle'>"
+                        + "<hover:show_text:'<gray>Click for a tiny celebration</gray>'>"
+                        + "<aqua>[Try a sparkle]</aqua>"
+                        + "</hover></click>"));
     }
 }

src/main/resources/module.yml

@@ -1,4 +1,5 @@
 name: Module-Example
 main: dev.plex.ExampleModule
 description: An example module for Plex
-version: 1.0
+version: 2.0-SNAPSHOT
+apiCompatibility: 1