feat: Add BalmClient#clientCommands

Author: BlayTheNinth

common/src/main/java/net/blay09/mods/balm/api/client/BalmClient.java

@@ -2,6 +2,7 @@
 
 import net.blay09.mods.balm.api.BalmRuntimeLoadContext;
 import net.blay09.mods.balm.api.EmptyLoadContext;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.api.client.keymappings.BalmKeyMappings;
 import net.blay09.mods.balm.api.client.module.BalmClientModule;
 import net.blay09.mods.balm.api.client.rendering.BalmModels;
@@ -103,4 +104,14 @@ public static BalmClientRuntime getRuntime() {
     public static BalmTextures getTextures() {
         return runtime.getTextures();
     }
+
+    /**
+     * Provides access to client command registration.
+     *
+     * @return implementation of {@link BalmClientCommands} for the mod loader Balm is running on.
+     */
+    public static BalmClientCommands clientCommands() {
+        return runtime.clientCommands();
+    }
+
 }

common/src/main/java/net/blay09/mods/balm/api/client/BalmClientRuntime.java

@@ -2,6 +2,7 @@
 
 import net.blay09.mods.balm.api.Balm;
 import net.blay09.mods.balm.api.BalmRuntimeLoadContext;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.api.client.keymappings.BalmKeyMappings;
 import net.blay09.mods.balm.api.client.module.BalmClientModule;
 import net.blay09.mods.balm.api.client.rendering.BalmModels;
@@ -29,6 +30,7 @@ default void initializeModule(BalmClientModule module) {
         module.registerScreens(getScreens().scoped(modId));
         module.registerModels(getModels().scoped(modId));
         module.registerKeyMappings(getKeyMappings().scoped(modId));
+        module.registerClientCommands(clientCommands());
         module.initialize();
     }
 
