Merge branch 'multiversion/dev' into feature/splitscreen

# Conflicts:
#	src/main/java/dev/isxander/controlify/api/bind/InputBinding.java
#	src/main/java/dev/isxander/controlify/config/ControlifyConfig.java
#	src/main/java/dev/isxander/controlify/config/TypeAdapters.java
#	src/main/java/dev/isxander/controlify/controller/info/UIDComponent.java
#	src/main/java/dev/isxander/controlify/controller/input/InputComponent.java
#	src/main/java/dev/isxander/controlify/controllermanager/AbstractControllerManager.java
#	stonecutter.gradle.kts
#	versions/1.21.5-fabric/gradle.properties

Author: isXander

.github/README.md

@@ -25,54 +25,48 @@ Controlify Splitscreen is a **separate mod in development** that adds splitscree
 
 ![splitscreen demo](https://cdn.modrinth.com/data/cached_images/23ac6e3fc051e7aaa473ef3af2c510399d9448cc.png)
 
-## What is Controlify?
-
-Controlify is a mod that adds the best controller support to Minecraft: Java Edition. It aims to meet (or exceed) a console-like experience with support for as many controllers as possible, including their advanced features, such as vibration (rumble), gyro, HD haptics and vendor-specific buttons (like mute).
-
-## Why Controlify?
-
-### User friendly
-
-Despite advanced settings available for power users, Controlify is beginner-friendly. It comes by default with
-button guides that appear across the whole game, helping you learn the controller layout. It also automatically detects
-your controller's make and model, displaying relevant Minecraft-style button textures for a more intuitive experience.
-Controlify "just works" out of the box, no need to spend tens of minutes getting your controller feeling like any other
-game, thanks to the sane defaults I have created.
-
-### Feature-rich
+## [Wiki](https://moddedmc.wiki/project/controlify)
 
-Controlify strives to support all the added features that may come with your controller.
+Read up on the [Controlify Wiki](https://moddedmc.wiki/project/controlify) for more information on how to use Controlify, how to configure it, and how to develop for it.
 
-- It supports gyroscopes natively, allowing for precise movements.
-- It comes with vibration/rumble support, making your gameplay more immersive (this is even missing on Bedrock Edition!)
-- Soon, HD haptics support for DualSense controllers, something never seen outside a Playstation game.
-- Support for non-standard joysticks such as flight sticks, given a small amount of setup.
+## What is Controlify?
 
-### Compatibility focus
+Controlify is the best controller support mod for Minecraft: Java Edition. It exceeds the first-party Bedrock Edition controller support in every way possible. It is feature-complete, with support for vibration, gyroscope, HD haptics, and more.
 
-I, the developer have actively collaborated with fellow mod creators of performance mods like Sodium and Iris to
-ensure seamless controller functionality throughout these custom GUIs. This will mean a more friction-free environment
-that lets you focus on playing the game, instead of battling through the menus.
+Controlify supports *all* controllers, thanks to its usage of the [SDL3](https://libsdl.org/) library, which is the most advanced cross-platform input library available. 
 
-## Q&A
+Controlify is designed to be both user-friendly and feature-rich. It has sensible defaults, with default sensitivity matched to Bedrock Edition for easy transition, and a simple yet informative settings screen that allows you to tweak your experience to your liking.
 
-### Does it support Steam Deck?
+## Feature overview
 
-**Yes!** Controlify has been tested and is fully working on the Steam Deck, and works great.
-However, due to limitations with SteamOS, only Steam games can currently interface with the gyroscope and the
-back buttons directly, though [this is set to change in the coming months](https://github.com/libsdl-org/SDL/issues/9148)!
-For now, you can use Steam Input to convert the gyro into a mouse input, and map the back buttons to other, more common
-buttons.
+- **Vibration support**; Controlify vibrates your controller upon events such as taking damage, breaking blocks, lightning strikes.
+- **Gyroscope support**; Controlify can use the gyroscope in your controller for precise aiming.
+- **Vendor-specific input support**; Controlify supports reading paddles, mute buttons (and their LEDs), touchpads, and more, on some controllers including Xbox, DualSense and Steam Deck.
+- **GUI operation**: Controlify allows you to navigate all Minecraft GUIs with your controller, without needing a mouse or keyboard. This includes the inventory, out-of-game menus, and modded GUIs. It features cursor snapping in inventory screens, allowing you to use your controller without needing to be precise with your cursor movements.
+- **DualSense/DualShock support**; Controlify does not require any additional software for PlayStation controllers, even on Windows.
+- **Controller identification**; Controlify has bespoke button glyphs for many controller models, including Xbox, Playstation, Nintendo Switch, Steam Deck, and more.
+- **On-screen keyboard**; Controlify includes a fully functional on-screen keyboard that allows you to type with your controller - truly no keyboard needed!
+- **Radial menu**; Controlify features a configurable menu that allows you to bind less-used actions to a radial menu, saving up buttons.
+- **DualSense HD haptics** support; Controlify allows for advanced vibration effects on DualSense controllers.
+- **DualSense adaptive triggers support**; Controlify allows for advanced trigger effects on DualSense controllers.
+- **Data-driven design**; Controlify allows resource packs to change default bindings, theme button glyphs, on-screen button guides, on-screen keyboard layouts, add more controller models, and more.
+- **Steam Deck support**
+- **Mod compatibility**; Controlify has led the efforts to make controller support work seamlessly with mods like Sodium, Iris, Simple Voice Chat, Do A Barrel Roll, and more.
+- **Cross-platform and multi-version**; Controlify works on Fabric and NeoForge, and actively supports and updates for Minecraft versions 1.21.1 and above.
+- **Quick to update**; Controlify is updated even for Minecraft snapshots, although snapshot builds are only available to patreon members.
+- **Joystick support**; Controlify supports flight sticks, racing wheels, and other non-standard joysticks. Users of such devices have the option between mapping the joystick to a standard gamepad, or creating their own custom bindings and defaults and glyphs for the joystick, allowing for a fully-featured experience.
 
-### Does it support my controller?
+## Who uses Controlify?
 
-Controlify supports most controllers out of the box, any generic gamepad-like controller is bound to work fine, at
-least in a basic state, giving inputs. Though, more strange and uncommon controllers such as handhelds like the ROG
-Ally may be missing features such as gyroscope.
+The following is actual feedback I have received from users of Controlify, and I'm very proud to have been able to help them enjoy Minecraft in a way they couldn't before:
 
-If you are having trouble getting your controller working correctly, you can
-[join my discord server](https://short.isxander.dev/discord) or consult
-[the wiki](https://docs.isxander.dev/controlify/users/controller-compatibility-guide) for assistance.
+- Couch gamers who want to sit back and relax playing their favourite edition of Minecraft.
+- First-time modded players who have previously played Minecraft on a console and don't want to learn how to use a keyboard and mouse.
+- People with accessibility requirements who cannot use a keyboard and mouse and/or requires an adaptive controller.
+- Parents who want to expose their kids to modded Minecraft in an accessible manner.
+- People who just prefer using a controller over a keyboard and mouse.
+- People who want to play local multiplayer with their friends and family using the companion [Splitscreen Mod](https://patreon.com/isxander)
+- Hopefully you!
 
 ## Features
 
@@ -92,7 +86,7 @@ To save up some buttons on your controller, dedicate some less-used actions to t
 It is fully customizable through the settings and intuitive to use. Any modded keybind is
 compatible with this menu.
 
-### Built-in gyro support
+### Gyro support
 
 Controlify has built-in support for controller gyroscopes, allowing you to make fine movements in-game
 with your controller. This can be combined with [flick stick](https://www.reddit.com/r/gamedev/comments/bw5xct/flick_stick_is_a_new_way_to_control_3d_games_with/) to be able to use a controller without
@@ -149,15 +143,9 @@ meaning you don't have to worry about it.
 
 ![image of calibration screen](https://cdn.modrinth.com/data/DOUdJVEm/images/f5f8e2a0a05e61adb95dd919760b424165ca5d14.png)
 
-## What is to come?
-
-A few features in various points in the horizon are:
-
-- Explicit Steam Deck support, with the ability to interface with its gyroscope and be able to handle its extra buttons on the back of the device.
-- A better way to change controller bindings, possibly a custom graphical GUI to pick what buttons do what actions, not the other way around.
-- Split-screen support of some degree.
-
 ## Backports?
 
 This mod is only and will only be available for **1.19.4** and above, this is because in 1.19.4, Mojang
 introduced arrow key navigation which was easily ported to controller, below 1.19.4, this is not possible.
+
+Controlify is currently actively supported for Minecraft versions 1.21.1 and above, and is compatible with both Fabric and NeoForge.

.github/workflows/build.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v4
         with:
-          java-version: 21
+          java-version: 25
           distribution: temurin
       - name: Make gradlew executable
         run: chmod +x ./gradlew

build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
 
     id("me.modmuss50.mod-publish-plugin")
     `maven-publish`
+    id("com.gradleup.nmcp")
 
     id("dev.kikugie.postprocess.j52j") version "2.1-beta.3"
 }
@@ -101,6 +102,10 @@ dependencies {
     // Already included by YetAnotherConfigLib, but we need it too, so let's define explicit dep
     api("org.quiltmc.parsers:json:${property("deps.quiltparsers")}")
 
+    if (stonecutter.current.parsed < "1.21.11") {
+        compileOnly("org.jspecify:jspecify:1.0.0")
+    }
+
     // sodium compat
     modDependency("sodium", { "maven.modrinth:sodium:$it" })
     // RSO compat
@@ -152,7 +157,7 @@ val nativeTargets = listOf(
 val nativeConfigurations = nativeTargets.associate { target ->
     target.configurationName to configurations.create(target.configurationName)
 }
-val nativeHashConfiguration = configurations.create("nativeHashes")
+val nativeHashConfiguration: Configuration = configurations.create("nativeHashes")
 
 nativeTargets.forEach { target ->
     dependencies {
@@ -194,12 +199,7 @@ Include native libraries for SDL3 in the jar.
 
 val releaseModVersion by tasks.registering {
     group = "controlify/versioned"
-
     dependsOn("publishMods")
-
-    if (!project.publishMods.dryRun.get()) {
-        dependsOn("publish")
-    }
 }
 createActiveTask(releaseModVersion)
 
@@ -243,42 +243,40 @@ publishMods {
     // modrinth and curseforge use different formats for snapshots. this can be expressed globally
     val stableMCVersions = versionList("pub.stableMC")
 
-    val modrinthId: String by project
-    if (modrinthId.isNotBlank() && hasProperty("modrinth.token")) {
-        modrinth {
-            projectId.set(modrinthId)
-            accessToken.set(findProperty("modrinth.token")?.toString())
-            minecraftVersions.addAll(stableMCVersions)
-            minecraftVersions.addAll(versionList("pub.modrinthMC"))
+    modrinth {
+        accessToken = secrets.gradleProperty("modrinth.accessToken")
 
-            announcementTitle = "Download $mcVersion for ${loader.replaceFirstChar { it.uppercase() }} from Modrinth"
+        projectId = providers.gradleProperty("pub.modrinthId")
 
-            requires { slug.set("yacl") }
+        minecraftVersions.addAll(stableMCVersions)
+        minecraftVersions.addAll(versionList("pub.modrinthMC"))
 
-            if (modstitch.isLoom) {
-                requires { slug.set("fabric-api") }
-                optional { slug.set("modmenu") }
-            }
+        announcementTitle = "Download $mcVersion for ${loader.replaceFirstChar { it.uppercase() }} from Modrinth"
+
+        requires { slug.set("yacl") }
+
+        if (modstitch.isLoom) {
+            requires { slug.set("fabric-api") }
+            optional { slug.set("modmenu") }
         }
     }
 
-    val curseforgeId: String by project
-    if (curseforgeId.isNotBlank() && hasProperty("curseforge.token")) {
-        curseforge {
-            projectId = curseforgeId
-            projectSlug = findProperty("curseforgeSlug")!!.toString()
-            accessToken = findProperty("curseforge.token")?.toString()
-            minecraftVersions.addAll(stableMCVersions)
-            minecraftVersions.addAll(versionList("pub.curseMC"))
+    curseforge {
+        accessToken = secrets.gradleProperty("curseforge.accessToken")
 
-            announcementTitle = "Download $mcVersion for ${loader.replaceFirstChar { it.uppercase() }} from CurseForge"
+        projectId = providers.gradleProperty("pub.curseforgeId")
+        projectSlug = providers.gradleProperty("pub.curseforgeSlug")
 
-            requires { slug.set("yacl") }
+        minecraftVersions.addAll(stableMCVersions)
+        minecraftVersions.addAll(versionList("pub.curseMC"))
 
-            if (modstitch.isLoom) {
-                requires { slug.set("fabric-api") }
-                optional { slug.set("modmenu") }
-            }
+        announcementTitle = "Download $mcVersion for ${loader.replaceFirstChar { it.uppercase() }} from CurseForge"
+
+        requires { slug.set("yacl") }
+
+        if (modstitch.isLoom) {
+            requires { slug.set("fabric-api") }
+            optional { slug.set("modmenu") }
         }
     }
 }
@@ -289,6 +287,33 @@ publishing {
 
             artifactId = "controlify"
             groupId = "dev.isxander"
+
+            pom {
+                name = modstitch.metadata.modName
+                description = modstitch.metadata.modDescription
+                url = "https://www.isxander.dev/projects/controlify"
+                licenses {
+                    license {
+                        name = "LGPL-3.0-or-later"
+                        url = "https://www.gnu.org/licenses/lgpl-3.0.en.html"
+                    }
+                }
+                developers {
+                    developer {
+                        id = "isXander"
+                        name = "Xander"
+                        email = "business@isxander.dev"
+                    }
+                }
+                scm {
+                    url = "https://github.com/isXander/Controlify"
+                    connection = "scm:git:git//github.com/isXander/Controlify.git"
+                    developerConnection = "scm:git:ssh://git@github.com/isXander/Controlify.git"
+                }
+            }
         }
     }
 }
+signing {
+    sign(publishing.publications["mod"])
+}

buildSrc/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     `kotlin-dsl`
-    kotlin("jvm") version "2.2.0"
+    kotlin("jvm") version "2.2.21"
 }
 
 repositories {
@@ -30,8 +30,9 @@ repositories {
 dependencies {
     fun plugin(id: String, version: String) = "$id:$id.gradle.plugin:$version"
 
-    implementation(plugin("dev.isxander.modstitch.base", "0.7.0-unstable"))
-    implementation(plugin("dev.kikugie.stonecutter", "0.7.6"))
-    implementation(plugin("fabric-loom", "1.11.4"))
-    implementation(plugin("net.neoforged.moddev", "2.0.103"))
+    implementation(plugin("dev.isxander.modstitch.base", "0.8.4"))
+    implementation(plugin("dev.isxander.secrets", "0.1.0"))
+    implementation(plugin("dev.kikugie.stonecutter", "0.8.2"))
+    implementation(plugin("fabric-loom", "1.14.9"))
+    implementation(plugin("net.neoforged.moddev", "2.0.137"))
 }

buildSrc/src/main/kotlin/dev/isxander/controlify/project.gradle.kts

@@ -3,14 +3,15 @@ package dev.isxander.controlify
 import net.fabricmc.loom.task.prod.ClientProductionRunTask
 
 plugins {
+    `java-library`
     id("dev.isxander.modstitch.base")
     `maven-publish`
-    `java-library`
+    signing
+    id("dev.isxander.secrets")
 }
 
 modstitch.apply {
     minecraftVersion = mcVersion
-    javaVersion = 21
 
     parchment {
         propMap("parchment.version") { mappingsVersion = it }
@@ -92,6 +93,10 @@ if (modstitch.isLoom) {
 
 java {
     withSourcesJar()
+    withJavadocJar()
+}
+tasks.javadoc {
+    isFailOnError = false
 }
 
 /*
@@ -101,18 +106,32 @@ stonecutter.apply {
     constants {
         put("fabric", modstitch.isLoom)
         put("neoforge", modstitch.isModDevGradleRegular)
-        put("immediately-fast", isPropDefined("deps.immediatelyFast"))
+        put("immediately_fast", isPropDefined("deps.immediatelyFast"))
         put("iris", isPropDefined("deps.iris"))
-        put("mod-menu", isPropDefined("deps.modMenu"))
+        put("mod_menu", isPropDefined("deps.modMenu"))
         put("sodium", isPropDefined("deps.sodium"))
-        put("simple-voice-chat", isPropDefined("deps.simpleVoiceChat"))
-        put("reeses-sodium-options", isPropDefined("deps.reesesSodiumOptions"))
-        put("fancy-menu", isPropDefined("deps.fancyMenu"))
+        put("simple_voice_chat", isPropDefined("deps.simpleVoiceChat"))
+        put("reeses_sodium_options", isPropDefined("deps.reesesSodiumOptions"))
+        put("fancy_menu", isPropDefined("deps.fancyMenu"))
+
+        put("unobf", eval(current.version, ">=26"))
+        put("intermediary_lambdas", !eval(current.version, ">=26") && !modstitch.isModDevGradle)
     }
 
     dependencies {
         put("fapi", prop("deps.fabricApi") ?: "0.0.0")
     }
+
+    replacements {
+        string {
+            direction = eval(current.version, ">=1.21.11")
+            replace("ResourceLocation", "Identifier")
+        }
+        string {
+            direction = eval(current.version, ">=1.21.11")
+            replace("import net.minecraft.Util;", "import net.minecraft.util.Util;")
+        }
+    }
 }
 
 tasks.named<ProcessResources>("generateModMetadata") {
@@ -124,20 +143,23 @@ tasks.named<ProcessResources>("generateModMetadata") {
     }
 }
 
-publishing {
-    repositories {
-        val username = prop("XANDER_MAVEN_USER")
-        val password = prop("XANDER_MAVEN_PASS")
-        if (username != null && password != null) {
-            maven(url = "https://maven.isxander.dev/releases") {
-                name = "XanderReleases"
-                credentials {
-                    this.username = username
-                    this.password = password
-                }
+val signingKeyProvider = secrets.gradleProperty("signing.secretKey")
+val signingPasswordProvider = secrets.gradleProperty("signing.password")
+// not configuration cache friendly, but neither is the whole of signing plugin
+// this plugin does not support lazy configuration of signing keys
+gradle.taskGraph.whenReady {
+    val willSign = allTasks.any { it.name.startsWith("sign") }
+    if (willSign) {
+        signing {
+            val signingKey = signingKeyProvider.orNull
+            val signingPassword = signingPasswordProvider.orNull
+
+            isRequired = signingKey != null && signingPassword != null
+            if (isRequired) {
+                useInMemoryPgpKeys(signingKey, signingPassword)
+            } else {
+                logger.error("Signing keys not found; skipping signing!")
             }
-        } else {
-            logger.warn("Xander Maven credentials not satisfied.")
         }
     }
 }