Breaking API change to module configs and lookup to make names be resource locations so that things like enabled can still be properly translated (#8121)

Note: This change may also cause module configs to fail to load for non mekanism modules, so we recommend removing them. There are no configs for the modules in mekanism generators so those should be fine. The legacy loading will be removed in a few Mek builds

Author: pupnewfster

src/api/java/mekanism/api/gear/IModule.java

@@ -7,6 +7,7 @@
 import mekanism.api.math.FloatingLongSupplier;
 import mekanism.api.text.IHasTextComponent;
 import net.minecraft.network.chat.Component;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.LivingEntity;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.ItemStack;
@@ -35,7 +36,7 @@ public interface IModule<MODULE extends ICustomModule<MODULE>> {
      * @since 10.6.0
      */
     @Nullable
-    <TYPE> ModuleConfig<TYPE> getConfig(String name);
+    <TYPE> ModuleConfig<TYPE> getConfig(ResourceLocation name);
 
     /**
      * Gets the value of a boolean config with the given name.
@@ -46,7 +47,7 @@ public interface IModule<MODULE extends ICustomModule<MODULE>> {
      *
      * @since 10.6.0
      */
-    default boolean getBooleanConfigOrFalse(String name) {
+    default boolean getBooleanConfigOrFalse(ResourceLocation name) {
         ModuleConfig<Boolean> config = getConfig(name);
         return config != null && config.get();
     }
@@ -59,7 +60,7 @@ default boolean getBooleanConfigOrFalse(String name) {
      * @throws IllegalArgumentException If this module does not contain a config with the given name.
      * @since 10.6.0
      */
-    default <TYPE> ModuleConfig<TYPE> getConfigOrThrow(String name) {
+    default <TYPE> ModuleConfig<TYPE> getConfigOrThrow(ResourceLocation name) {
         ModuleConfig<TYPE> config = getConfig(name);
         if (config == null) {
             throw new IllegalArgumentException("Expected module to contain a config with name " + name);

src/api/java/mekanism/api/gear/ModuleData.java

@@ -176,7 +176,7 @@ public final List<ModuleConfig<?>> defaultConfigs(int installed) {
      * @since 10.6.0
      */
     @Nullable
-    public final ModuleConfig<?> getNamedConfig(int installed, String name) {
+    public final ModuleConfig<?> getNamedConfig(int installed, ResourceLocation name) {
         for (ModuleConfig<?> config : getConfigData(installed).configs()) {
             if (config.name().equals(name)) {
                 return config;
@@ -265,7 +265,7 @@ private record ConfigData(List<ModuleConfig<?>> configs, List<Codec<? extends Mo
                               List<StreamCodec<? super RegistryFriendlyByteBuf, ? extends ModuleConfig<?>>> streamCodecs) {
 
         private ConstructedConfigData construct() {
-            Set<String> uniqueNames = new HashSet<>(configs.size());
+            Set<ResourceLocation> uniqueNames = new HashSet<>(configs.size());
             for (ModuleConfig<?> config : configs) {
                 if (!uniqueNames.add(config.name())) {
                     throw new IllegalStateException("Duplicate module config name " + config.name());

src/api/java/mekanism/api/gear/config/ModuleBooleanConfig.java

@@ -8,6 +8,7 @@
 import mekanism.api.annotations.NothingNullByDefault;
 import net.minecraft.network.codec.ByteBufCodecs;
 import net.minecraft.network.codec.StreamCodec;
+import net.minecraft.resources.ResourceLocation;
 
 /**
  * Immutable class representing a boolean module config (name and boolean value).
@@ -27,7 +28,7 @@ public class ModuleBooleanConfig extends ModuleConfig<Boolean> {
      * Stream codec for encoding and decoding boolean module configs over the network.
      */
     public static final StreamCodec<ByteBuf, ModuleBooleanConfig> STREAM_CODEC = StreamCodec.composite(
-          ByteBufCodecs.STRING_UTF8, ModuleConfig::name,
+          ResourceLocation.STREAM_CODEC, ModuleConfig::name,
           ByteBufCodecs.BOOL, ModuleConfig::get,
           ModuleBooleanConfig::new
     );
@@ -38,19 +39,19 @@ public class ModuleBooleanConfig extends ModuleConfig<Boolean> {
      * @param name   Name of the config option.
      * @param value  Value of the config option.
      */
-    public static ModuleBooleanConfig create(String name, boolean value) {
+    public static ModuleBooleanConfig create(ResourceLocation name, boolean value) {
         return new ModuleBooleanConfig(name, value);
     }
 
     private final boolean value;
 
-    protected ModuleBooleanConfig(String name, boolean value) {
+    protected ModuleBooleanConfig(ResourceLocation name, boolean value) {
         super(name);
         this.value = value;
     }
 
     @Override
-    public StreamCodec<ByteBuf, ModuleConfig<Boolean>> namedStreamCodec(String name) {
+    public StreamCodec<ByteBuf, ModuleConfig<Boolean>> namedStreamCodec(ResourceLocation name) {
         return ByteBufCodecs.BOOL.map(val -> new ModuleBooleanConfig(name, val), ModuleConfig::get);
     }
 

src/api/java/mekanism/api/gear/config/ModuleColorConfig.java

@@ -8,6 +8,7 @@
 import mekanism.api.annotations.NothingNullByDefault;
 import net.minecraft.network.codec.ByteBufCodecs;
 import net.minecraft.network.codec.StreamCodec;
+import net.minecraft.resources.ResourceLocation;
 
 /**
  * Immutable class representing a color based module config (name and int value).
@@ -27,7 +28,7 @@ public class ModuleColorConfig extends ModuleConfig<Integer> {
      * Stream codec for encoding and decoding ARGB based color module configs over the network.
      */
     public static final StreamCodec<ByteBuf, ModuleColorConfig> ARGB_STREAM_CODEC = StreamCodec.composite(
-          ByteBufCodecs.STRING_UTF8, ModuleConfig::name,
+          ResourceLocation.STREAM_CODEC, ModuleConfig::name,
           //Note: We don't do var-int as we include alpha data
           ByteBufCodecs.INT, ModuleConfig::get,
           ModuleColorConfig::argb
@@ -43,7 +44,7 @@ public class ModuleColorConfig extends ModuleConfig<Integer> {
      * Stream codec for encoding and decoding RGB based color module configs over the network.
      */
     public static final StreamCodec<ByteBuf, ModuleColorConfig> RGB_STREAM_CODEC = StreamCodec.composite(
-          ByteBufCodecs.STRING_UTF8, ModuleConfig::name,
+          ResourceLocation.STREAM_CODEC, ModuleConfig::name,
           //Note: We can use var int here and just not send the alpha data over the network
           ByteBufCodecs.VAR_INT, module -> module.get() & 0x00FFFFFF,
           ModuleColorConfig::rgb
@@ -54,7 +55,7 @@ public class ModuleColorConfig extends ModuleConfig<Integer> {
      *
      * @implNote Color format is ARGB.
      */
-    public static ModuleColorConfig argb(String name) {
+    public static ModuleColorConfig argb(ResourceLocation name) {
         return argb(name, 0xFFFFFFFF);
     }
 
@@ -65,7 +66,7 @@ public static ModuleColorConfig argb(String name) {
      *
      * @implNote Color format is ARGB.
      */
-    public static ModuleColorConfig argb(String name, int defaultColor) {
+    public static ModuleColorConfig argb(ResourceLocation name, int defaultColor) {
         return new ModuleColorConfig(name, true, defaultColor);
     }
 
@@ -74,7 +75,7 @@ public static ModuleColorConfig argb(String name, int defaultColor) {
      *
      * @implNote Color format is ARGB with the alpha component being locked to {@code 0xFF}.
      */
-    public static ModuleColorConfig rgb(String name) {
+    public static ModuleColorConfig rgb(ResourceLocation name) {
         return rgb(name, 0xFFFFFFFF);
     }
 
@@ -85,15 +86,15 @@ public static ModuleColorConfig rgb(String name) {
      *
      * @implNote Color format is ARGB with the alpha component being locked to {@code 0xFF}.
      */
-    public static ModuleColorConfig rgb(String name, int defaultColor) {
+    public static ModuleColorConfig rgb(ResourceLocation name, int defaultColor) {
         //If we don't handle alpha make sure we do have the alpha component present
         return new ModuleColorConfig(name, false, defaultColor);
     }
 
     private final boolean supportsAlpha;
     private final int value;
 
-    private ModuleColorConfig(String name, boolean supportsAlpha, int value) {
+    private ModuleColorConfig(ResourceLocation name, boolean supportsAlpha, int value) {
         super(name);
         this.supportsAlpha = supportsAlpha;
         //If we don't handle alpha make sure we do have the alpha component present though
@@ -110,7 +111,7 @@ public boolean supportsAlpha() {
     }
 
     @Override
-    public StreamCodec<ByteBuf, ModuleConfig<Integer>> namedStreamCodec(String name) {
+    public StreamCodec<ByteBuf, ModuleConfig<Integer>> namedStreamCodec(ResourceLocation name) {
         if (supportsAlpha) {
             //Note: We don't do varint as we include alpha data
             return ByteBufCodecs.INT.map(val -> ModuleColorConfig.argb(name, val), ModuleConfig::get);

src/api/java/mekanism/api/gear/config/ModuleConfig.java

@@ -4,11 +4,13 @@
 import com.mojang.serialization.codecs.RecordCodecBuilder.Instance;
 import com.mojang.serialization.codecs.RecordCodecBuilder.Mu;
 import java.util.Objects;
+import java.util.function.Function;
+import mekanism.api.MekanismAPI;
 import mekanism.api.SerializationConstants;
 import mekanism.api.annotations.NothingNullByDefault;
 import net.minecraft.network.RegistryFriendlyByteBuf;
 import net.minecraft.network.codec.StreamCodec;
-import net.minecraft.util.ExtraCodecs;
+import net.minecraft.resources.ResourceLocation;
 
 /**
  * Immutable class representing a module config (name and value).
@@ -22,39 +24,47 @@
 @NothingNullByDefault
 public abstract class ModuleConfig<DATA> {
 
+    private static ResourceLocation rl(String path) {
+        return ResourceLocation.fromNamespaceAndPath(MekanismAPI.MEKANISM_MODID, path);
+    }
+
     /**
      * Constant representing the module config for enabled state.
      */
-    public static final String ENABLED_KEY = "enabled";
+    public static final ResourceLocation ENABLED_KEY = rl("enabled");
     /**
      * Constant representing the module config for if a handling of mode change state.
      */
-    public static final String HANDLES_MODE_CHANGE_KEY = "handle_mode_change";
+    public static final ResourceLocation HANDLES_MODE_CHANGE_KEY = rl("handle_mode_change");
     /**
      * Constant representing the module config for whether the module should render on the HUD.
      */
-    public static final String RENDER_HUD_KEY = "render_hud";
+    public static final ResourceLocation RENDER_HUD_KEY = rl("render_hud");
 
     /**
      * Helper method to get the base part of a codec that contains all the parts necessary by this parent class.
      */
-    protected static <DATA, CONFIG extends ModuleConfig<DATA>> P1<Mu<CONFIG>, String> baseCodec(Instance<CONFIG> instance) {
-        return instance.group(ExtraCodecs.NON_EMPTY_STRING.fieldOf(SerializationConstants.NAME).forGetter(ModuleConfig::name));
+    protected static <DATA, CONFIG extends ModuleConfig<DATA>> P1<Mu<CONFIG>, ResourceLocation> baseCodec(Instance<CONFIG> instance) {
+        //TODO - 1.21: In a couple builds remove this hacky way to make old modules load
+        // Note: This legacy method only supports mekanism configs and not modded configs, as there is no clean way to know what namespace it should actually be in
+        return instance.group(ResourceLocation.CODEC.xmap(rl -> rl.getNamespace().equals("minecraft") ? rl(rl.getPath()) : rl, Function.identity())
+              .fieldOf(SerializationConstants.NAME).forGetter(ModuleConfig::name));
+        //return instance.group(ResourceLocation.CODEC.fieldOf(SerializationConstants.NAME).forGetter(ModuleConfig::name));
     }
 
     //TODO: Do we want to make module configs be a registry or something rather than being named?
     // It probably won't make that much difference as it still would need to keep track of the
     // "config type" which would basically just be a named registry object
-    private final String name;
+    private final ResourceLocation name;
 
-    protected ModuleConfig(String name) {
+    protected ModuleConfig(ResourceLocation name) {
         this.name = Objects.requireNonNull(name, "Name cannot be null.");
     }
 
     /**
      * {@return the name of this config option, should be unique}
      */
-    public final String name() {
+    public final ResourceLocation name() {
         return name;
     }
 
@@ -63,7 +73,7 @@ public final String name() {
      *
      * @param name Name to use during config decoding.
      */
-    public abstract StreamCodec<? super RegistryFriendlyByteBuf, ModuleConfig<DATA>> namedStreamCodec(String name);
+    public abstract StreamCodec<? super RegistryFriendlyByteBuf, ModuleConfig<DATA>> namedStreamCodec(ResourceLocation name);
 
     /**
      * {@return the value of this config option}
@@ -87,7 +97,7 @@ public final String name() {
      *
      * @return {@code false}, unless overridden to conditionally disable.
      *
-     * @apiNote When overriding, make sure to also override {@link #get()}, {@link #with(Object)}, {@link #namedStreamCodec(String)}, and use a custom codec and stream
+     * @apiNote When overriding, make sure to also override {@link #get()}, {@link #with(Object)}, {@link #namedStreamCodec(ResourceLocation)}, and use a custom codec and stream
      * codec when adding the config to the module data.
      */
     public boolean isConfigDisabled() {

src/api/java/mekanism/api/gear/config/ModuleEnumConfig.java

@@ -10,8 +10,8 @@
 import mekanism.api.annotations.NothingNullByDefault;
 import mekanism.api.text.IHasTextComponent;
 import net.minecraft.network.FriendlyByteBuf;
-import net.minecraft.network.codec.ByteBufCodecs;
 import net.minecraft.network.codec.StreamCodec;
+import net.minecraft.resources.ResourceLocation;
 import net.neoforged.neoforge.network.codec.NeoForgeStreamCodecs;
 import org.jetbrains.annotations.Nullable;
 
@@ -73,7 +73,7 @@ public static <TYPE extends Enum<TYPE> & IHasTextComponent> Codec<ModuleEnumConf
      */
     public static <BUF extends ByteBuf, TYPE extends Enum<TYPE> & IHasTextComponent> StreamCodec<BUF, ModuleEnumConfig<TYPE>> streamCodec(StreamCodec<BUF, TYPE> enumCodec) {
         return StreamCodec.composite(
-              ByteBufCodecs.STRING_UTF8, ModuleConfig::name,
+              ResourceLocation.STREAM_CODEC, ModuleConfig::name,
               enumCodec, ModuleConfig::get,
               ModuleEnumConfig::new
         );
@@ -102,7 +102,7 @@ public static <BUF extends ByteBuf, TYPE extends Enum<TYPE> & IHasTextComponent>
             return streamCodec(enumCodec);
         }
         return StreamCodec.composite(
-              ByteBufCodecs.STRING_UTF8, ModuleConfig::name,
+              ResourceLocation.STREAM_CODEC, ModuleConfig::name,
               enumCodec, ModuleConfig::get,
               (name, value) -> new ModuleEnumConfig<>(name, value, enumConstants)
         );
@@ -115,7 +115,7 @@ public static <BUF extends ByteBuf, TYPE extends Enum<TYPE> & IHasTextComponent>
      * @param value  Value of the config option.
      * @param <TYPE> Type of the data stored by this config.
      */
-    public static <TYPE extends Enum<TYPE> & IHasTextComponent> ModuleEnumConfig<TYPE> create(String name, TYPE value) {
+    public static <TYPE extends Enum<TYPE> & IHasTextComponent> ModuleEnumConfig<TYPE> create(ResourceLocation name, TYPE value) {
         return new ModuleEnumConfig<>(name, value);
     }
 
@@ -127,9 +127,9 @@ public static <TYPE extends Enum<TYPE> & IHasTextComponent> ModuleEnumConfig<TYP
      * @param selectableCount The number of selectable elements.
      * @param <TYPE>          Type of the data stored by this config.
      *
-     * @implNote If selectedCount is equal to the number of elements in the enum, this acts as if {@link #create(String, Enum)} was called instead.
+     * @implNote If selectedCount is equal to the number of elements in the enum, this acts as if {@link #create(ResourceLocation, Enum)} was called instead.
      */
-    public static <TYPE extends Enum<TYPE> & IHasTextComponent> ModuleEnumConfig<TYPE> createBounded(String name, TYPE value, int selectableCount) {
+    public static <TYPE extends Enum<TYPE> & IHasTextComponent> ModuleEnumConfig<TYPE> createBounded(ResourceLocation name, TYPE value, int selectableCount) {
         if (selectableCount <= 0) {
             throw new IllegalArgumentException("Invalid selectableCount, there must be at least one element that is selectable.");
         } else if (value.ordinal() >= selectableCount) {
@@ -157,18 +157,18 @@ private static <TYPE extends Enum<TYPE> & IHasTextComponent> List<TYPE> getEnumC
     private final List<TYPE> enumConstants;
     private final TYPE value;
 
-    private ModuleEnumConfig(String name, TYPE value) {
+    private ModuleEnumConfig(ResourceLocation name, TYPE value) {
         this(name, value, List.of(value.getDeclaringClass().getEnumConstants()));
     }
 
-    private ModuleEnumConfig(String name, TYPE value, List<TYPE> enumConstants) {
+    private ModuleEnumConfig(ResourceLocation name, TYPE value, List<TYPE> enumConstants) {
         super(name);
         this.value = value;
         this.enumConstants = enumConstants;
     }
 
     @Override
-    public StreamCodec<FriendlyByteBuf, ModuleConfig<TYPE>> namedStreamCodec(String name) {
+    public StreamCodec<FriendlyByteBuf, ModuleConfig<TYPE>> namedStreamCodec(ResourceLocation name) {
         return NeoForgeStreamCodecs.enumCodec(value.getDeclaringClass()).map(
               value -> new ModuleEnumConfig<>(name, value, enumConstants),
               ModuleConfig::get

src/datagen/main/java/mekanism/client/lang/BaseLanguageProvider.java

@@ -69,6 +69,10 @@ protected void addEntity(Holder<EntityType<?>> key, String value) {
         add(key.value().getDescriptionId(), value);
     }
 
+    protected void addModuleConfig(ResourceLocation configKey, String value) {
+        add("module." + configKey.getNamespace() + "." + configKey.getPath(), value);
+    }
+
     protected void addModuleConfig(String configKey, String value) {
         add("module." + modid + "." + configKey, value);
     }

src/main/java/mekanism/client/gui/element/custom/module/GuiModuleScreen.java

@@ -23,6 +23,7 @@
 import net.minecraft.Util;
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.network.chat.Component;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.ItemStack;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -38,7 +39,7 @@ public class GuiModuleScreen extends GuiScrollableElement {
 
     @Nullable
     private Module<?> currentModule;
-    private Map<String, MiniElement<?>> miniElements = new LinkedHashMap<>();
+    private Map<ResourceLocation, MiniElement<?>> miniElements = new LinkedHashMap<>();
     private int maxElements;
 
     public GuiModuleScreen(IGuiWrapper gui, int x, int y, Supplier<ItemStack> itemSupplier, Consumer<ModuleConfig<?>> saveCallback, ArmorPreview armorPreview) {
@@ -53,7 +54,7 @@ private GuiModuleScreen(IGuiWrapper gui, int x, int y, int width, int height, Su
     }
 
     public void setModule(@Nullable Module<?> module) {
-        Map<String, MiniElement<?>> newElements = new LinkedHashMap<>();
+        Map<ResourceLocation, MiniElement<?>> newElements = new LinkedHashMap<>();
 
         if (module != null) {
             int startY = getStartY(module);
@@ -62,8 +63,8 @@ public void setModule(@Nullable Module<?> module) {
                     //Skip options that are force disabled by the config
                     continue;
                 }
-                Component description = TextComponentUtil.translate(Util.makeDescriptionId("module", module.getData().getRegistryName().withPath(configItem.name())));
-                String name = configItem.name();
+                Component description = TextComponentUtil.translate(Util.makeDescriptionId("module", configItem.name()));
+                ResourceLocation name = configItem.name();
                 MiniElement<?> element = switch (configItem) {
                     // Don't show the enabled option if this is enabled by default
                     case ModuleBooleanConfig config when !name.equals(ModuleConfig.ENABLED_KEY) || !module.getData().isNoDisable() ->