Implement hexical interop for telepathy and notebook in splicing table

object-Object · object-Object · commit 22acfbe4a90b · 2025-09-28T16:44:08.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ### Added
 
 - Added a new resource-pack-based data-driven system for addon devs to customize how their iotas are rendered in the Splicing Table.
+- Added Hexical interop to make the telepathy and notebook keys work in the Splicing/Mindsplice Table GUI.
 
 ### Changed
 
diff --git a/Common/src/main/java/gay/object/hexdebug/mixin/MixinScreen.java b/Common/src/main/java/gay/object/hexdebug/mixin/MixinScreen.java
@@ -0,0 +1,32 @@
+package gay.object.hexdebug.mixin;
+
+import gay.object.hexdebug.gui.IMixinScreen;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.screens.Screen;
+import org.jetbrains.annotations.Nullable;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Unique;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(Screen.class)
+public abstract class MixinScreen implements IMixinScreen {
+    @Unique
+    @Nullable
+    private Screen hexdebug$previousScreen = null;
+
+    @Override
+    public void hexdebug$setPreviousScreen(@Nullable Screen screen) {
+        hexdebug$previousScreen = screen;
+    }
+
+    @Inject(method = "onClose", at = @At("HEAD"), cancellable = true)
+    private void hexdebug$returnToPreviousScreen(CallbackInfo ci) {
+        if (hexdebug$previousScreen != null) {
+            Minecraft.getInstance().setScreen(hexdebug$previousScreen);
+            hexdebug$previousScreen = null;
+            ci.cancel();
+        }
+    }
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/HexDebugClientAbstractions.kt b/Common/src/main/kotlin/gay/object/hexdebug/HexDebugClientAbstractions.kt
@@ -4,10 +4,16 @@
 package gay.`object`.hexdebug
 
 import dev.architectury.injectables.annotations.ExpectPlatform
+import net.minecraft.client.Minecraft
 import net.minecraft.resources.ResourceLocation
 import net.minecraft.server.packs.resources.PreparableReloadListener
 
 @ExpectPlatform
 fun registerClientResourceReloadListener(id: ResourceLocation, listener: PreparableReloadListener) {
     throw AssertionError()
 }
+
+@ExpectPlatform
+fun sendHexicalKeyEvent(client: Minecraft, keyCode: Int, scanCode: Int, isPressed: Boolean) {
+    throw AssertionError()
+}
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugClientConfig.kt b/Common/src/main/kotlin/gay/object/hexdebug/config/HexDebugClientConfig.kt
@@ -108,6 +108,9 @@ object HexDebugClientConfig {
             @Tooltip
             val overrideVanillaArrowKeys = true
 
+            @Tooltip
+            val sendHexicalTelepathy = true
+
             val viewLeft = ConfigModifierKey(InputConstants.KEY_UP)
             val viewLeftPage = ConfigModifierKey(InputConstants.KEY_PAGEUP)
             val viewLeftFull = ConfigModifierKey(InputConstants.KEY_HOME)
diff --git a/Common/src/main/kotlin/gay/object/hexdebug/gui/IMixinScreen.kt b/Common/src/main/kotlin/gay/object/hexdebug/gui/IMixinScreen.kt
@@ -0,0 +1,11 @@
+package gay.`object`.hexdebug.gui
+
+import net.minecraft.client.gui.screens.Screen
+
+@Suppress("FunctionName")
+interface IMixinScreen {
+    fun `hexdebug$setPreviousScreen`(screen: Screen?)
+}
+
+@Suppress("CAST_NEVER_SUCCEEDS")
+val Screen.mixin get() = this as IMixinScreen
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
@@ -10,6 +10,7 @@ import gay.`object`.hexdebug.config.ConfigModifierKey
 import gay.`object`.hexdebug.config.HexDebugClientConfig
 import gay.`object`.hexdebug.config.HexDebugServerConfig
 import gay.`object`.hexdebug.gui.splicing.widgets.*
+import gay.`object`.hexdebug.sendHexicalKeyEvent
 import gay.`object`.hexdebug.splicing.IOTA_BUTTONS
 import gay.`object`.hexdebug.splicing.Selection
 import gay.`object`.hexdebug.splicing.SplicingTableAction
@@ -542,11 +543,17 @@ class SplicingTableScreen(
     }
 
     override fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean {
-        if (HexDebugClientConfig.config.splicingTableKeybinds.enabled) {
+        val keybinds = HexDebugClientConfig.config.splicingTableKeybinds
+
+        if (keybinds.enabled) {
+            if (keybinds.sendHexicalTelepathy) {
+                sendHexicalKeyEvent(minecraft!!, keyCode, scanCode, isPressed = true)
+            }
+
             // AbstractContainerScreen.keyPressed always returns true, so check our keys first
             if (keyPressedInner(keyCode, scanCode)) return true
 
-            if (HexDebugClientConfig.config.splicingTableKeybinds.overrideVanillaArrowKeys) {
+            if (keybinds.overrideVanillaArrowKeys) {
                 when (keyCode) {
                     GLFW.GLFW_KEY_UP,
                     GLFW.GLFW_KEY_DOWN,
@@ -588,6 +595,14 @@ class SplicingTableScreen(
         minecraft!!.soundManager.play(SimpleSoundInstance.forUI(SoundEvents.UI_BUTTON_CLICK, 1f))
     }
 
+    override fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean {
+        val keybinds = HexDebugClientConfig.config.splicingTableKeybinds
+        if (keybinds.enabled && keybinds.sendHexicalTelepathy) {
+            sendHexicalKeyEvent(minecraft!!, keyCode, scanCode, isPressed = false)
+        }
+        return super.keyReleased(keyCode, scanCode, modifiers)
+    }
+
     // 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/resources/assets/hexdebug/lang/en_us.flatten.json5 b/Common/src/main/resources/assets/hexdebug/lang/en_us.flatten.json5
@@ -109,6 +109,10 @@
               "": "Override Vanilla Arrow Key Navigation",
               "@Tooltip": "In the Splicing Table GUI, override the vanilla feature that allows the arrow keys to be used to focus on UI elements. This setting improves usability with the default keybinds, but you may want to disable it if you rely on this feature for accessibility purposes.",
             },
+            sendHexicalTelepathy: {
+              "": "Enable Hexical Telepathy",
+              "@Tooltip": "Fabric-only. If Hexical is installed, enable all telepathy keys in the Splicing Table GUI. Note: If Hexical adds its own support for using telepathy in GUIs, disabling this feature will not disable that.",
+            },
             enlightened: {
               "": "Mindsplice Table",
               "@Tooltip": "Keybinds for actions in the Mindsplice Table GUI.",
diff --git a/Common/src/main/resources/hexdebug-common.mixins.json b/Common/src/main/resources/hexdebug-common.mixins.json
@@ -5,6 +5,7 @@
   "minVersion": "0.8",
   "client": [
     "MixinGuiSpellcasting",
+    "MixinScreen",
     "MixinShiftScrollListener"
   ],
   "mixins": [
diff --git a/Fabric/build.gradle.kts b/Fabric/build.gradle.kts
@@ -67,7 +67,7 @@ dependencies {
         exclude(module = "phosphor")
     }
     modLocalRuntime(libs.paucal.fabric)
-    modLocalRuntime(libs.patchouli.fabric)
+    modImplementation(libs.patchouli.fabric)
     modLocalRuntime(libs.cardinalComponents)
     modLocalRuntime(libs.serializationHooks)
     modLocalRuntime(libs.trinkets)
@@ -99,6 +99,10 @@ dependencies {
     modApi(libs.ioticblocks.fabric)
 
     modImplementation(libs.emi.fabric)
+
+    modImplementation(libs.hexical)
+    modLocalRuntime(libs.hexpose) { isTransitive = false }
+    modLocalRuntime(libs.playerAnimator.fabric)
 }
 
 publishMods {
diff --git a/Fabric/src/main/kotlin/gay/object/hexdebug/fabric/HexDebugClientAbstractionsImpl.kt b/Fabric/src/main/kotlin/gay/object/hexdebug/fabric/HexDebugClientAbstractionsImpl.kt
@@ -2,8 +2,11 @@
 
 package gay.`object`.hexdebug.fabric
 
+import gay.`object`.hexdebug.fabric.interop.FabricHexDebugHexicalInterop
 import net.fabricmc.fabric.api.resource.IdentifiableResourceReloadListener
 import net.fabricmc.fabric.api.resource.ResourceManagerHelper
+import net.fabricmc.loader.api.FabricLoader
+import net.minecraft.client.Minecraft
 import net.minecraft.resources.ResourceLocation
 import net.minecraft.server.packs.PackType
 import net.minecraft.server.packs.resources.PreparableReloadListener
@@ -30,3 +33,9 @@ fun registerClientResourceReloadListener(id: ResourceLocation, listener: Prepara
         }
     )
 }
+
+fun sendHexicalKeyEvent(client: Minecraft, keyCode: Int, scanCode: Int, isPressed: Boolean) {
+    if (FabricLoader.getInstance().isModLoaded("hexical")) {
+        FabricHexDebugHexicalInterop.sendKeyEvent(client, keyCode, scanCode, isPressed)
+    }
+}
diff --git a/Fabric/src/main/kotlin/gay/object/hexdebug/fabric/interop/FabricHexDebugHexicalInterop.kt b/Fabric/src/main/kotlin/gay/object/hexdebug/fabric/interop/FabricHexDebugHexicalInterop.kt
@@ -0,0 +1,61 @@
+package gay.`object`.hexdebug.fabric.interop
+
+import at.petrak.hexcasting.api.HexAPI
+import gay.`object`.hexdebug.gui.mixin
+import miyucomics.hexical.features.telepathy.ServerPeripheralReceiver
+import miyucomics.hexical.inits.HexicalKeybinds
+import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking
+import net.fabricmc.fabric.api.networking.v1.PacketByteBufs
+import net.minecraft.client.KeyMapping
+import net.minecraft.client.Minecraft
+import vazkii.patchouli.api.PatchouliAPI
+
+object FabricHexDebugHexicalInterop {
+    private val previousState = mutableMapOf<String, Boolean>()
+
+    fun sendKeyEvent(client: Minecraft, keyCode: Int, scanCode: Int, isPressed: Boolean) {
+        if (client.player == null) return
+
+        // open the notebook gui
+
+        if (HexicalKeybinds.OPEN_HEXBOOK.matches(keyCode, scanCode)) {
+            val previousScreen = client.screen
+            PatchouliAPI.get().openBookGUI(HexAPI.modLoc("thehexbook"))
+            client.screen?.mixin?.`hexdebug$setPreviousScreen`(previousScreen)
+        }
+
+        // send telepathy packets as a workaround for telepathy not working in GUIs
+        // https://github.com/miyucomics/hexical/blob/fbcbb09547bcb63da892a7ed2568960e7f126234/src/client/java/miyucomics/hexical/features/telepathy/ClientPeripheralPusher.kt#L15
+
+        val key = getTelepathyKey(client, keyCode, scanCode) ?: return
+
+        if (previousState[key.name] != isPressed) {
+            previousState[key.name] = isPressed
+            val channel = when (isPressed) {
+                true -> ServerPeripheralReceiver.PRESSED_KEY_CHANNEL
+                false -> ServerPeripheralReceiver.RELEASED_KEY_CHANNEL
+            }
+            ClientPlayNetworking.send(channel, PacketByteBufs.create().also { it.writeUtf(key.name) })
+        }
+    }
+
+    private fun getTelepathyKey(client: Minecraft, keyCode: Int, scanCode: Int): KeyMapping? {
+        for (key in arrayOf(
+            client.options.keyUp,
+            client.options.keyLeft,
+            client.options.keyRight,
+            client.options.keyDown,
+            client.options.keyJump,
+            client.options.keyShift,
+            client.options.keyUse,
+            client.options.keyAttack,
+            HexicalKeybinds.TELEPATHY_KEYBIND,
+            // omitted evocation
+        )) {
+            if (key.matches(keyCode, scanCode)) {
+                return key
+            }
+        }
+        return null
+    }
+}
diff --git a/Fabric/src/main/resources/fabric.mod.json b/Fabric/src/main/resources/fabric.mod.json
@@ -55,6 +55,7 @@
   },
   "suggests": {
     "emi": ">=${versions.emi}",
-    "modmenu": ">=${versions.modMenu}"
+    "modmenu": ">=${versions.modMenu}",
+    "hexical": ">=${versions.hexical_dependency}"
   }
 }
diff --git a/Forge/src/main/kotlin/gay/object/hexdebug/forge/HexDebugClientAbstractionsImpl.kt b/Forge/src/main/kotlin/gay/object/hexdebug/forge/HexDebugClientAbstractionsImpl.kt
@@ -1,7 +1,9 @@
 @file:JvmName("HexDebugClientAbstractionsImpl")
+@file:Suppress("UNUSED_PARAMETER")
 
 package gay.`object`.hexdebug.forge
 
+import net.minecraft.client.Minecraft
 import net.minecraft.resources.ResourceLocation
 import net.minecraft.server.packs.resources.PreparableReloadListener
 import net.minecraftforge.client.event.RegisterClientReloadListenersEvent
@@ -12,3 +14,5 @@ fun registerClientResourceReloadListener(id: ResourceLocation, listener: Prepara
         event.registerReloadListener(listener)
     }
 }
+
+fun sendHexicalKeyEvent(client: Minecraft, keyCode: Int, scanCode: Int, isPressed: Boolean) {}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -14,7 +14,7 @@ architectury = "9.2.14"
 architectury-plugin = { require="[3.4, 3.5[" }
 architectury-loom = { require="[1.7, 1.8[" }
 
-fabric-loader = "0.14.21"
+fabric-loader = "0.16.7"
 fabric-api = "0.85.0+1.20.1"
 
 forge = "1.20.1-47.2.0"
@@ -42,6 +42,10 @@ devAuth = "1.2.0"
 inline = "1.20.1-1.0.1"
 ioticblocks = "1.0.0+1.20.1"
 emi = "1.1.22+1.20.1"
+hexical = "2.0.0-e0d7ef9"
+hexical-dependency = "2.0.0"
+hexpose = "1.0.0"
+playerAnimator = "1.0.2-rc1+1.20"
 
 # other non-Minecraft dependencies
 
@@ -118,6 +122,12 @@ emi-xplat  = { module="dev.emi:emi-xplat-intermediary", version.ref="emi" }
 emi-fabric = { module="dev.emi:emi-fabric", version.ref="emi" }
 emi-forge  = { module="dev.emi:emi-forge", version.ref="emi" }
 
+hexical = { module="libs:hexical", version.ref="hexical" }
+
+hexpose = { module = "miyucomics.hexpose:hexpose", version.ref="hexpose" }
+
+playerAnimator-fabric = { module="dev.kosmx.player-anim:player-animation-lib-fabric", version.ref="playerAnimator" }
+
 findbugs-jsr305 = { module="com.google.code.findbugs:jsr305", version.ref="findbugs-jsr305" }
 
 asm          = { module="org.ow2.asm:asm", version.ref="asm" }
diff --git a/libs/hexical-2.0.0-e0d7ef9.jar b/libs/hexical-2.0.0-e0d7ef9.jar
diff --git a/plugins/src/main/kotlin/hexdebug/conventions/kotlin.gradle.kts b/plugins/src/main/kotlin/hexdebug/conventions/kotlin.gradle.kts
@@ -27,6 +27,7 @@ repositories {
     maven { url = uri("https://dl.cloudsmith.io/public/geckolib3/geckolib/maven") }
     maven { url = uri("https://maven.parchmentmc.org") }
     maven { url = uri("https://pkgs.dev.azure.com/djtheredstoner/DevAuth/_packaging/public/maven/v1") }
+    maven { url = uri("https://maven.kosmx.dev/") }
     exclusiveContent {
         forRepository {
             maven { url = uri("https://api.modrinth.com/maven") }

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,11 @@`
`2`	`2`
`3`	`3`	package gay.`object`.hexdebug.fabric
`4`	`4`
	`5`	+import gay.`object`.hexdebug.fabric.interop.FabricHexDebugHexicalInterop
`5`	`6`	`import net.fabricmc.fabric.api.resource.IdentifiableResourceReloadListener`
`6`	`7`	`import net.fabricmc.fabric.api.resource.ResourceManagerHelper`
	`8`	`+import net.fabricmc.loader.api.FabricLoader`
	`9`	`+import net.minecraft.client.Minecraft`
`7`	`10`	`import net.minecraft.resources.ResourceLocation`
`8`	`11`	`import net.minecraft.server.packs.PackType`
`9`	`12`	`import net.minecraft.server.packs.resources.PreparableReloadListener`
`@@ -30,3 +33,9 @@ fun registerClientResourceReloadListener(id: ResourceLocation, listener: Prepara`
`30`	`33`	`}`
`31`	`34`	`)`
`32`	`35`	`}`
	`36`	`+`
	`37`	`+fun sendHexicalKeyEvent(client: Minecraft, keyCode: Int, scanCode: Int, isPressed: Boolean) {`
	`38`	`+ if (FabricLoader.getInstance().isModLoaded("hexical")) {`
	`39`	`+ FabricHexDebugHexicalInterop.sendKeyEvent(client, keyCode, scanCode, isPressed)`
	`40`	`+ }`
	`41`	`+}`