Add data-driven town advancements, /admintown advancements command (#210)

Author: WiIIiam278

bukkit/build.gradle

@@ -5,6 +5,7 @@ dependencies {
     implementation 'net.kyori:adventure-platform-bukkit:4.3.0'
     implementation 'io.papermc:paperlib:1.0.8'
     implementation 'me.lucko:commodore:2.2'
+    implementation 'net.william278:AdvancementAPI:97a9583413'
 
     compileOnly 'org.spigotmc:spigot-api:1.16.5-R0.1-SNAPSHOT'
     compileOnly 'org.jetbrains:annotations:24.0.1'
@@ -52,4 +53,5 @@ shadowJar {
     relocate 'org.bstats', 'net.william278.husktowns.libraries.bstats'
     relocate 'io.papermc', 'net.william278.husktowns.libraries.paperlib'
     relocate 'me.lucko', 'net.william278.husktowns.libraries'
+    relocate 'net.roxeez', 'net.william278.husktowns.libraries'
 }

bukkit/src/main/java/net/william278/husktowns/BukkitHuskTowns.java

@@ -1,7 +1,12 @@
 package net.william278.husktowns;
 
 import net.kyori.adventure.platform.bukkit.BukkitAudiences;
+import net.roxeez.advancement.AdvancementManager;
+import net.roxeez.advancement.display.BackgroundType;
+import net.roxeez.advancement.display.FrameType;
+import net.roxeez.advancement.trigger.TriggerType;
 import net.william278.desertwell.Version;
+import net.william278.husktowns.advancement.Advancement;
 import net.william278.husktowns.claim.ClaimWorld;
 import net.william278.husktowns.claim.Position;
 import net.william278.husktowns.claim.World;
@@ -30,6 +35,9 @@
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.SimplePie;
 import org.bukkit.Bukkit;
+import org.bukkit.Material;
+import org.bukkit.NamespacedKey;
+import org.bukkit.advancement.AdvancementProgress;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.PluginDescriptionFile;
 import org.bukkit.plugin.PluginManager;
@@ -61,6 +69,7 @@ public final class BukkitHuskTowns extends JavaPlugin implements HuskTowns, Plug
     private Validator validator;
     private OperationHandler operationHandler;
     private SpecialTypes specialTypes;
+    private Advancement advancements;
     private Map<UUID, Deque<Invite>> invites = new HashMap<>();
     private Map<UUID, Preferences> userPreferences = new HashMap<>();
     private Map<UUID, Visualizer> visualizers = new HashMap<>();
@@ -424,6 +433,71 @@ private void initializeMetrics() {
         }
     }
 
+    @Override
+    public void awardAdvancement(@NotNull Advancement advancement, @NotNull OnlineUser user) {
+        final NamespacedKey key = NamespacedKey.fromString(advancement.getKey(), this);
+        if (key == null) {
+            return;
+        }
+
+        final org.bukkit.advancement.Advancement bukkitAdvancement = Bukkit.getAdvancement(key);
+        if (bukkitAdvancement == null) {
+            return;
+        }
+        final AdvancementProgress progress = ((BukkitUser)user).getPlayer().getAdvancementProgress(bukkitAdvancement);
+        if (progress.isDone()) {
+            return;
+        }
+        getPlugin().runSync(() -> bukkitAdvancement.getCriteria().forEach(progress::awardCriteria));
+    }
+
+    @Override
+    public Optional<Advancement> getAdvancements() {
+        return Optional.ofNullable(advancements);
+    }
+
+    @Override
+    public void setAdvancements(@NotNull Advancement advancements) {
+        this.advancements = advancements;
+
+        this.runSync(() -> {
+            final AdvancementManager manager = new AdvancementManager(this);
+            registerAdvancement(advancements, manager, null);
+            manager.createAll(true);
+        });
+    }
+
+    private void registerAdvancement(@NotNull Advancement advancement, @NotNull AdvancementManager manager,
+                                     @Nullable net.roxeez.advancement.Advancement parent) {
+        final NamespacedKey key = NamespacedKey.fromString(advancement.getKey(), this);
+        if (key == null) {
+            return;
+        }
+
+        final net.roxeez.advancement.Advancement bukkitAdvancement = new net.roxeez.advancement.Advancement(key);
+        manager.register(((context) -> {
+            bukkitAdvancement.setDisplay(display -> {
+                display.setTitle(advancement.getTitle());
+                display.setDescription(advancement.getDescription());
+                display.setIcon(Optional.ofNullable(Material.matchMaterial(advancement.getIcon())).orElse(Material.STONE));
+                display.setBackground(BackgroundType.GRANITE);
+                display.setToast(advancement.doSendNotification());
+                display.setAnnounce(advancement.doSendNotification());
+                display.setFrame(switch (advancement.getFrame()) {
+                    case TASK -> FrameType.TASK;
+                    case CHALLENGE -> FrameType.CHALLENGE;
+                    case GOAL -> FrameType.GOAL;
+                });
+            });
+            if (parent != null) {
+                bukkitAdvancement.setParent(parent.getKey());
+            }
+            bukkitAdvancement.addCriteria("husktowns_completed", TriggerType.IMPOSSIBLE, (impossible -> {}));
+            return bukkitAdvancement;
+        }));
+        advancement.getChildren().forEach(child -> registerAdvancement(child, manager, bukkitAdvancement));
+    }
+
     @Override
     @NotNull
     public BukkitHuskTowns getPlugin() {

bukkit/src/main/java/net/william278/husktowns/hook/PlaceholderAPIHook.java

@@ -27,7 +27,7 @@ public PlaceholderAPIHook(@NotNull HuskTowns plugin) {
 
     @Override
     protected void onEnable() {
-        new HuskTownsExpansion(plugin).register();
+        plugin.runSync(() -> new HuskTownsExpansion(plugin).register());
     }
 
     public static class HuskTownsExpansion extends PlaceholderExpansion {

bukkit/src/main/resources/commodore/admintown.commodore

@@ -46,6 +46,14 @@ admintown {
    takeover {
        town brigadier:string single_word;
    }
+   advancements {
+       list {
+           player brigadier:string single_word;
+       }
+       reset {
+           player brigadier:string single_word;
+       }
+   }
    help {
        page brigadier:integer;
    }

bukkit/src/test/java/net/william278/husktowns/BukkitPluginTests.java

@@ -209,5 +209,4 @@ private static List<String> readTestData(@NotNull String fileName) {
         }
         return townNames;
     }
-
 }

common/src/main/java/net/william278/husktowns/HuskTowns.java

@@ -7,6 +7,7 @@
 import net.william278.annotaml.Annotaml;
 import net.william278.desertwell.UpdateChecker;
 import net.william278.desertwell.Version;
+import net.william278.husktowns.advancement.AdvancementTracker;
 import net.william278.husktowns.claim.*;
 import net.william278.husktowns.config.*;
 import net.william278.husktowns.database.Database;
@@ -45,7 +46,7 @@
 import java.util.logging.Level;
 import java.util.stream.Collectors;
 
-public interface HuskTowns extends TaskRunner, EventDispatcher {
+public interface HuskTowns extends TaskRunner, EventDispatcher, AdvancementTracker {
 
     int SPIGOT_RESOURCE_ID = 92672;
     int BSTATS_PLUGIN_ID = 11265;
@@ -306,6 +307,9 @@ default void loadConfig() throws RuntimeException {
             if (getSettings().doCrossServer()) {
                 setServer(Annotaml.create(new File(getDataFolder(), "server.yml"), Server.class).get());
             }
+            if (getSettings().doAdvancements()) {
+                loadAdvancements();
+            }
         } catch (IOException | InvocationTargetException | InstantiationException | IllegalAccessException e) {
             log(Level.SEVERE, "Failed to load configuration files", e);
             throw new RuntimeException(e);
@@ -416,9 +420,13 @@ default Key getKey(@NotNull String... data) {
         return Key.key("husktowns", joined);
     }
 
+    default GsonBuilder getGsonBuilder() {
+        return Converters.registerOffsetDateTime(new GsonBuilder().excludeFieldsWithoutExposeAnnotation());
+    }
+
     @NotNull
     default Gson getGson() {
-        return Converters.registerOffsetDateTime(new GsonBuilder().excludeFieldsWithoutExposeAnnotation()).create();
+        return getGsonBuilder().create();
     }
 
 }