Implement splicing table keyboard shortcuts

object-Object · object-Object · commit a45941eae5c9 · 2025-09-21T20:42:11.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## [UNRELEASED]
 
+### Added
+
+- Added keyboard shortcuts to the Splicing Table, configurable in HexDebug's client config menu.
+
 ### Fixed
 
 - Fixed an issue where newly placed splicing tables would default to having the first iota selected.
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/HexDebugMixinConfigPlugin.java b/Common/src/main/java/gay/object/hexdebug/mixin/HexDebugMixinConfigPlugin.java
@@ -1,5 +1,6 @@
 package gay.object.hexdebug.mixin;
 
+import dev.architectury.platform.Platform;
 import gay.object.hexdebug.HexDebug;
 import org.objectweb.asm.tree.ClassNode;
 import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin;
@@ -27,6 +28,10 @@ public boolean shouldApplyMixin(String targetClassName, String mixinClassName) {
             }
             return shouldApply;
         }
+        if (mixinClassName.startsWith("gay.object.hexdebug.mixin.interop.")) {
+            var id = mixinClassName.substring("gay.object.hexdebug.mixin.interop.".length()).split("\\.", 2)[0];
+            return Platform.isModLoaded(id);
+        }
         return true;
     }
 
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/interop/emi/MixinEmiScreenManager.java b/Common/src/main/java/gay/object/hexdebug/mixin/interop/emi/MixinEmiScreenManager.java
@@ -0,0 +1,24 @@
+package gay.object.hexdebug.mixin.interop.emi;
+
+import com.llamalad7.mixinextras.expression.Definition;
+import com.llamalad7.mixinextras.expression.Expression;
+import com.llamalad7.mixinextras.injector.ModifyExpressionValue;
+import com.llamalad7.mixinextras.sugar.Local;
+import dev.emi.emi.screen.EmiScreenManager;
+import gay.object.hexdebug.gui.splicing.SplicingTableScreen;
+import net.minecraft.client.Minecraft;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+@Mixin(value = EmiScreenManager.class, remap = false)
+public abstract class MixinEmiScreenManager {
+    @Definition(id = "keyCode", local = @Local(name = "keyCode", type = int.class))
+    @Expression("keyCode == 89")
+    @ModifyExpressionValue(method = "keyPressed", at = @At(value = "MIXINEXTRAS:EXPRESSION"), require = 0)
+    private static boolean hexdebug$cancelHardcodedKeybindInSplicingTable(boolean original) {
+        if (Minecraft.getInstance().screen instanceof SplicingTableScreen) {
+            return false;
+        }
+        return original;
+    }
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugClientConfig.kt b/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugClientConfig.kt
@@ -1,16 +1,23 @@
 package gay.`object`.hexdebug.config
 
+import at.petrak.hexcasting.api.utils.asTranslatedComponent
+import com.mojang.blaze3d.platform.InputConstants
 import gay.`object`.hexdebug.HexDebug
+import gay.`object`.hexdebug.gui.splicing.SplicingTableScreen
 import me.shedaniel.autoconfig.AutoConfig
 import me.shedaniel.autoconfig.ConfigData
 import me.shedaniel.autoconfig.ConfigHolder
 import me.shedaniel.autoconfig.annotation.Config
 import me.shedaniel.autoconfig.annotation.ConfigEntry.Category
-import me.shedaniel.autoconfig.annotation.ConfigEntry.Gui.Tooltip
-import me.shedaniel.autoconfig.annotation.ConfigEntry.Gui.TransitiveObject
+import me.shedaniel.autoconfig.annotation.ConfigEntry.Gui.*
 import me.shedaniel.autoconfig.serializer.PartitioningSerializer
 import me.shedaniel.autoconfig.serializer.PartitioningSerializer.GlobalData
 import me.shedaniel.autoconfig.serializer.Toml4jConfigSerializer
+import me.shedaniel.autoconfig.util.Utils.getUnsafely
+import me.shedaniel.autoconfig.util.Utils.setUnsafely
+import me.shedaniel.clothconfig2.api.ConfigEntryBuilder
+import me.shedaniel.clothconfig2.api.Modifier
+import me.shedaniel.clothconfig2.api.ModifierKeyCode
 import net.minecraft.world.InteractionResult
 
 object HexDebugClientConfig {
@@ -21,6 +28,30 @@ object HexDebugClientConfig {
     val config get() = holder.config.client
 
     fun init() {
+        AutoConfig.getGuiRegistry(GlobalConfig::class.java).apply {
+            val entryBuilder = ConfigEntryBuilder.create()
+
+            // ModifierKeyCode
+            registerTypeProvider(
+                { i18n, field, config, defaults, _ -> listOf(
+                    entryBuilder.startModifierKeyCodeField(
+                        when (config) {
+                            is ClientConfig.SplicingTableKeybinds,
+                            is ClientConfig.EnlightenedSplicingTableKeybinds -> {
+                                SplicingTableScreen.buttonText(field.name.camelToSnakeCase())
+                            }
+                            else -> i18n.asTranslatedComponent
+                        },
+                        getUnsafely(field, config, ConfigModifierKey(InputConstants.UNKNOWN.name)).inner,
+                    )
+                        .setModifierDefaultValue { (getUnsafely(field, defaults) as ConfigModifierKey).inner }
+                        .setModifierSaveConsumer { setUnsafely(field, config, ConfigModifierKey(it)) }
+                        .build()
+                ) },
+                ConfigModifierKey::class.java,
+            )
+        }
+
         holder = AutoConfig.register(
             GlobalConfig::class.java,
             PartitioningSerializer.wrap(::Toml4jConfigSerializer),
@@ -63,11 +94,82 @@ object HexDebugClientConfig {
 
         @Tooltip
         val invertSplicingTableScrollDirection: Boolean = false
+
+        @Tooltip
+        @CollapsibleObject
+        val splicingTableKeybinds = SplicingTableKeybinds()
+
+        @Tooltip
+        @CollapsibleObject
+        val enlightenedSplicingTableKeybinds = EnlightenedSplicingTableKeybinds()
+
+        class SplicingTableKeybinds {
+            val selectNone = ConfigModifierKey(InputConstants.KEY_A, ctrl = true, shift = true)
+            val selectAll = ConfigModifierKey(InputConstants.KEY_A, ctrl = true)
+            val undo = ConfigModifierKey(InputConstants.KEY_Z, ctrl = true)
+            val redo = ConfigModifierKey(InputConstants.KEY_Y, ctrl = true)
+            val nudgeLeft = ConfigModifierKey(InputConstants.KEY_LEFT, ctrl = true)
+            val nudgeRight = ConfigModifierKey(InputConstants.KEY_RIGHT, ctrl = true)
+            val duplicate = ConfigModifierKey(InputConstants.KEY_D, ctrl = true)
+            val delete = ConfigModifierKey(InputConstants.KEY_DELETE)
+            val cut = ConfigModifierKey(InputConstants.KEY_X, ctrl = true)
+            val copy = ConfigModifierKey(InputConstants.KEY_C, ctrl = true)
+            val pasteSplat = ConfigModifierKey(InputConstants.KEY_V, ctrl = true)
+            val pasteVerbatim = ConfigModifierKey(InputConstants.KEY_V, ctrl = true, shift = true)
+        }
+
+        class EnlightenedSplicingTableKeybinds {
+            val cast = ConfigModifierKey(InputConstants.KEY_RETURN, ctrl = true)
+        }
     }
 }
 
 enum class DebuggerDisplayMode {
     DISABLED,
     NOT_CONNECTED,
     ENABLED,
-}
+}
+
+// NOTE: this must have a no-arg constructor
+// otherwise, Gson uses unsafe allocation to construct it, which breaks the lazy property
+data class ConfigModifierKey(
+    val key: String = InputConstants.UNKNOWN.name,
+    val alt: Boolean = false,
+    val ctrl: Boolean = false,
+    val shift: Boolean = false,
+) {
+    constructor(
+        keyCode: Int,
+        alt: Boolean = false,
+        ctrl: Boolean = false,
+        shift: Boolean = false,
+    ) : this(
+        key = InputConstants.Type.KEYSYM.getOrCreate(keyCode).name,
+        alt = alt,
+        ctrl = ctrl,
+        shift = shift,
+    )
+
+    constructor(inner: ModifierKeyCode) : this(
+        key = inner.keyCode.name,
+        alt = inner.modifier.hasAlt(),
+        ctrl = inner.modifier.hasControl(),
+        shift = inner.modifier.hasShift(),
+    )
+
+    // transient to make Gson and Toml4j ignore the backing field
+    @delegate:Transient
+    val inner: ModifierKeyCode by lazy {
+        ModifierKeyCode.of(
+            InputConstants.getKey(key),
+            Modifier.of(alt, ctrl, shift),
+        )
+    }
+
+    fun matchesKey(keyCode: Int, scanCode: Int) = inner.matchesKey(keyCode, scanCode)
+}
+
+// https://stackoverflow.com/a/60010299
+private val camelRegex = "(?<=[a-zA-Z])[A-Z]".toRegex()
+
+private fun String.camelToSnakeCase() = replace(camelRegex) { "_${it.value}" }.lowercase()
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/gui/splicing/SplicingTableScreen.kt b/Common/src/main/kotlin/gay/object/hexdebug/gui/splicing/SplicingTableScreen.kt
@@ -21,7 +21,9 @@ import net.minecraft.client.gui.components.AbstractButton
 import net.minecraft.client.gui.components.Renderable
 import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen
 import net.minecraft.client.renderer.RenderType
+import net.minecraft.client.resources.sounds.SimpleSoundInstance
 import net.minecraft.network.chat.Component
+import net.minecraft.sounds.SoundEvents
 import net.minecraft.world.InteractionHand
 import net.minecraft.world.entity.player.Inventory
 import java.awt.Color
@@ -120,6 +122,8 @@ class SplicingTableScreen(
 
     private var castingCooldown = 0
 
+    private val canCastIgnoringCooldown get() = data.isEnlightened && data.hasHex && hasMediaForAction
+
     override fun init() {
         super.init()
 
@@ -332,7 +336,7 @@ class SplicingTableScreen(
 
             *listOf(
                 SplicingTableAction.PASTE_SPLAT to false,
-                SplicingTableAction.PASTE to true,
+                SplicingTableAction.PASTE_VERBATIM to true,
             ).map { (action, needsShiftDown) ->
                 object : SpriteButton(
                     x = leftPos + 27,
@@ -392,8 +396,6 @@ class SplicingTableScreen(
                     castingCooldown = maxCastingCooldown
                 },
             ) {
-                private val canCastIgnoringCooldown get() = data.hasHex && hasMediaForAction
-
                 override val uOffsetHovered get() = uOffset
                 override val vOffsetHovered get() = vOffset + 32
 
@@ -535,13 +537,53 @@ class SplicingTableScreen(
     }
 
     override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean {
-        if (super.keyPressed(keyCode, scanCode, modifiers)) return true
+        // AbstractContainerScreen.keyPressed always returns true, so check our keys first
+        if (keyPressedInner(keyCode, scanCode)) return true
+        return super.keyPressed(keyCode, scanCode, modifiers)
+    }
 
+    private fun keyPressedInner(keyCode: Int, scanCode: Int): Boolean {
+        if (
+            HexDebugClientConfig.config.enlightenedSplicingTableKeybinds.cast.matchesKey(keyCode, scanCode)
+            && canCastIgnoringCooldown
+            && castingCooldown <= 0
+        ) {
+            menu.table.castHex(null)
+            castingCooldown = maxCastingCooldown
+            playButtonClick()
+            return true
+        }
 
+        val action = HexDebugClientConfig.config.splicingTableKeybinds.run {
+            when {
+                selectNone.matchesKey(keyCode, scanCode) -> SplicingTableAction.SELECT_NONE
+                selectAll.matchesKey(keyCode, scanCode) -> SplicingTableAction.SELECT_ALL
+                undo.matchesKey(keyCode, scanCode) -> SplicingTableAction.UNDO
+                redo.matchesKey(keyCode, scanCode) -> SplicingTableAction.REDO
+                nudgeLeft.matchesKey(keyCode, scanCode) -> SplicingTableAction.NUDGE_LEFT
+                nudgeRight.matchesKey(keyCode, scanCode) -> SplicingTableAction.NUDGE_RIGHT
+                duplicate.matchesKey(keyCode, scanCode) -> SplicingTableAction.DUPLICATE
+                delete.matchesKey(keyCode, scanCode) -> SplicingTableAction.DELETE
+                cut.matchesKey(keyCode, scanCode) -> SplicingTableAction.CUT
+                copy.matchesKey(keyCode, scanCode) -> SplicingTableAction.COPY
+                pasteSplat.matchesKey(keyCode, scanCode) -> SplicingTableAction.PASTE_SPLAT
+                pasteVerbatim.matchesKey(keyCode, scanCode) -> SplicingTableAction.PASTE_VERBATIM
+                else -> return false
+            }
+        }
 
+        if (data.isListReadable && action.test()) {
+            action.onPress()
+            playButtonClick()
+            return true
+        }
         return false
     }
 
+    private fun playButtonClick() {
+        minecraft!!.soundManager.play(SimpleSoundInstance.forUI(SoundEvents.UI_BUTTON_CLICK, 1f))
+    }
+
     // TODO: limit scroll to certain regions? (let's see if anyone complains first)
     override fun mouseScrolled(mouseX: Double, mouseY: Double, delta: Double): Boolean {
         if (super.mouseScrolled(mouseX, mouseY, delta)) return true
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/splicing/SplicingTableAction.kt b/Common/src/main/kotlin/gay/object/hexdebug/splicing/SplicingTableAction.kt
@@ -194,7 +194,7 @@ enum class SplicingTableAction(val value: Value<*>) {
 
     // rw list, read clipboard
 
-    PASTE(Value(ReadWriteListFromClipboard, consumesMedia = true) {
+    PASTE_VERBATIM(Value(ReadWriteListFromClipboard, consumesMedia = true) {
         typedSelection.mutableSubList(list).apply {
             clear()
             add(clipboard)
diff --git a/Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5 b/Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5
@@ -39,7 +39,7 @@
           redo: "Redo",
           cut: "Cut",
           copy: "Copy",
-          paste: "Paste (Verbatim)",
+          paste_verbatim: "Paste (Verbatim)",
           paste_splat: "Paste (Flattened)",
           export: "Export as .hexpattern",
           cast: "Activate Table",
@@ -87,7 +87,15 @@
           invertSplicingTableScrollDirection: {
             "": "Invert Splicing Table Scroll Direction",
             "@Tooltip": "Whether scrolling up (as opposed to down) will increase the view index of the splicing table, and vice versa.",
-          }
+          },
+          splicingTableKeybinds: {
+            "": "Splicing Table Keybinds",
+            "@Tooltip": "Keybinds for actions in the Splicing Table GUI.",
+          },
+          enlightenedSplicingTableKeybinds: {
+            "": "Mindsplice Table Keybinds",
+            "@Tooltip": "Keybinds for actions in the Mindsplice Table GUI.",
+          },
         },
         server: {
           maxUndoStackSize: {
diff --git a/Common/src/main/resources/assets/hexdebug/lang/ru_ru.flatten.json5 b/Common/src/main/resources/assets/hexdebug/lang/ru_ru.flatten.json5
@@ -34,7 +34,7 @@
           redo: "Вернуть",
           cut: "Вырезать",
           copy: "Копировать",
-          paste: "Вставить (Полный)",
+          paste_verbatim: "Вставить (Полный)",
           paste_splat: "Вставить (Плоский)",
           export: "Экспортировать как .hexpattern",
         },
diff --git a/Common/src/main/resources/assets/hexdebug/lang/zh_cn.flatten.json5 b/Common/src/main/resources/assets/hexdebug/lang/zh_cn.flatten.json5
@@ -39,7 +39,7 @@
           redo: "重做",
           cut: "剪切",
           copy: "复制",
-          paste: "粘贴（逐项）",
+          paste_verbatim: "粘贴（逐项）",
           paste_splat: "粘贴（扁平化）",
           export: "导出为.hexpattern文件",
           cast: "激活编辑台",
diff --git a/Common/src/main/resources/hexdebug-common.mixins.json b/Common/src/main/resources/hexdebug-common.mixins.json
@@ -13,10 +13,11 @@
     "MixinOpEval",
     "MixinOpImpetusDir",
     "MixinOpImpetusPos",
-    "MixinStaffCastEnv"
+    "MixinStaffCastEnv",
+    "interop.emi.MixinEmiScreenManager"
   ],
   "plugin": "gay.object.hexdebug.mixin.HexDebugMixinConfigPlugin",
-  "injectors": {
-    "defaultRequire": 1
+  "mixinextras": {
+    "minVersion": "0.5.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package gay.object.hexdebug.mixin;`
`2`	`2`
	`3`	`+import dev.architectury.platform.Platform;`
`3`	`4`	`import gay.object.hexdebug.HexDebug;`
`4`	`5`	`import org.objectweb.asm.tree.ClassNode;`
`5`	`6`	`import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin;`
`@@ -27,6 +28,10 @@ public boolean shouldApplyMixin(String targetClassName, String mixinClassName) {`
`27`	`28`	`}`
`28`	`29`	`return shouldApply;`
`29`	`30`	`}`
	`31`	`+ if (mixinClassName.startsWith("gay.object.hexdebug.mixin.interop.")) {`
	`32`	`+ var id = mixinClassName.substring("gay.object.hexdebug.mixin.interop.".length()).split("\\.", 2)[0];`
	`33`	`+ return Platform.isModLoaded(id);`
	`34`	`+ }`
`30`	`35`	`return true;`
`31`	`36`	`}`
`32`	`37`