Simplified keybind isolation

Author: NotRyken

common/src/main/java/dev/terminalmc/clientsort/client/ClientSort.java

@@ -70,17 +70,13 @@ public static void afterConfigSaved(Config config) {
         InteractionManager.setTickRate(options.interactionInterval);
         // Update class cache
         PolicyManager.reloadPolicyClasses(options.classPolicies.keySet());
+        // Isolate keybinds
+        if (options().isolateKeybinds)
+            KeybindManager.isolateKeybinds();
     }
 
     public static void afterGameStart() {
-        if (options().isolateKeybinds) {
-            KeybindManager.configToKeybinds();
-        }
-    }
-
-    public static void afterKeyMapReset() {
-        if (!options().isolateKeybinds) {
-            KeybindManager.keybindsToConfig();
-        }
+        if (options().isolateKeybinds)
+            KeybindManager.isolateKeybinds();
     }
 }

common/src/main/java/dev/terminalmc/clientsort/client/config/Config.java

@@ -18,13 +18,10 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.mojang.blaze3d.platform.InputConstants;
-import com.mojang.blaze3d.platform.InputConstants.Type;
 import dev.terminalmc.clientsort.client.ClientSort;
 import dev.terminalmc.clientsort.client.config.legacy.ButtonLayout;
 import dev.terminalmc.clientsort.client.inventory.operator.Operation;
 import dev.terminalmc.clientsort.client.order.SortOrder;
-import dev.terminalmc.clientsort.client.util.KeybindManager;
 import dev.terminalmc.clientsort.platform.Services;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.player.Inventory;
