Game Test Framework

.github/workflows/build.yml

@@ -53,7 +53,7 @@ jobs:
         uses: actions/setup-java@v5
         with:
           java-version: 25
-          distribution: temurin
+          distribution: microsoft
 
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@v6
@@ -89,11 +89,54 @@ jobs:
           path: versions/**/build/libs/*
           name: ${{ matrix.target }}
 
-#  run:
-#    needs: build
-#    runs-on: ubuntu-latest
-#    name: Run Minecraft
-#
-#    strategy:
-#      matrix:
-#        target: ${{ fromJson(needs.retrieve-targets.outputs.targets) }}
+  client_game_test:
+    needs: generate-build-matrix
+    runs-on: ubuntu-latest
+    name: Client test with gradle
+
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJson(needs.generate-build-matrix.outputs.matrix).include.*.target }}
+        graphics_backend:
+          - opengl
+          - vulkan
+
+    continue-on-error: ${{ contains(matrix.target, 'exp') }}
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up JDK
+        uses: actions/setup-java@v5
+        with:
+          java-version: 25
+          distribution: microsoft
+
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v6
+
+      - name: Make gradlew executable
+        run: chmod +x ./gradlew
+      - name: Overwrite current version
+        run: printf "%s" "${{ matrix.target }}" | cut -d':' -f1 | tr -d '\n' > ./versions/current
+      - name: Install drivers
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y mesa-vulkan-drivers xvfb
+
+      - name: Setup stonecutter
+        run: ./gradlew "Refresh active project"
+        env:
+          CI_SINGLE_BUILD: ${{ matrix.target }}
+
+      - name: Run client tests
+        run: ./gradlew runClientGameTest --stacktrace --args="--graphicsBackend ${{ matrix.graphics_backend }}"
+        env:
+          CI_SINGLE_BUILD: ${{ matrix.target }}
+
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: Test Screenshots (${{ matrix.target }}) (${{ matrix.graphics_backend }})
+          path: '**/run/clientGameTest/secreenshots'

.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/setup-java@v5
         with:
           java-version: 25
-          distribution: temurin
+          distribution: microsoft
 
       - uses: actions/checkout@v7
 

.github/workflows/update-gamecontrollerdb.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/setup-java@v5
         with:
           java-version: '25'
-          distribution: 'temurin'
+          distribution: 'microsoft'
 
       - name: Set up Gradle
         uses: gradle/actions/setup-gradle@v6

build.gradle.kts

@@ -16,13 +16,15 @@ base.archivesName = "controlify"
 
 java.toolchain.languageVersion = JavaLanguageVersion.of(25)
 
