Fabric multi-version support using Stonecutter (#33)

* Some initial work

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

* Drop 1.18.2 and below. Working 1.21.4 build

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

* Working 1.19+ builds

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

* Switch to 1.21.4

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

* Runnable

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

* Fix for idea plugin and build script changes

* Cleanup comments

* Working 1.17+ builds. Development guide for Fabric.

* Cleaning up imports

* Enable build action for fabric-stonecutter

* Remove dependency graph

* Add a script for re-creating symlink in windows

* Chat suggestions and Skin info

* Test commit

* Stonecutter 0.7

Disables TextPlaceholder integration

* Buildable with `gradle build -x fabirc:build` only 1.21.4 working

* Fix mixin failure on 1.19.2

* Use project.property in gradle and remove loom MPO

* Fix mixin for all versions

* Suppress warning

* Check to CallbackInfoReturnable due to warning

* Fix advancement mixin for all versions

* Fix translation bug on older adventure versions

* Refactor FabricDeathModule to use ServerLivingEntityEvents instead of mixins

* Fix the real issue with CommandManagerMixin

* Fix issues with spectator action in Fabric

* Bump stonecutter to 0.7.1

* 1.21.5 and 1.21.6-1.21.8 and a few bug fixes

* CI builds for fabric

* Set active fabric version to 1.21.6

* Bump Stonecutter to 0.7.3

* Disabled `:fabric:compileJava` task, Now `gradle build` works fine.

* Fix mapped sources for fabric and updates link scripts
Also ignores the symlinks for the fabric versions

* Update development instructions for setting up mapped sources

* Remove unused import

* Remove idea module testing code

* Re-enable TextPlaceholderIntegration

* TextPlaceholderIntegration had wrong minecraft version

* Drop fabric-stonecutter changes in build.yaml

* Fabric adventure utility

* Bump Stonecutter to 0.7.4

* Forgot licence

* Update FabricPlayer#skinInfo to use skin parts

* Remove MixinExtras from fabric

* Update bungeecord-api to 1.21-R0.4-SNAPSHOT

* Fix import issues

* Suppress adventure removal warning

* Fix build

* Mixin into ServerPlayerEntity to support locale under 1.20.2

* Add task to delete mapped source for Fabric

* Fix locale mixin

* Change compatibility level to 17

* Remove TextColor usage

* Remove unused import

* Remove FabricCommandHandler#getSender to use ServerCommandSource#getEntity instead

* Update kyori's ANSI library to 1.1.0 in older versions

* Refactor FabricAdventureUtil to FabricComponentFactory

* Implement player model parts correctly in lower versions

* Fix an issue with PlayerAdvancementTrackerMixin in 1.20.1

* Add error when FabricDiscordSRV is null on server startup

* Bump adventure-platform-mod to 6.5.1 for 1.21.6

---------

Signed-off-by: IxPrumxI <walidaqeel@gmail.com>

Author: IxPrumxI

.gitignore

@@ -44,4 +44,7 @@ hs_err_pid*
 **/fabric/run
 
 # Fabric mapping migration
-**/fabric/remappedSrc
+**/fabric/remappedSrc
+
+# Fabric src links
+/fabric/versions/*/src

build.gradle

@@ -30,6 +30,16 @@ subprojects {
         targetCompatibility = JavaVersion.VERSION_1_8
     }
 
+    if (project.path == ":fabric") {
+        compileJava.configure {
+            doFirst {
+                throw new StopExecutionException(
+                        "The 'compileJava' task is disabled in fabric root project."
+                )
+            }
+        }
+    }
+
     configurations {
         // Exclude dependencies from being included in jars
         runtimeExclude {
@@ -121,7 +131,6 @@ subprojects {
     }
     clean.dependsOn deleteJarsDir
 
-    defaultTasks 'build'
     jar {
         duplicatesStrategy = DuplicatesStrategy.INCLUDE
 

buildscript/final.gradle

@@ -14,7 +14,7 @@ shadowJar {
         rename { fileName -> 'LICENSE.txt' }
     }
 
-    if (it.project.name != "fabric") {
+    if (it.project.parent.name != "fabric") {
         finalizedBy copyOutput
     }
-}
+}

common/src/main/java/com/discordsrv/common/AbstractDiscordSRV.java

@@ -374,7 +374,7 @@ private String readAttribute(Attributes attributes, String key) {
     }
 
     @Override
-    public final @NotNull ComponentFactory componentFactory() {
+    public @NotNull ComponentFactory componentFactory() {
         return componentFactory;
     }
 

common/src/main/java/com/discordsrv/common/core/component/ComponentFactory.java

@@ -111,6 +111,7 @@ public ComponentFactory(DiscordSRV discordSRV) {
     }
 
     private final ThreadLocal<Set<String>> translationHistory = new ThreadLocal<>();
+    @SuppressWarnings("deprecation")
     private String provideTranslation(TranslatableComponent component) {
         Set<String> history = translationHistory.get();
         if (history == null) {
@@ -140,7 +141,7 @@ private String provideTranslation(TranslatableComponent component) {
             translationHistory.set(history);
 
             return translation.translate(
-                    component.arguments()
+                    component.args()
                             .stream()
                             .map(argument -> plainSerializer().serialize(argument.asComponent()))
                             .toArray(Object[]::new)

fabric/DEVELOP.MD

@@ -0,0 +1,31 @@
+## Fabric Development
+This mod is using [Stonecutter](https://stonecutter.kikugie.dev/) to support multiple Minecraft versions.
+To add a new feature in this mod you need to follow these steps:
+1. Run gradle task "Set active project to X" in stonecutter where X is the lowest Minecraft version you want to support.
+2. Go to `fabric/scripts` and run the script for your operating system to set up the mapped sources
+3. Go to `fabric/versions/<version>/src` and add your changes there as intelij idea will not add the correct classpath to the main sources folder. 
+4. Make sure that whatever api you are using is available in all Fabric and Minecraft versions. 
+5. Before you commit your changes, run the gradle task "Reset active project" in stonecutter
+
+## Adventure API
+This mod uses all 3 major versions of adventure-platform-fabric (4, 5 and 6) and the lowest Minecraft version supported due to this is 1.16.2.
+You can use the following examples to see how the checks are done in the code: 
+```java
+//? if adventure: <6 {
+/*@SuppressWarnings("removal")
+Component component = discordSRV.getAdventure().toAdventure(signedMessage.getContent());
+*///?} else {
+Component component = discordSRV.getAdventure().asAdventure(signedMessage.getContent());
+ //?}
+```
+```java
+//? if adventure: >=5.11.0 {
+return player.identity();
+//?} else {
+/*return Identity.identity(player.getUuid());
+*///?}
+```
+
+## Mixins
+You may want to use mixins in the case that a fabric api is not supported in the lowest Minecraft version.
+Refer to CommandManagerMixin and FabricRequiredLinkingModule for an example of how to use mixins in this mod with changing Minecraft classes.

fabric/build.gradle

@@ -1,5 +1,8 @@
+plugins {
+    id("dev.kikugie.stonecutter") version "0.7.4"
+    id("fabric-loom")
+}
 apply from: rootProject.file('buildscript/standalone.gradle')
-apply plugin: 'fabric-loom'
 
 configurations.configureEach {
     resolutionStrategy {
@@ -8,13 +11,45 @@ configurations.configureEach {
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_21
-    targetCompatibility = JavaVersion.VERSION_21
+    def javaVersion = project.property("deps.java") == 17 ? JavaVersion.VERSION_17 : project.property("deps.java") == 21 ? JavaVersion.VERSION_21 : null
+    targetCompatibility = javaVersion
+    sourceCompatibility = javaVersion
+}
+
+if(project.path.startsWith(":fabric:")) {
+    tasks.register('deleteMappedSrc', Delete) {
+        delete project.file("src")
+    }
+
+    clean.dependsOn deleteMappedSrc
+}
+
+sourceSets {
+    main {
+        java {
+            srcDirs("versions/${stonecutter.current.project}/src/main/java")
+        }
+        resources {
+            srcDirs("versions/${stonecutter.current.project}/src/main/resources")
+        }
+    }
 }
 
 processResources {
-    filesMatching('**/fabric.mod.json') {
-        expand 'VERSION': project.version, 'MINECRAFT_VERSION': libs.fabric.minecraft.get().version, 'LOADER_VERSION': libs.fabric.loader.get().version
+    def version = project.version
+    def loaderVersion = project.property("deps.fabric_loader")
+    def minecraftVersion = stonecutter.current.project
+
+    inputs.property("version", version)
+    inputs.property("loaderVersion", loaderVersion)
+    inputs.property("minecraftVersion", minecraftVersion)
+
+    filesMatching("fabric.mod.json") {
+        expand(
+            VERSION:          version,
+            LOADER_VERSION:   loaderVersion,
+            MINECRAFT_VERSION: minecraftVersion
+        )
     }
     dependsOn generateRuntimeDownloadResourceForRuntimeDownloadOnly
 }
@@ -24,29 +59,51 @@ shadowJar {
     mergeServiceFiles()
 }
 
+stonecutter {
+    def adventure = project.property("deps.adventure_platform_fabric").replace("-SNAPSHOT", "")
+    dependency("adventure", adventure)
+    dependency("java", project.property("deps.java"))
+
+    swap("dependencies_file", "\"dependencies/runtimeDownload-${stonecutter.current.version}.txt\";")
+}
+
 tasks.register('copyRemappedJar', Copy) {
     from remapJar.archiveFile
-    into rootProject.file('jars')
+    into rootProject.file('jars/fabric')
 }
 
 remapJar {
     dependsOn shadowJar
     mustRunAfter shadowJar
     inputFile = shadowJar.archiveFile
-    archiveBaseName = 'DiscordSRV-Fabric'
+
+    archiveBaseName = "DiscordSRV-Fabric-${stonecutter.current.project}"
+    if (stonecutter.current.version == "1.21.6") {
+        archiveBaseName = "DiscordSRV-Fabric-${stonecutter.current.project}-1.21.8"
+    }
     archiveClassifier = jar.archiveClassifier
 
     finalizedBy copyRemappedJar
 }
 
+spotless {
+    java {
+        if (stonecutter.current.isActive)
+            target("src/main/java/")
+    }
+}
+
 artifacts {
     archives remapJar
     shadow shadowJar
 }
 
 loom {
     serverOnlyMinecraftJar()
-    accessWidenerPath = file('src/main/resources/discordsrv.accesswidener')
+    runConfigs.all {
+        ideConfigGenerated(true) // Run configurations are not created for subprojects by default
+        runDir = "../../run" // Use a shared run folder and create separate worlds
+    }
 }
 
 repositories {
@@ -69,15 +126,30 @@ repositories {
 }
 
 dependencies {
-    // To change the versions see the settings.gradle file
-    minecraft(libs.fabric.minecraft)
-    mappings(variantOf(libs.fabric.yarn) { classifier("v2") })
-    compileOnly(libs.fabric.loader)
+    minecraft("com.mojang:minecraft:${stonecutter.current.project}")
+    mappings("net.fabricmc:yarn:${project.property("deps.yarn_mappings")}:v2")
+    compileOnly("net.fabricmc:fabric-loader:${project.property("deps.fabric_loader")}")
 
     // Fabric API
-    modImplementation(libs.fabric.api)
-    modImplementation(libs.fabric.permissions.api)
-    include(libs.fabric.permissions.api)
+    Set<String> apiModules = [
+            'fabric-api-base',
+            'fabric-lifecycle-events-v1',
+            'fabric-entity-events-v1',
+            'fabric-networking-api-v1',
+    ]
+    if (stonecutter.eval(stonecutter.current.version, ">=1.19.2")) {
+        apiModules.add('fabric-message-api-v1')
+    }
+    apiModules.forEach {
+        modImplementation(fabricApi.module(it, project.property("deps.fabric_api")))
+    }
+
+    // Minecraft versions under 1.21.6 should use 0.3.3, while 1.21.6 and above should use 0.4.1
+    modImplementation("me.lucko:fabric-permissions-api:${stonecutter.eval(stonecutter.current.version, ">=1.21.6") ? '0.4.1' : '0.3.3'}") {
+        exclude group: 'net.fabricmc.fabric-api', module: 'fabric-api-base'
+        exclude group: 'net.fabricmc.fabric-api', module: 'fabric-api-bom'
+    }
+    include ("me.lucko:fabric-permissions-api:${stonecutter.eval(stonecutter.current.version, ">=1.21.6") ? '0.4.1' : '0.3.3'}")
 
     // API
     annotationProcessor project(':api')
@@ -87,14 +159,19 @@ dependencies {
     shadow project(':common')
 
     // Adventure
-    modImplementation(libs.adventure.platform.fabric)
-    include(libs.adventure.platform.fabric)
+    modImplementation("net.kyori:adventure-platform-fabric:${project.property("deps.adventure_platform_fabric")}") {
+        exclude group: 'net.kyori', module: 'ansi'
+    }
+    include("net.kyori:adventure-platform-fabric:${project.property("deps.adventure_platform_fabric")}")
+
+    implementation(libs.kyori.ansi)
+    include(libs.kyori.ansi)
 
     // Integrations
-    modCompileOnly(libs.textplaceholder.fabric)
+    modCompileOnly("eu.pb4:placeholder-api:${project.property("deps.text_placeholder_api")}")
 
     // DependencyDownload
     shadow(libs.mcdependencydownload.fabric) {
         exclude module: 'fabric-loader'
     }
-}
+}

fabric/gradle.properties

@@ -0,0 +1,7 @@
+deps.fabric_loader=0.14.0
+
+deps.yarn_mappings=[VERSIONED]
+deps.fabric_api=[VERSIONED]
+deps.adventure_platform_fabric=[VERSIONED]
+deps.text_placeholder_api=[VERSIONED]
+deps.java=[VERSIONED]

fabric/scripts/linux-link-src.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+SRC_DIR="$SCRIPT_DIR/../src"
+VERSIONS_DIR="$SCRIPT_DIR/../versions"
+
+echo
+echo "Linking $SRC_DIR into each version under $VERSIONS_DIR"
+for version_path in "$VERSIONS_DIR"/*; do
+    ver="$(basename "$version_path")"
+    target="$version_path/src"
+    if [[ -e "$target" ]]; then
+      rm -rf "$target"
+    fi
+    echo "Linking src → versions/$ver/src"
+    ln -s "$SRC_DIR" "$target"
+done
+
+echo
+echo "All done. Each version now has a link to the src directory."

fabric/scripts/windows-link-src.ps1

@@ -0,0 +1,28 @@
+# Check if running as Administrator
+if (-not ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
+    Write-Host "Script needs to be run as Administrator. Restarting with elevated privileges..."
+
+    # Relaunch PowerShell as Administrator
+    Start-Process powershell -ArgumentList "-NoProfile -ExecutionPolicy Bypass -File `"$PSCommandPath`"" -Verb RunAs
+    exit
+}
+
+# Set base paths
+$basePath = "$PSScriptRoot\..\versions"
+$srcPath = "$PSScriptRoot\..\src"
+
+# Loop through each version folder
+Get-ChildItem -Directory $basePath | ForEach-Object {
+    $versionPath = $_.FullName
+    $linkPath = Join-Path $versionPath "src"
+
+    # Remove existing link if it exists
+    if (Test-Path $linkPath) {
+        Write-Host "Removing existing link at $linkPath"
+        Remove-Item $linkPath -Force
+    }
+
+    # Create new symbolic link
+    Write-Host "Creating symbolic link in $versionPath"
+    cmd.exe /c "mklink /D `"$linkPath`" `"$srcPath`""
+}