feat: better UX and accessibility

Closes #118
Action buttons now show tooltips explaining their functionality. These will also be read by the narrator.

common/src/main/java/eu/midnightdust/core/MidnightLib.java

@@ -3,8 +3,6 @@ package eu.midnightdust.core;
 import eu.midnightdust.core.config.MidnightLibConfig;
 import eu.midnightdust.lib.config.AutoCommand;
 import eu.midnightdust.lib.config.MidnightConfig;
-import net.fabricmc.api.EnvType;
-import net.fabricmc.api.Environment;
 import net.minecraft.util.Util;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -19,7 +17,6 @@ public class MidnightLib {
     public static final String MOD_ID = "midnightlib";
     public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
 
-    @Environment(EnvType.CLIENT)
     public static void onInitializeClient() {
         try {
             if (Util.getOperatingSystem() != Util.OperatingSystem.OSX) {

common/src/main/java/eu/midnightdust/core/screen/MidnightConfigOverviewScreen.java

@@ -2,8 +2,6 @@ package eu.midnightdust.core.screen;
 
 import eu.midnightdust.core.MidnightLib;
 import eu.midnightdust.lib.config.MidnightConfig;
-import net.fabricmc.api.EnvType;
-import net.fabricmc.api.Environment;
 import net.minecraft.client.gui.DrawContext;
 import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.client.gui.widget.ButtonWidget;
@@ -17,7 +15,6 @@ import java.util.Objects;
 
 import eu.midnightdust.lib.config.MidnightConfigListWidget;
 
-@Environment(EnvType.CLIENT)
 public class MidnightConfigOverviewScreen extends Screen {
 
     public MidnightConfigOverviewScreen(Screen parent) {

common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java

@@ -3,8 +3,6 @@ package eu.midnightdust.lib.config;
 import com.google.gson.*;
 import com.google.gson.stream.*;
 import eu.midnightdust.lib.util.PlatformFunctions;
-import net.fabricmc.api.EnvType;
-import net.fabricmc.api.Environment;
 import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.client.gui.widget.*;
 import net.minecraft.client.resource.language.I18n;
@@ -83,7 +81,6 @@ public abstract class MidnightConfig {
         instance.loadValuesFromJson();
     }
 
-    @Environment(EnvType.CLIENT)
     public void addClientEntry(Field field, EntryInfo info) {
         Entry e = info.entry;
         if (e != null && info.dataType != null) {
@@ -215,11 +212,9 @@ public abstract class MidnightConfig {
     public void onTabInit(String tabName, MidnightConfigListWidget list, MidnightConfigScreen screen) {
     }
 
-    @Environment(EnvType.CLIENT)
     public static Screen getScreen(Screen parent, String modid) {
         return configInstances.get(modid).getScreen(parent);
     }
-    @Environment(EnvType.CLIENT)
     public Screen getScreen(Screen parent) {
         return new MidnightConfigScreen(parent, modid);
     }

common/src/main/java/eu/midnightdust/lib/config/MidnightConfigListWidget.java

@@ -1,7 +1,5 @@
 package eu.midnightdust.lib.config;
 
-import net.fabricmc.api.EnvType;
-import net.fabricmc.api.Environment;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.gl.RenderPipelines;
 import net.minecraft.client.gui.DrawContext;
@@ -12,7 +10,6 @@ import net.minecraft.text.Text;
 
 import java.util.List;
 
-@Environment(EnvType.CLIENT)
 public class MidnightConfigListWidget extends ElementListWidget<ButtonEntry> {
     public boolean renderHeaderSeparator = true;
 

common/src/main/java/eu/midnightdust/lib/config/MidnightConfigScreen.java

@@ -1,13 +1,12 @@
 package eu.midnightdust.lib.config;
 
 import com.google.common.collect.Lists;
-import net.fabricmc.api.EnvType;
-import net.fabricmc.api.Environment;
 import net.minecraft.client.gui.DrawContext;
 import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.client.gui.tab.GridScreenTab;
 import net.minecraft.client.gui.tab.Tab;
 import net.minecraft.client.gui.tab.TabManager;
+import net.minecraft.client.gui.tooltip.Tooltip;
 import net.minecraft.client.gui.widget.*;
 import net.minecraft.client.input.KeyInput;
 import net.minecraft.client.resource.language.I18n;
@@ -28,7 +27,6 @@ import java.util.function.BiFunction;
 import java.util.function.Function;
 import java.util.function.Predicate;
 
-@Environment(EnvType.CLIENT)
 public class MidnightConfigScreen extends Screen {
     public MidnightConfig instance;
     public final String translationPrefix, modid;
@@ -195,7 +193,7 @@ public class MidnightConfigScreen extends Screen {
                             info.listIndex = info.listIndex != values.size() ? info.listIndex + 1 : 0;
                             info.tempValue = info.listIndex != values.size() ? info.toTemporaryValue() : "";
                             updateList();
-                        })).dimensions(width - 185, 0, 20, 20).build();
+                        })).dimensions(width - 185, 0, 20, 20).tooltip(Tooltip.of(Text.translatable("midnightconfig.action.list_index", info.listIndex))).build();
                     }
                     if (e.isColor()) {
                         ButtonWidget colorButton = ButtonWidget.builder(Text.literal("⬛"),
@@ -206,7 +204,7 @@ public class MidnightConfigScreen extends Screen {
                                         updateList();
                                     }
                                 }).start()
-                        ).dimensions(width - 185, 0, 20, 20).build();
+                        ).dimensions(width - 185, 0, 20, 20).tooltip(Tooltip.of(Text.translatable("midnightconfig.action.color_chooser"))).build();
                         try {
                             colorButton.setMessage(Text.literal("⬛").setStyle(Style.EMPTY.withColor(Color.decode(info.tempValue).getRGB())));
                         } catch (Exception ignored) {
@@ -228,6 +226,7 @@ public class MidnightConfigScreen extends Screen {
                                     }
                                 }).start(), true
                         ).texture(Identifier.of("midnightlib", "icon/explorer"), 12, 12).dimension(20, 20).build();
+                        explorerButton.setTooltip(Tooltip.of(Text.translatable("midnightconfig.action.file_chooser")));
                         explorerButton.setPosition(width - 185, 0);
                         info.actionButton = explorerButton;
                     }

