adventure-platform-mod 6.x (#68)

* Support adventure-platform-mod 6.x, drop 5.x support for signed string parser

It will always return unsigned string with 5.x.

* Implement ComponentMessageThrowable conversions and fix registry aware signed string conversions

* fix fabric error with 5.x and add neoforge metadata

* Bump adventure-api

* compile with adventure common

* read server once

* Remove unnecessary priority

* gitignore new kotlin files

Author: jpenilla

.gitignore

@@ -7,3 +7,5 @@ build
 .idea/
 
 run/
+
+.kotlin/

cloud-fabric/build.gradle.kts

@@ -38,7 +38,6 @@ dependencies {
     api(libs.cloud.brigadier)
 
     compileOnly(libs.cloud.minecraft.signed.arguments)
-    modCompileOnly(libs.adventureFabric)
 
     offlineLinkedJavadoc(project(":cloud-minecraft-modded-common"))
     localRuntime(project(":cloud-minecraft-modded-common"))
@@ -92,9 +91,16 @@ val testmod: SourceSet by sourceSets.creating {
     dependencies.add(implementationConfigurationName, main.output)
 }
 
+loom {
+    createRemapConfigurations(testmod)
+}
+
 dependencies {
     localRuntime(libs.cloud.minecraft.signed.arguments)
     modLocalRuntime(libs.adventureFabric)
+    "modTestmodImplementation"(libs.adventureFabric)
+    "testmodImplementation"(libs.cloud.minecraft.extras)
+    localRuntime(libs.cloud.minecraft.extras)
 }
 
 val testmodJar by tasks.registering(Jar::class) {

cloud-fabric/src/main/java/org/incendo/cloud/fabric/internal/CloudFabricEntrypoint.java

@@ -0,0 +1,58 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.fabric.internal;
+
+import java.util.Objects;
+import net.fabricmc.api.EnvType;
+import net.fabricmc.api.ModInitializer;
+import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents;
+import net.fabricmc.loader.api.FabricLoader;
+import org.apiguardian.api.API;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.framework.qual.DefaultQualifier;
+import org.incendo.cloud.minecraft.modded.internal.AdventureSupport;
+
+@API(status = API.Status.INTERNAL)
+@DefaultQualifier(NonNull.class)
+public final class CloudFabricEntrypoint implements ModInitializer {
+
+    @SuppressWarnings("EmptyCatch")
+    @Override
+    public void onInitialize() {
+        if (FabricLoader.getInstance().isModLoaded("adventure-platform-fabric")) {
+            try {
+                Objects.requireNonNull(
+                    Class.forName("net.kyori.adventure.platform.modcommon.MinecraftAudiences").getName()
+                );
+
+                ServerLifecycleEvents.SERVER_STARTING.register(AdventureSupport.get()::setupServer);
+                ServerLifecycleEvents.SERVER_STOPPED.register(AdventureSupport.get()::removeServer);
+                if (FabricLoader.getInstance().getEnvironmentType() == EnvType.CLIENT) {
+                    AdventureSupport.get().setupClient();
+                }
+            } catch (final ClassNotFoundException ignored) {
+            }
+        }
+    }
+}

cloud-fabric/src/main/resources/META-INF/services/org.incendo.cloud.minecraft.modded.internal.ModdedSignedStringMapper$SignedStringFactory

@@ -15,7 +15,8 @@
 
   "entrypoints": {
     "main": [
-      "org.incendo.cloud.fabric.internal.LateRegistrationCatcher"
+      "org.incendo.cloud.fabric.internal.LateRegistrationCatcher",
+      "org.incendo.cloud.fabric.internal.CloudFabricEntrypoint"
     ]
   },
 

cloud-fabric/src/main/resources/fabric.mod.json

@@ -27,16 +27,18 @@
 import java.util.Collection;
 import java.util.Comparator;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Collectors;
 import net.fabricmc.api.ModInitializer;
+import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents;
 import net.fabricmc.loader.api.FabricLoader;
 import net.fabricmc.loader.api.ModContainer;
 import net.fabricmc.loader.api.metadata.ModMetadata;
 import net.fabricmc.loader.api.metadata.Person;
 import net.kyori.adventure.chat.ChatType;
 import net.kyori.adventure.identity.Identity;
-import net.kyori.adventure.platform.fabric.AdventureCommandSourceStack;
-import net.kyori.adventure.platform.fabric.FabricServerAudiences;
+import net.kyori.adventure.platform.modcommon.AdventureCommandSourceStack;
+import net.kyori.adventure.platform.modcommon.MinecraftServerAudiences;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import net.minecraft.ChatFormatting;
 import net.minecraft.commands.CommandSourceStack;
@@ -61,9 +63,9 @@
 import org.incendo.cloud.fabric.FabricServerCommandManager;
 import org.incendo.cloud.fabric.testmod.mixin.GiveCommandAccess;
 import org.incendo.cloud.key.CloudKey;
+import org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler;
 import org.incendo.cloud.minecraft.modded.data.Coordinates;
 import org.incendo.cloud.minecraft.modded.data.Coordinates.ColumnCoordinates;
-import org.incendo.cloud.minecraft.modded.data.MultipleEntitySelector;
 import org.incendo.cloud.minecraft.modded.data.MultiplePlayerSelector;
 import org.incendo.cloud.minecraft.modded.parser.NamedColorParser;
 import org.incendo.cloud.minecraft.modded.parser.RegistryEntryParser;
@@ -89,6 +91,11 @@ public void onInitialize() {
         final FabricServerCommandManager<CommandSourceStack> manager =
             FabricServerCommandManager.createNative(ExecutionCoordinator.simpleCoordinator());
 
+        AtomicReference<MinecraftServerAudiences> audiences = new AtomicReference<>();
+        ServerLifecycleEvents.SERVER_STARTING.register((server) -> audiences.set(MinecraftServerAudiences.of(server)));
+        MinecraftExceptionHandler.<CommandSourceStack>create(stack -> audiences.get().audience(stack))
+            .registerTo(manager);
+
         final Command.Builder<CommandSourceStack> base = manager.commandBuilder("cloudtest");
 
         final CloudKey<String> name = CloudKey.of("name", String.class);
@@ -224,15 +231,16 @@ public void onInitialize() {
                 .map(Suggestion::suggestion)
                 .collect(Collectors.toList())))
             .parser((commandContext, commandInput) -> {
-                final ModMetadata meta = FabricLoader.getInstance().getModContainer(commandInput.readString())
+                final String s = commandInput.readString();
+                final ModMetadata meta = FabricLoader.getInstance().getModContainer(s)
                     .map(ModContainer::getMetadata)
                     .orElse(null);
                 if (meta != null) {
                     return ArgumentParseResult.success(meta);
                 }
                 return ArgumentParseResult.failure(new IllegalArgumentException(String.format(
                     "No mod with id '%s'",
-                    commandInput.peek()
+                    s
                 )));
             })
             .build();
@@ -269,7 +277,7 @@ public void onInitialize() {
             .required("targets", multiplePlayerSelectorParser())
             .required("location", vec3Parser(false))
             .handler(ctx -> {
-                final MultipleEntitySelector selector = ctx.get("targets");
+                final MultiplePlayerSelector selector = ctx.get("targets");
                 final Vec3 location = ctx.<Coordinates>get("location").position();
                 selector.values().forEach(target -> {
                     target.placePortalTicket(new BlockPos(Mth.floor(location.x()), Mth.floor(location.y()), Mth.floor(location.z())));
@@ -281,7 +289,7 @@ public void onInitialize() {
             .required("message", signedGreedyStringParser())
             .handler(ctx -> {
                 final AdventureCommandSourceStack audience =
-                    FabricServerAudiences.of(ctx.sender().getServer()).audience(ctx.sender());
+                    MinecraftServerAudiences.of(ctx.sender().getServer()).audience(ctx.sender());
 
                 final SignedString message = ctx.get("message");
 

cloud-fabric/src/testmod/java/org/incendo/cloud/fabric/testmod/FabricExample.java

@@ -13,6 +13,12 @@ neoForge {
     }
 }
 
+dependencies {
+    compileOnly(libs.adventureMod)
+
+    compileOnly(libs.cloud.minecraft.extras)
+}
+
 tasks.withType(AbstractRemapJarTask::class).configureEach {
     targetNamespace = "named"
 }

cloud-minecraft-modded-common/build.gradle.kts

@@ -0,0 +1,108 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.minecraft.modded.internal;
+
+import java.util.Objects;
+import net.kyori.adventure.platform.modcommon.MinecraftAudiences;
+import net.kyori.adventure.platform.modcommon.MinecraftClientAudiences;
+import net.kyori.adventure.platform.modcommon.MinecraftServerAudiences;
+import net.minecraft.server.MinecraftServer;
+import org.apiguardian.api.API;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.checkerframework.framework.qual.DefaultQualifier;
+
+@API(status = API.Status.INTERNAL)
+@DefaultQualifier(NonNull.class)
+public final class AdventureSupport {
+    private static final AdventureSupport INSTANCE;
+
+    static {
+        INSTANCE = new AdventureSupport();
+        INSTANCE.setupConverter();
+    }
+
+    private @Nullable MinecraftAudiences client;
+    private @Nullable MinecraftAudiences server;
+
+    private AdventureSupport() {
+    }
+
+    @SuppressWarnings("EmptyCatch")
+    private void setupConverter() {
+        try {
+            ComponentMessageThrowableConverter.setup(this);
+        } catch (final LinkageError ignored) {
+            // cloud-minecraft-extras not present
+        }
+    }
+
+    /**
+     * Set up the client audience.
+     */
+    public void setupClient() {
+        this.client = MinecraftClientAudiences.of();
+    }
+
+    /**
+     * Set up the server audience.
+     *
+     * @param server server
+     */
+    public void setupServer(final MinecraftServer server) {
+        this.server = MinecraftServerAudiences.of(server);
+    }
+
+    /**
+     * Shutdown the server audience.
+     *
+     * @param server server
+     */
+    @SuppressWarnings("unused")
+    public void removeServer(final MinecraftServer server) {
+        this.server = null;
+    }
+
+    /**
+     * Get the MinecraftAudiences instance.
+     *
+     * @return audiences
+     */
+    public MinecraftAudiences audiences() {
+        final @Nullable MinecraftAudiences server = this.server;
+        if (server == null) {
+            return Objects.requireNonNull(this.client, "No audiences present");
+        }
+        return server;
+    }
+
+    /**
+     * Returns the AdventureSupport instance.
+     *
+     * @return the instance
+     */
+    public static AdventureSupport get() {
+        return INSTANCE;
+    }
+}

cloud-minecraft-modded-common/src/main/java/org/incendo/cloud/minecraft/modded/internal/AdventureSupport.java

@@ -0,0 +1,55 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.minecraft.modded.internal;
+
+import com.mojang.brigadier.exceptions.CommandSyntaxException;
+import org.apiguardian.api.API;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.framework.qual.DefaultQualifier;
+import org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler;
+
+@API(status = API.Status.INTERNAL)
+@DefaultQualifier(NonNull.class)
+final class ComponentMessageThrowableConverter implements MinecraftExceptionHandler.ComponentMessageThrowableConverter {
+
+    private final AdventureSupport adventureSupport;
+
+    ComponentMessageThrowableConverter(final AdventureSupport adventureSupport) {
+        this.adventureSupport = adventureSupport;
+    }
+
+    static void setup(final AdventureSupport adventureSupport) {
+        MinecraftExceptionHandler.ComponentMessageThrowableConverterHolder.converter(
+            new ComponentMessageThrowableConverter(adventureSupport)
+        );
+    }
+
+    @Override
+    public Throwable maybeConvert(final Throwable thr) {
+        if (thr instanceof CommandSyntaxException cse) {
+            return (Exception) this.adventureSupport.audiences().asComponentThrowable(cse);
+        }
+        return thr;
+    }
+}