@@ -179,30 +176,9 @@ public enum ExtraSlotScope {
 
         // Keybind options
 
-        public static final boolean isolateKeybindsDefault = false;
+        public static final boolean isolateKeybindsDefault = true;
         public boolean isolateKeybinds = isolateKeybindsDefault;
 
-        public static final String editKeyDefault = InputConstants.UNKNOWN.getName();
-        public String editKey = editKeyDefault;
-        public static Validator<String> editKeyValidator = (val) ->
-                KeybindManager.fromName(val).getName();
-
-        public static final String sortKeyDefault =
-                Type.MOUSE.getOrCreate(InputConstants.MOUSE_BUTTON_MIDDLE).getName();
-        public String sortKey = sortKeyDefault;
-        public static Validator<String> sortKeyValidator = (val) ->
-                KeybindManager.fromName(val).getName();
-
-        public static final String stackFillKeyDefault = InputConstants.UNKNOWN.getName();
-        public String stackFillKey = stackFillKeyDefault;
-        public static Validator<String> stackFillKeyValidator = (val) ->
-                KeybindManager.fromName(val).getName();
-
-        public static final String transferKeyDefault = InputConstants.UNKNOWN.getName();
-        public String transferKey = transferKeyDefault;
-        public static Validator<String> transferKeyValidator = (val) ->
-                KeybindManager.fromName(val).getName();
-
         // Button options
 
         public static final boolean showButtonsDefault = false;
@@ -431,14 +407,6 @@ private void validate() {
                 Options.soundPitchMaxValidator.validate(options.soundPitchMax, options);
         options.soundVolume =
                 Options.soundVolumeValidator.validate(options.soundVolume);
-        options.editKey =
-                Options.editKeyValidator.validate(options.editKey);
-        options.sortKey =
-                Options.sortKeyValidator.validate(options.sortKey);
-        options.stackFillKey =
-                Options.stackFillKeyValidator.validate(options.stackFillKey);
-        options.transferKey =
-                Options.transferKeyValidator.validate(options.transferKey);
         options.firstButtonOp =
                 Options.firstButtonOpValidator.validate(options.firstButtonOp, options);
         options.secondButtonOp =

common/src/main/java/dev/terminalmc/clientsort/client/gui/screen/config/ClothScreenProvider.java

@@ -312,51 +312,42 @@ else if (val > Config.Options.SOUND_VOLUME_MAX)
                 .setTooltip(localized("option", "isolateKeybinds.tooltip"))
                 .setDefaultValue(Config.Options.isolateKeybindsDefault)
                 .setSaveConsumer(val -> options.isolateKeybinds = val)
-                .requireRestart()
                 .build());
 
         keybinds.addEntry((eb.startKeyCodeField(
                         localized("key", "edit"),
                         ((KeyMappingAccessor) KeybindManager.EDIT_KEY).clientsort$getKey()
                 )
-                .setDefaultValue(KeybindManager.fromName(Options.editKeyDefault))
-                .setKeySaveConsumer((key) -> {
-                    KeybindManager.bindKey(KeybindManager.EDIT_KEY, key);
-                    options.editKey = key.getName();
-                })
+                .setDefaultValue(KeybindManager.EDIT_KEY.getDefaultKey())
+                .setKeySaveConsumer((key) ->
+                        KeybindManager.bindKey(KeybindManager.EDIT_KEY, key))
                 .build()));
 
         keybinds.addEntry((eb.startKeyCodeField(
                         localized("key", "op.sort"),
                         ((KeyMappingAccessor) KeybindManager.SORT_KEY).clientsort$getKey()
                 )
-                .setDefaultValue(KeybindManager.fromName(Options.sortKeyDefault))
-                .setKeySaveConsumer((key) -> {
-                    KeybindManager.bindKey(KeybindManager.SORT_KEY, key);
-                    options.sortKey = key.getName();
-                })
+                .setDefaultValue(KeybindManager.SORT_KEY.getDefaultKey())
+                .setKeySaveConsumer((key) ->
+                        KeybindManager.bindKey(KeybindManager.SORT_KEY, key))
                 .build()));
 
         keybinds.addEntry((eb.startKeyCodeField(
                         localized("key", "op.stackFill"),
                         ((KeyMappingAccessor) KeybindManager.STACK_FILL_KEY).clientsort$getKey()
                 )
-                .setDefaultValue(KeybindManager.fromName(Options.stackFillKeyDefault))
-                .setKeySaveConsumer((key) -> {
-                    KeybindManager.bindKey(KeybindManager.STACK_FILL_KEY, key);
-                    options.stackFillKey = key.getName();
-                })
+                .setDefaultValue(KeybindManager.STACK_FILL_KEY.getDefaultKey())
+                .setKeySaveConsumer((key) ->
+                        KeybindManager.bindKey(KeybindManager.STACK_FILL_KEY, key))
                 .build()));
 
         keybinds.addEntry((eb.startKeyCodeField(
                         localized("key", "op.transfer"),
                         ((KeyMappingAccessor) KeybindManager.TRANSFER_KEY).clientsort$getKey()
                 )
-                .setDefaultValue(KeybindManager.fromName(Options.transferKeyDefault))
-                .setKeySaveConsumer((key) -> {
-                    KeybindManager.bindKey(KeybindManager.TRANSFER_KEY, key);
-                    options.transferKey = key.getName();
-                })
+                .setDefaultValue(KeybindManager.TRANSFER_KEY.getDefaultKey())
+                .setKeySaveConsumer((key) ->
+                        KeybindManager.bindKey(KeybindManager.TRANSFER_KEY, key))
                 .build()));
 
         ConfigCategory buttons = builder.getOrCreateCategory(localized("option", "buttons"));

common/src/main/java/dev/terminalmc/clientsort/client/util/KeybindManager.java

@@ -17,30 +17,14 @@
 package dev.terminalmc.clientsort.client.util;
 
 import com.mojang.blaze3d.platform.InputConstants;
-import dev.terminalmc.clientsort.client.config.Config;
 import dev.terminalmc.clientsort.mixin.client.accessor.KeyMappingAccessor;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.client.Minecraft;
-import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 
-import static dev.terminalmc.clientsort.client.config.Config.options;
 import static dev.terminalmc.clientsort.util.Localization.translationKey;
 
-/**
- * To allow optionally isolating mod keybinds from MC keybinds, the value of all keybinds must be
- * synced between mod config and MC config.
- * <p>
- * If {@link Config.Options#isolateKeybinds} is {@code true}, the keybinds will be set initially
- * by MC when MC config is loaded. The mod config values will not be read at all.
- * <p>
- * If {@link Config.Options#isolateKeybinds} is {@code false}, keybinds will be set initially by
- * the mod after MC has finished loading. The mod config values will not be read again.
- * <p>
- * The mod config values are kept up-to-date with mod config changes by the CC option handers, and
- * with MC config changes by the {@link KeyMapping#resetMapping} listener.
- */
 public class KeybindManager {
 
     public static final KeyMapping EDIT_KEY = new KeyMapping(
@@ -75,55 +59,22 @@ public class KeybindManager {
     );
 
     /**
-     * Saves the keybind values to mod config.
+     * Attempts to remove all mod keybinds from the MC keybind maps.
+     * <p>
+     * Does not affect the MC keybind options list, since that references
+     * {@link net.minecraft.client.Options#keyMappings} which is (mostly) unrelated.
      */
-    public static void keybindsToConfig() {
-        options().editKey = toName(EDIT_KEY);
-        options().sortKey = toName(SORT_KEY);
-        options().stackFillKey = toName(STACK_FILL_KEY);
-        options().transferKey = toName(TRANSFER_KEY);
-        Config.save();
-    }
-
-    /**
-     * Loads the keybind values from mod config.
-     */
-    public static void configToKeybinds() {
-        EDIT_KEY.setKey(fromName(options().editKey));
-        SORT_KEY.setKey(fromName(options().sortKey));
-        STACK_FILL_KEY.setKey(fromName(options().stackFillKey));
-        TRANSFER_KEY.setKey(fromName(options().transferKey));
+    public static void isolateKeybinds() {
+        KEYBINDS.forEach((kb) -> KeyMappingAccessor.clientsort$getAll().remove(kb.getName()));
+        KeyMapping.resetMapping();
     }
 
     /**
      * Sets and saves the keybind. Does not affect mod config.
      */
     public static void bindKey(KeyMapping keybind, InputConstants.Key key) {
         keybind.setKey(key);
-        if (!options().isolateKeybinds) {
-            KeyMapping.resetMapping();
-            Minecraft.getInstance().options.save();
-        }
-    }
-
-    /**
-     * @return the name of the keybind's current key.
-     */
-    public static String toName(KeyMapping keybind) {
-        return ((KeyMappingAccessor) keybind).clientsort$getKey().getName();
-    }
-
-    /**
-     * @return the key identified by the name, or {@link InputConstants#UNKNOWN} if the name is
-     * invalid.
-     */
-    public static InputConstants.Key fromName(@Nullable String name) {
-        if (name == null)
-            return InputConstants.UNKNOWN;
-        try {
-            return InputConstants.getKey(name);
-        } catch (IllegalArgumentException e) {
-            return InputConstants.UNKNOWN;
-        }
+        KeyMapping.resetMapping();
+        Minecraft.getInstance().options.save();
     }
 }

common/src/main/java/dev/terminalmc/clientsort/mixin/client/KeyMappingMixin.java

@@ -21,9 +21,16 @@
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.gen.Accessor;
 
+import java.util.Map;
+
 @Mixin(KeyMapping.class)
 public interface KeyMappingAccessor {
 
+    @Accessor("ALL")
+    static Map<String, KeyMapping> clientsort$getAll() {
+        throw new UnsupportedOperationException();
+    }
+
     @Accessor("key")
     Key clientsort$getKey();
 }

common/src/main/java/dev/terminalmc/clientsort/mixin/client/accessor/KeyMappingAccessor.java

@@ -88,7 +88,7 @@
 
   "option.clientsort.keybinds": "Keybinds",
   "option.clientsort.isolateKeybinds": "Isolate Keybinds",
-  "option.clientsort.isolateKeybinds.tooltip": "If this is enabled, the keybinds will only be shown here and will not conflict with other keybinds outside of inventories. You must restart the game to apply changes to this option.",
+  "option.clientsort.isolateKeybinds.tooltip": "If this is enabled, ClientSort will attempt to remove its own keybinds from Minecraft's map. This may help prevent conflicts, but may not be compatible with mods that alter the keybind system.",
 
   "option.clientsort.buttons": "Buttons",
   "option.clientsort.showButtons": "Show Buttons",

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

@@ -88,7 +88,7 @@
 
   "option.clientsort.keybinds": "Keybinds",
   "option.clientsort.isolateKeybinds": "Isolate Keybinds",
-  "option.clientsort.isolateKeybinds.tooltip": "If this is enabled, the keybinds will only be shown here and will not conflict with other keybinds outside of inventories. You must restart the game to apply changes to this option.",
+  "option.clientsort.isolateKeybinds.tooltip": "If this is enabled, ClientSort will attempt to remove its own keybinds from Minecraft's map. This may help prevent conflicts, but may not be compatible with mods that alter the keybind system.",
 
   "option.clientsort.buttons": "Интерфейс",
   "option.clientsort.showButtons": "Показывать кнопки",

common/src/main/resources/assets/clientsort/lang/ru_ru.json

@@ -11,7 +11,6 @@
   "client": [
     "client.AbstractContainerScreenMixin",
     "client.ClientPacketListenerMixin",
-    "client.KeyMappingMixin",
     "client.LocalPlayerMixin",
     "client.MinecraftMixin",
     "client.accessor.AbstractContainerScreenAccessor",

common/src/main/resources/clientsort.mixins.json

@@ -25,16 +25,12 @@
 import net.fabricmc.fabric.api.client.screen.v1.ScreenEvents;
 import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
 
-import static dev.terminalmc.clientsort.client.config.Config.options;
-
 public class ClientSortFabric implements ClientModInitializer {
 
     @Override
     public void onInitializeClient() {
-        if (!options().isolateKeybinds) {
-            // Register all keybinds
-            KeybindManager.KEYBINDS.forEach(KeyBindingHelper::registerKeyBinding);
-        }
+        // Register all keybinds
+        KeybindManager.KEYBINDS.forEach(KeyBindingHelper::registerKeyBinding);
 
         // Register after-tick event
         ClientTickEvents.END_CLIENT_TICK.register(ClientSort::afterClientTick);