@@ -38,6 +40,8 @@ default void initializeModule(BalmClientModule module) {
 
     void registerModule(BalmClientModule module);
 
+    BalmClientCommands clientCommands();
+
     void addResourceReloadListener(ResourceLocation identifier, PreparableReloadListener reloadListener);
 
     /**

common/src/main/java/net/blay09/mods/balm/api/client/commands/BalmClientCommands.java

@@ -0,0 +1,10 @@
+package net.blay09.mods.balm.api.client.commands;
+
+import com.mojang.brigadier.CommandDispatcher;
+import net.minecraft.commands.SharedSuggestionProvider;
+
+import java.util.function.Consumer;
+
+public interface BalmClientCommands {
+    void register(Consumer<CommandDispatcher<SharedSuggestionProvider>> initializer);
+}

common/src/main/java/net/blay09/mods/balm/api/client/module/BalmClientModule.java

@@ -1,5 +1,6 @@
 package net.blay09.mods.balm.api.client.module;
 
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.api.client.keymappings.BalmKeyMappings;
 import net.blay09.mods.balm.api.client.rendering.BalmModels;
 import net.blay09.mods.balm.api.client.rendering.BalmRenderers;
@@ -27,4 +28,7 @@ default void registerKeyMappings(BalmKeyMappings keyMappings) {
 
     default void initialize() {
     }
+
+    default void registerClientCommands(BalmClientCommands commands) {
+    }
 }

fabric/src/main/java/net/blay09/mods/balm/fabric/client/FabricBalmClientRuntime.java

@@ -2,6 +2,7 @@
 
 import net.blay09.mods.balm.api.Balm;
 import net.blay09.mods.balm.api.BalmRuntimeLoadContext;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.api.client.keymappings.BalmKeyMappings;
 import net.blay09.mods.balm.api.client.rendering.BalmModels;
 import net.blay09.mods.balm.api.client.rendering.BalmRenderers;
@@ -13,6 +14,7 @@
 import net.blay09.mods.balm.common.NamespaceResolver;
 import net.blay09.mods.balm.common.client.CommonBalmClientRuntime;
 import net.blay09.mods.balm.fabric.FabricBalmRuntime;
+import net.blay09.mods.balm.fabric.client.internal.commands.FabricBalmClientCommands;
 import net.blay09.mods.balm.fabric.client.keymappings.FabricBalmKeyMappings;
 import net.blay09.mods.balm.fabric.client.rendering.FabricBalmModels;
 import net.blay09.mods.balm.fabric.client.rendering.FabricBalmRenderers;
@@ -46,6 +48,7 @@ public class FabricBalmClientRuntime extends CommonBalmClientRuntime {
     private final BalmScreens screens = new FabricBalmScreens(legacyNamespaceResolver);
     private final BalmKeyMappings keyMappings = createKeyMappingsBindings();
     private final BalmModels models = new FabricBalmModels(legacyNamespaceResolver);
+    private final BalmClientCommands clientCommands = new FabricBalmClientCommands();
 
     public FabricBalmClientRuntime() {
         FabricBalmClientEvents.registerEvents(((FabricBalmEvents) Balm.getEvents()));
@@ -94,6 +97,11 @@ public BalmModels getModels() {
         return models;
     }
 
+    @Override
+    public BalmClientCommands clientCommands() {
+        return clientCommands;
+    }
+
     @Override
     public void initializeMod(String modId, BalmRuntimeLoadContext context, Runnable initializer) {
         BalmLoadContexts.register(modId, context);

fabric/src/main/java/net/blay09/mods/balm/fabric/client/internal/commands/FabricBalmClientCommands.java

@@ -0,0 +1,33 @@
+package net.blay09.mods.balm.fabric.client.internal.commands;
+
+import com.mojang.brigadier.CommandDispatcher;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
+import net.fabricmc.fabric.api.client.command.v2.ClientCommandRegistrationCallback;
+import net.minecraft.commands.SharedSuggestionProvider;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+
+public class FabricBalmClientCommands implements BalmClientCommands {
+
+    private final List<Consumer<CommandDispatcher<SharedSuggestionProvider>>> commands = Collections.synchronizedList(new ArrayList<>());
+
+    public FabricBalmClientCommands() {
+        ClientCommandRegistrationCallback.EVENT.register((dispatcher, buildContext) -> {
+            final var sharedDispatcher = asSharedDispatcher(dispatcher);
+            commands.forEach(it -> it.accept(sharedDispatcher));
+        });
+    }
+
+    @SuppressWarnings({"unchecked", "rawtypes"})
+    private static CommandDispatcher<SharedSuggestionProvider> asSharedDispatcher(CommandDispatcher<?> dispatcher) {
+        return (CommandDispatcher) dispatcher;
+    }
+
+    @Override
+    public void register(Consumer<CommandDispatcher<SharedSuggestionProvider>> initializer) {
+        commands.add(initializer);
+    }
+}

forge/src/main/java/net/blay09/mods/balm/forge/client/ForgeBalmClientRuntime.java

@@ -2,6 +2,7 @@
 
 import net.blay09.mods.balm.api.Balm;
 import net.blay09.mods.balm.api.BalmRuntimeLoadContext;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
 import net.blay09.mods.balm.api.client.keymappings.BalmKeyMappings;
 import net.blay09.mods.balm.api.client.rendering.BalmModels;
 import net.blay09.mods.balm.api.client.rendering.BalmRenderers;
@@ -13,6 +14,7 @@
 import net.blay09.mods.balm.common.client.CommonBalmClientRuntime;
 import net.blay09.mods.balm.forge.ForgeLoadContext;
 import net.blay09.mods.balm.forge.ModBusEventRegisters;
+import net.blay09.mods.balm.forge.client.internal.commands.ForgeBalmClientCommands;
 import net.blay09.mods.balm.forge.client.keymappings.ForgeBalmKeyMappings;
 import net.blay09.mods.balm.forge.client.rendering.ForgeBalmModels;
 import net.blay09.mods.balm.forge.client.rendering.ForgeBalmRenderers;
@@ -34,6 +36,7 @@ public class ForgeBalmClientRuntime extends CommonBalmClientRuntime<ForgeLoadCon
     private final BalmScreens screens = new ForgeBalmScreens(legacyNamespaceResolver);
     private final BalmKeyMappings keyMappings = new ForgeBalmKeyMappings(legacyNamespaceResolver);
     private final BalmModels models = new ForgeBalmModels(legacyNamespaceResolver);
+    private final BalmClientCommands clientCommands = new ForgeBalmClientCommands();
 
     @Deprecated(forRemoval = true, since = "1.21.5")
     private final BalmTextures textures = new ForgeBalmTextures();
@@ -63,6 +66,11 @@ public BalmModels getModels() {
         return models;
     }
 
+    @Override
+    public BalmClientCommands clientCommands() {
+        return clientCommands;
+    }
+
     @Override
     public BalmKeyMappings getKeyMappings() {
         return keyMappings;

forge/src/main/java/net/blay09/mods/balm/forge/client/internal/commands/ForgeBalmClientCommands.java

@@ -0,0 +1,34 @@
+package net.blay09.mods.balm.forge.client.internal.commands;
+
+import com.mojang.brigadier.CommandDispatcher;
+import net.blay09.mods.balm.api.client.commands.BalmClientCommands;
+import net.minecraftforge.common.MinecraftForge;
+import net.minecraft.commands.SharedSuggestionProvider;
+import net.minecraftforge.client.event.RegisterClientCommandsEvent;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+
+public class ForgeBalmClientCommands implements BalmClientCommands {
+
+    private final List<Consumer<CommandDispatcher<SharedSuggestionProvider>>> commands = Collections.synchronizedList(new ArrayList<>());
+
+    public ForgeBalmClientCommands() {
+        MinecraftForge.EVENT_BUS.addListener((RegisterClientCommandsEvent event) -> {
+            final var sharedDispatcher = asSharedDispatcher(event.getDispatcher());
+            commands.forEach(it -> it.accept(sharedDispatcher));
+        });
+    }
+
+    @SuppressWarnings({"unchecked", "rawtypes"})
+    private static CommandDispatcher<SharedSuggestionProvider> asSharedDispatcher(CommandDispatcher<?> dispatcher) {
+        return (CommandDispatcher) dispatcher;
+    }
+
+    @Override
+    public void register(Consumer<CommandDispatcher<SharedSuggestionProvider>> initializer) {
+        commands.add(initializer);
+    }
+}