common/src/main/resources/assets/midnightlib/lang/de_de.json

@@ -3,5 +3,8 @@
 	"midnightlib.midnightconfig.title":"MidnightLib Konfiguration",
 	"midnightlib.midnightconfig.config_screen_list":"Konfigurationsübersicht",
 	"modmenu.summaryTranslation.midnightlib": "Code-Bibliothek für einfache Konfiguration.",
-	"midnightconfig.colorChooser.title": "Wähle eine Farbe"
+	"midnightconfig.colorChooser.title": "Wähle eine Farbe",
+    "midnightconfig.action.list_index": "Bearbeite Liste an Index %s",
+    "midnightconfig.action.color_chooser": "Öffne Farbauswahl",
+    "midnightconfig.action.file_chooser": "Öffne Dateiauswahl"
 }

common/src/main/resources/assets/midnightlib/lang/en_us.json

@@ -9,5 +9,8 @@
 	"midnightlib.curseforge":"CurseForge",
 	"midnightlib.wiki":"Wiki",
 	"modmenu.summaryTranslation.midnightlib": "Common Library for easy configuration.",
-	"midnightconfig.colorChooser.title": "Choose a color"
+	"midnightconfig.colorChooser.title": "Choose a color",
+    "midnightconfig.action.list_index": "Editing list at index %s",
+    "midnightconfig.action.color_chooser": "Open color chooser",
+    "midnightconfig.action.file_chooser": "Open file chooser"
 }

fabric/src/main/java/eu/midnightdust/fabric/core/MidnightLibFabric.java

@@ -1,10 +1,11 @@
 package eu.midnightdust.fabric.core;
 
 import eu.midnightdust.core.MidnightLib;
-import net.fabricmc.api.*;
+import net.fabricmc.api.ClientModInitializer;
+import net.fabricmc.api.DedicatedServerModInitializer;
 
 public class MidnightLibFabric implements DedicatedServerModInitializer, ClientModInitializer {
-    @Override @Environment(EnvType.CLIENT)
+    @Override
     public void onInitializeClient() {
         MidnightLib.onInitializeClient();
         MidnightLib.registerAutoCommand();

gradle.properties

@@ -1,21 +1,21 @@
 org.gradle.jvmargs=-Xmx3172M
 
-minecraft_version=1.21.9-rc1
+minecraft_version=1.21.9
 supported_versions=
-yarn_mappings=1.21.9-rc1+build.2
+yarn_mappings=1.21.9+build.1
 enabled_platforms=fabric,neoforge
 
 archives_base_name=midnightlib
-mod_version=1.8.0
+mod_version=1.8.1
 maven_group=eu.midnightdust
 release_type=release
 curseforge_id=488090
 modrinth_id=codAaoxh
 
 fabric_loader_version=0.17.2
-fabric_api_version=0.133.13+1.21.9
+fabric_api_version=0.133.14+1.21.9
 
-neoforge_version=21.6.0-beta
+neoforge_version=21.9.3-beta
 yarn_mappings_patch_neoforge_version = 1.21+build.4
 
 mod_menu_version = 9.0.0

neoforge/src/main/java/eu/midnightdust/lib/util/neoforge/PlatformFunctionsImpl.java

@@ -22,7 +22,7 @@ public class PlatformFunctionsImpl {
         return FMLPaths.CONFIGDIR.get();
     }
     public static boolean isClientEnv() {
-        return FMLEnvironment.dist.isClient();
+        return FMLEnvironment.getDist().isClient();
     }
     public static boolean isModLoaded(String modid) {
         return ModList.get().isLoaded(modid);

neoforge/src/main/java/eu/midnightdust/neoforge/MidnightLibNeoForge.java

@@ -23,15 +23,15 @@ public class MidnightLibNeoForge {
     public static List<LiteralArgumentBuilder<ServerCommandSource>> commands = new ArrayList<>();
 
     public MidnightLibNeoForge() {
-        if (FMLEnvironment.dist == Dist.CLIENT) MidnightLib.onInitializeClient();
+        if (FMLEnvironment.getDist() == Dist.CLIENT) MidnightLib.onInitializeClient();
     }
 
-    @EventBusSubscriber(modid = "midnightlib", bus = EventBusSubscriber.Bus.MOD, value = Dist.CLIENT)
+    @EventBusSubscriber(modid = "midnightlib", value = Dist.CLIENT)
     public static class MidnightLibBusEvents {
         @SubscribeEvent
         public static void onPostInit(FMLClientSetupEvent event) {
             ModList.get().forEachModContainer((modid, modContainer) -> {
-                if (MidnightConfig.configClass.containsKey(modid) && !MidnightLib.hiddenMods.contains(modid)) {
+                if (MidnightConfig.configInstances.containsKey(modid) && !MidnightLib.hiddenMods.contains(modid)) {
                     modContainer.registerExtensionPoint(IConfigScreenFactory.class, (minecraftClient, screen) -> MidnightConfig.getScreen(screen, modid));
                 }
             });

settings.gradle

@@ -9,7 +9,7 @@ pluginManagement {
 
 include("common")
 include("fabric")
-//include("neoforge")
+include("neoforge")
 //include("quilt")
 
 rootProject.name = "midnightlib"