+val fabricApiBom = dependencies.platform("net.fabricmc.fabric-api:fabric-api-bom:${property("dep.fapi")}")
+
 dependencies {
     minecraft("com.mojang:minecraft:$minecraftVersion")
     fabricLoader(libs.fabric.loader)
     neoforgeImplementation("net.neoforged:neoforge:${property("dep.neoforge")}")
 
-    implementation(platform("net.fabricmc.fabric-api:fabric-api-bom:${property("dep.fapi")}"))
-	fabricImplementation(platform("net.fabricmc.fabric-api:fabric-api-bom:${property("dep.fapi")}"))
+    implementation(fabricApiBom)
+	fabricImplementation(fabricApiBom)
 	fabricImplementation("net.fabricmc.fabric-api:fabric-resource-loader-v1")
 	fabricImplementation("net.fabricmc.fabric-api:fabric-networking-api-v1")
 	fabricImplementation("net.fabricmc.fabric-api:fabric-command-api-v2")
@@ -54,40 +56,40 @@ dependencies {
     neoforgeApi("dev.isxander:yet-another-config-lib:${property("dep.yacl-neoforge")}")
 
 	ifPresent("dep.mod-menu") {
-		fabricImplementation("maven.modrinth:modmenu:$it")
+		fabricCompileOnly("maven.modrinth:modmenu:$it")
 	}
 
     ifPresent("dep.sodium") {
         compileOnly("net.caffeinemc:sodium-fabric:$it") {
 			exclude(group = "net.fabricmc.fabric-api")
 		}
-        fabricImplementation("net.caffeinemc:sodium-fabric:$it")
-        neoforgeImplementation("net.caffeinemc:sodium-neoforge:$it")
-        neoforgeImplementation("net.caffeinemc:sodium-neoforge-mod:$it")
+        fabricCompileOnly("net.caffeinemc:sodium-fabric:$it")
+        neoforgeCompileOnly("net.caffeinemc:sodium-neoforge:$it")
+        neoforgeCompileOnly("net.caffeinemc:sodium-neoforge-mod:$it")
     }
 
     ifPresent("dep.iris") {
         compileOnly("maven.modrinth:iris:$it")
-        fabricImplementation("maven.modrinth:iris:$it")
+        fabricCompileOnly("maven.modrinth:iris:$it")
     }
     ifPresent("dep.iris-neoforge") {
-        neoforgeImplementation("maven.modrinth:iris:$it")
+        neoforgeCompileOnly("maven.modrinth:iris:$it")
     }
 
     ifPresent("dep.rso") {
         compileOnly("maven.modrinth:reeses-sodium-options:$it")
-        fabricImplementation("maven.modrinth:reeses-sodium-options:$it")
+        fabricCompileOnly("maven.modrinth:reeses-sodium-options:$it")
     }
     ifPresent("dep.rso-neoforge") {
-        neoforgeImplementation("maven.modrinth:reeses-sodium-options:$it")
+        neoforgeCompileOnly("maven.modrinth:reeses-sodium-options:$it")
     }
 
     ifPresent("dep.svc") {
         compileOnly("maven.modrinth:simple-voice-chat:$it")
-        fabricImplementation("maven.modrinth:simple-voice-chat:$it")
+        fabricCompileOnly("maven.modrinth:simple-voice-chat:$it")
     }
     ifPresent("dep.svc-neoforge") {
-        neoforgeImplementation("maven.modrinth:simple-voice-chat:$it")
+        neoforgeCompileOnly("maven.modrinth:simple-voice-chat:$it")
     }
 
     ifPresent("dep.fancy-menu") {
@@ -255,6 +257,54 @@ if (includeNatives) {
     }
 }
 
+/// Testing
+
+fabricApi {
+	@Suppress("UnstableApiUsage")
+	configureTests {
+		createSourceSet = true
+		modId = "controlify_test"
+		enableGameTests = false
+		enableClientGameTests = true
+		eula = true
+	}
+}
+
+sourceSets.named { it in listOf("gametest", "test") }.configureEach {
+	compileClasspath += sourceSets.fabric.get().output
+	runtimeClasspath += sourceSets.fabric.get().output
+}
+sourceSets.named("gametest") {
+	compileClasspath += sourceSets.test.get().output
+	runtimeClasspath += sourceSets.test.get().output
+}
+configurations.named("testCompileClasspath") {
+	extendsFrom(configurations.named("fabricCompileClasspath"))
+}
+configurations.named("gametestCompileClasspath") {
+	extendsFrom(configurations.named("testCompileClasspath"))
+}
+configurations.named("testRuntimeClasspath") {
+	extendsFrom(configurations.named("fabricRuntimeClasspath"))
+}
+configurations.named("gametestRuntimeClasspath") {
+	extendsFrom(configurations.named("testRuntimeClasspath"))
+}
+
+val gametestImplementation = configurations.named("gametestImplementation")
+
+dependencies {
+	testImplementation(libs.fabric.loader.junit)
+
+	gametestImplementation(fabricApiBom)
+	gametestImplementation("net.fabricmc.fabric-api:fabric-gametest-api-v1")
+	gametestImplementation("net.fabricmc.fabric-api:fabric-client-gametest-api-v1")
+}
+
+tasks.test {
+	useJUnitPlatform()
+}
+
 /// Publishing
 
 publishMods {

gradle/libs.versions.toml

@@ -17,6 +17,7 @@ mod_publish_plugin = "2.1.1"
 
 [libraries]
 fabric_loader = { module = "net.fabricmc:fabric-loader", version.ref = "fabric_loader" }
+fabric_loader_junit = { module = "net.fabricmc:fabric-loader-junit", version.ref = "fabric_loader" }
 sdl_java_api = { module = "dev.isxander.sdl:sdl-api", version.ref = "sdl_java" }
 sdl_java_backend_ffm = { module = "dev.isxander.sdl:sdl-backend-ffm", version.ref = "sdl_java" }
 steamdeck4j = { module = "dev.isxander:steamdeck4j", version.ref = "steamdeck4j" }

src/gametest/java/dev/isxander/controlify/gametest/framework/CEntityTypes.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2026 isXander
+ * This file is part of Controlify.
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+package dev.isxander.controlify.gametest.framework;
+
+//? if >=26.2 {
+import net.minecraft.world.entity.EntityTypes;
+
+public final class CEntityTypes extends EntityTypes {
+}
+//?} else {
+/*import com.google.common.collect.ImmutableSet;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.entity.Entity;
+import net.minecraft.world.entity.EntityDimensions;
+import net.minecraft.world.entity.EntityType;
+import net.minecraft.world.entity.MobCategory;
+import net.minecraft.world.flag.FeatureFlagSet;
+import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.storage.loot.LootTable;
+
+import java.util.Optional;
+
+public final class CEntityTypes extends EntityType<Entity> {
+	private CEntityTypes(EntityFactory<Entity> factory, MobCategory category, boolean serialize, boolean summon, boolean fireImmune, boolean canSpawnFarFromPlayer, ImmutableSet<Block> immuneTo, EntityDimensions dimensions, float spawnDimensionsScale, int clientTrackingRange, int updateInterval, String descriptionId, Optional<ResourceKey<LootTable>> lootTable, FeatureFlagSet requiredFeatures, boolean allowedInPeaceful) {
+		super(factory, category, serialize, summon, fireImmune, canSpawnFarFromPlayer, immuneTo, dimensions, spawnDimensionsScale, clientTrackingRange, updateInterval, descriptionId, lootTable, requiredFeatures, allowedInPeaceful);
+	}
+}
+*///?}