Add documentation for {username} token

Closes #8

CURSEFORGE.html

@@ -11,6 +11,7 @@
 <ul>
   <li><strong>{mcversion}</strong> - current Minecraft version</li>
   <li><strong>{modversion:<span style="text-decoration: underline;">modid</span>}</strong> - version of installed mod with the identifier <em>modid</em></li>
+  <li><strong>{username}</strong> - current username</li>
 </ul>
 <p>If any of the tokens aren't working, search the game log for <strong>CustomWindowTitle</strong> and you should see the reason, otherwise please file an issue on the <a href="https://github.com/chylex/Minecraft-Window-Title/issues">issue tracker</a> with as many details as possible.</p>
 <h3>Changing the Icon</h3>

Fabric/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.gradle.jvm.tasks.Jar
+
 val modId: String by project
 val minecraftVersion: String by project
 val fabricVersion: String by project
@@ -6,10 +8,6 @@ plugins {
 	id("fabric-loom")
 }
 
-repositories {
-	maven("https://repo.spongepowered.org/maven")
-}
-
 dependencies {
 	minecraft("com.mojang:minecraft:$minecraftVersion")
 	modImplementation("net.fabricmc:fabric-loader:$fabricVersion")
@@ -18,8 +16,11 @@ dependencies {
 
 loom {
 	runs {
+		val runJvmArgs: Set<String> by project
+		
 		configureEach {
 			runDir("../run")
+			vmArgs(runJvmArgs)
 			ideConfigGenerated(true)
 		}
 		
@@ -32,7 +33,7 @@ loom {
 	}
 	
 	mixin {
-		add(sourceSets.main.get(), "$modId.refmap.json")
+		defaultRefmapName.set("$modId.refmap.json")
 	}
 }
 
@@ -42,6 +43,11 @@ tasks.processResources {
 	}
 }
 
-tasks.remapJar {
-	archiveVersion.set(tasks.jar.get().archiveVersion)
+tasks.register<Jar>("uncompressedRemapJar") {
+	group = "fabric"
+	
+	from(tasks.remapJar.map { it.outputs.files.map(::zipTree) })
+
+	archiveClassifier.set("uncompressed")
+	entryCompression = ZipEntryCompression.STORED // Reduces size of multiloader jar.
 }

Fabric/src/main/resources/fabric.mod.json

@@ -16,7 +16,7 @@
     "sources": "${sourcesURL}"
   },
   
-  "environment": "client",
+  "environment": "${sidesForFabric}",
   "entrypoints": {
     "client": [
       "chylex.customwindowtitle.fabric.CustomWindowTitle"
@@ -24,7 +24,8 @@
   },
   
   "mixins": [{
-    "config": "${id}.mixins.json"
+    "config": "${id}.mixins.json",
+    "environment": "${sidesForFabric}"
   }],
   
   "depends": {

NeoForge/build.gradle.kts

@@ -1,7 +1,4 @@
-val modId: String by project
-val minecraftVersion: String by project
 val neoForgeVersion: String by project
-val mixinVersion: String by project
 
 plugins {
 	id("net.neoforged.gradle.userdev")
@@ -13,16 +10,19 @@ dependencies {
 }
 
 runs {
+	val runJvmArgs: Set<String> by project
+	
 	configureEach {
-		modSource(project.sourceSets.main.get())
 		workingDirectory = file("../run")
+		modSource(project.sourceSets.main.get())
+		jvmArguments(runJvmArgs)
 	}
 	
-	create("client")
+	removeIf { it.name != "client" }
 }
 
 tasks.processResources {
-	filesMatching("META-INF/mods.toml") {
+	filesMatching("META-INF/neoforge.mods.toml") {
 		expand(inputs.properties)
 	}
 }

NeoForge/src/main/java/chylex/customwindowtitle/neoforge/CustomWindowTitle.java

@@ -4,22 +4,20 @@ import chylex.customwindowtitle.TitleConfig;
 import chylex.customwindowtitle.TitleParser;
 import chylex.customwindowtitle.data.CommonTokenData;
 import net.minecraft.client.Minecraft;
+import net.neoforged.bus.api.IEventBus;
 import net.neoforged.bus.api.SubscribeEvent;
-import net.neoforged.fml.IExtensionPoint.DisplayTest;
-import net.neoforged.fml.ModLoadingContext;
 import net.neoforged.fml.common.Mod;
 import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent;
-import net.neoforged.fml.javafmlmod.FMLJavaModLoadingContext;
 import net.neoforged.fml.loading.FMLPaths;
 
 @Mod("customwindowtitle")
 public class CustomWindowTitle {
+	
 	private final TitleConfig config;
 	
-	public CustomWindowTitle() {
+	public CustomWindowTitle(IEventBus eventBus) {
 		config = TitleConfig.read(FMLPaths.CONFIGDIR.get().toString());
-		ModLoadingContext.get().registerExtensionPoint(DisplayTest.class, () -> new DisplayTest(() -> DisplayTest.IGNORESERVERONLY, (a, b) -> true));
-		FMLJavaModLoadingContext.get().getModEventBus().addListener(this::onClientSetup);
+		eventBus.addListener(this::onClientSetup);
 		CommonTokenData.register(new TokenProvider());
 	}
 	

NeoForge/src/main/resources/META-INF/neoforge.mods.toml

@@ -17,14 +17,14 @@ config = "${id}.mixins.json"
 
 [[dependencies.${id}]]
 modId = "minecraft"
-mandatory = true
+type = "required"
 versionRange = "[${minimumMinecraftVersion},)"
 ordering = "NONE"
-side = "CLIENT"
+side = "${sidesForNeoForge}"
 
 [[dependencies.${id}]]
 modId = "neoforge"
-mandatory = true
+type = "required"
 versionRange = "[${minimumNeoForgeVersion},)"
 ordering = "NONE"
-side = "CLIENT"
+side = "${sidesForNeoForge}"

README.md

@@ -26,6 +26,7 @@ You can use the following special tokens in the _title_ configuration entry:
 
 * **{mcversion}** - current Minecraft version
 * **{modversion:<span style="text-decoration: underline;">modid</span>}** - version of installed mod with the identifier _modid_
+* **{username}** - current username
 
 If any of the tokens aren't working, search the game log for **CustomWindowTitle** and you should see the reason, otherwise please file an issue on the [issue tracker](https://github.com/chylex/Minecraft-Window-Title/issues) with as many details as possible.
 

build.gradle.kts

@@ -1,6 +1,6 @@
 @file:Suppress("ConvertLambdaToReference")
 
-import org.gradle.api.file.DuplicatesStrategy.EXCLUDE
+import org.gradle.jvm.tasks.Jar
 
 val modId: String by project
 val modName: String by project
@@ -10,6 +10,7 @@ val modVersion: String by project
 val modLicense: String by project
 val modSourcesURL: String by project
 val modIssuesURL: String by project
+val modSides: String by project
 
 val minecraftVersion: String by project
 val mixinVersion: String by project
@@ -19,12 +20,11 @@ val minimumNeoForgeVersion: String by project
 val minimumFabricVersion: String by project
 
 val modNameStripped = modName.replace(" ", "")
-val jarVersion = "$minecraftVersion+v$modVersion"
 
 plugins {
 	idea
 	`java-library`
-	id("net.neoforged.gradle.vanilla")
+	id("fabric-loom")
 }
 
 idea {
@@ -43,22 +43,29 @@ idea {
 }
 
 repositories {
-	maven("https://repo.spongepowered.org/maven")
 	mavenCentral()
 }
 
-dependencies {
-	implementation("org.spongepowered:mixin:$mixinVersion")
-	implementation("net.minecraft:client:$minecraftVersion")
-	api("com.google.code.findbugs:jsr305:3.0.2")
-}
-
 base {
 	archivesName.set("$modNameStripped-Common")
 }
 
-runs {
-	clear()
+loom {
+	runs {
+		named("client") {
+			ideConfigGenerated(false)
+		}
+		
+		findByName("server")?.let(::remove)
+	}
+}
+
+dependencies {
+	minecraft("com.mojang:minecraft:$minecraftVersion")
+	mappings(loom.officialMojangMappings())
+	
+	compileOnly("net.fabricmc:sponge-mixin:$mixinVersion")
+	api("com.google.code.findbugs:jsr305:3.0.2")
 }
 
 allprojects {
@@ -67,23 +74,59 @@ allprojects {
 	
 	apply(plugin = "java-library")
 	
-	dependencies {
-		implementation("org.jetbrains:annotations:22.0.0")
-	}
-	
 	extensions.getByType<JavaPluginExtension>().apply {
-		toolchain.languageVersion.set(JavaLanguageVersion.of(17))
+		toolchain.languageVersion.set(JavaLanguageVersion.of(21))
 	}
 	
 	tasks.withType<JavaCompile> {
 		options.encoding = "UTF-8"
-		options.release.set(17)
+		options.release.set(21)
+	}
+	
+	val runJvmArgs = mutableSetOf<String>().also {
+		extra["runJvmArgs"] = it
+	}
+	
+	if (project.javaToolchains.launcherFor(java.toolchain).map { it.metadata.vendor }.orNull == "JetBrains") {
+		runJvmArgs.add("-XX:+AllowEnhancedClassRedefinition")
+	}
+	
+	dependencies {
+		implementation("org.jetbrains:annotations:24.1.0")
+	}
+	
+	tasks.withType<ProcessResources> {
+		val (sidesForNeoForge, sidesForFabric) = when (modSides) {
+			"both"   -> Pair("BOTH", "*")
+			"client" -> Pair("CLIENT", "client")
+			"server" -> Pair("SERVER", "server")
+			else     -> error("Invalid modSides value: $modSides")
+		}
+		
+		inputs.property("id", modId)
+		inputs.property("name", modName)
+		inputs.property("description", modDescription)
+		inputs.property("version", modVersion)
+		inputs.property("author", modAuthor)
+		inputs.property("license", modLicense)
+		inputs.property("sourcesURL", modSourcesURL)
+		inputs.property("issuesURL", modIssuesURL)
+		inputs.property("sidesForNeoForge", sidesForNeoForge)
+		inputs.property("sidesForFabric", sidesForFabric)
+		inputs.property("minimumMinecraftVersion", minimumMinecraftVersion)
+		inputs.property("minimumNeoForgeVersion", minimumNeoForgeVersion)
+		inputs.property("minimumFabricVersion", minimumFabricVersion)
+	}
+	
+	tasks.withType<AbstractArchiveTask>().configureEach {
+		isPreserveFileTimestamps = false
+		isReproducibleFileOrder = true
 	}
 }
 
 subprojects {
 	dependencies {
-		implementation(rootProject)
+		implementation(project(rootProject.path, configuration = "namedElements"))
 	}
 	
 	base {
@@ -97,37 +140,16 @@ subprojects {
 	}
 	
 	tasks.processResources {
-		inputs.property("id", modId)
-		inputs.property("name", modName)
-		inputs.property("description", modDescription)
-		inputs.property("version", modVersion)
-		inputs.property("author", modAuthor)
-		inputs.property("license", modLicense)
-		inputs.property("sourcesURL", modSourcesURL)
-		inputs.property("issuesURL", modIssuesURL)
-		inputs.property("minimumMinecraftVersion", minimumMinecraftVersion)
-		inputs.property("minimumNeoForgeVersion", minimumNeoForgeVersion)
-		inputs.property("minimumFabricVersion", minimumFabricVersion)
-		
 		from(rootProject.sourceSets.main.get().resources) {
 			expand(inputs.properties)
 		}
 	}
 	
 	tasks.jar {
-		archiveVersion.set(jarVersion)
-		
-		from(rootProject.file("LICENSE"))
+		entryCompression = ZipEntryCompression.STORED // Reduces size of multiloader jar.
 		
 		manifest {
-			attributes(
-				"Specification-Title" to modId,
-				"Specification-Vendor" to modAuthor,
-				"Specification-Version" to "1",
-				"Implementation-Title" to "$modNameStripped-${project.name}",
-				"Implementation-Vendor" to modAuthor,
-				"Implementation-Version" to modVersion,
-			)
+			packageInformation(modId, "$modNameStripped-${project.name}")
 		}
 	}
 	
@@ -136,18 +158,55 @@ subprojects {
 	}
 }
 
-val copyJars = tasks.register<Copy>("copyJars") {
+fun Manifest.packageInformation(specificationTitle: String, implementationTitle: String) {
+	attributes(
+		"Specification-Title" to specificationTitle,
+		"Specification-Vendor" to modAuthor,
+		"Specification-Version" to "1",
+		"Implementation-Title" to implementationTitle,
+		"Implementation-Vendor" to modAuthor,
+		"Implementation-Version" to modVersion,
+	)
+}
+
+val multiloaderSources = sourceSets.register("multiloader")
+
+val multiloaderJar = tasks.register<Jar>("multiloaderJar") {
 	group = "build"
-	duplicatesStrategy = EXCLUDE
 	
-	for (subproject in subprojects) {
-		dependsOn(subproject.tasks.assemble)
-		from(subproject.base.libsDirectory.file("${subproject.base.archivesName.get()}-$jarVersion.jar"))
+	archiveBaseName.set(modNameStripped)
+	archiveVersion.set("$minecraftVersion+v$modVersion")
+	
+	destinationDirectory = layout.buildDirectory.dir("dist")
+	
+	fun includeJar(project: Project, jarTaskName: String) {
+		from(project.tasks.named(jarTaskName).map { it.outputs }) {
+			into("jars")
+			rename { "$modNameStripped-${project.name}.jar" }
+		}
 	}
 	
-	into(file("${project.buildDir}/dist"))
+	findProject(":NeoForge")?.let { includeJar(it, "jar") }
+	findProject(":Fabric")?.let { includeJar(it, "uncompressedRemapJar") }
+	
+	from(rootProject.file("LICENSE"))
+	from(multiloaderSources.map { it.output })
+	
+	manifest {
+		packageInformation("$modId-multiloader", modNameStripped)
+		attributes("FMLModType" to "GAMELIBRARY")
+	}
+}
+
+tasks.named<ProcessResources>("processMultiloaderResources").configure {
+	inputs.property("group", project.group)
+	inputs.property("jarPrefix", modNameStripped)
+	
+	filesMatching(listOf("fabric.mod.json", "META-INF/jarjar/metadata.json")) {
+		expand(inputs.properties)
+	}
 }
 
 tasks.assemble {
-	finalizedBy(copyJars)
+	finalizedBy(multiloaderJar)
 }

gradle.properties

@@ -7,17 +7,23 @@ modVersion=1.2.0
 modLicense=Unlicense
 modSourcesURL=https://github.com/chylex/Minecraft-Window-Title
 modIssuesURL=https://github.com/chylex/Minecraft-Window-Title/issues
+modSides=client
 
 # Dependencies
-minecraftVersion=1.20
-neoForgeVersion=20.2.44-beta
-fabricVersion=0.14.21
-loomVersion=1.3
-mixinVersion=0.8.5
+minecraftVersion=1.21
+neoForgeVersion=21.0.0-beta
+neoGradleVersion=7.0.152
+fabricVersion=0.15.11
+loomVersion=1.7
+mixinVersion=0.12.5+mixin.0.8.5
+
+# https://projects.neoforged.net/neoforged/neogradle/
+# https://fabricmc.net/develop/
+# https://github.com/FabricMC/fabric-loom/releases
 
 # Constraints
-minimumMinecraftVersion=1.20
-minimumNeoForgeVersion=20.2.43
+minimumMinecraftVersion=1.21
+minimumNeoForgeVersion=21.0.0-beta
 minimumFabricVersion=0.12.3
 
 # Gradle

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -144,7 +145,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
@@ -152,7 +153,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -201,11 +202,11 @@ fi
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradlew.bat

@@ -43,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -57,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

settings.gradle.kts

@@ -5,18 +5,18 @@ pluginManagement {
 		gradlePluginPortal()
 		maven(url = "https://maven.neoforged.net/releases") { name = "NeoForge" }
 		maven(url = "https://maven.fabricmc.net/") { name = "Fabric" }
-		maven(url = "https://repo.spongepowered.org/repository/maven-public/") { name = "Sponge Snapshots" }
 	}
 	
 	plugins {
-		if (settings.extra.has("neoForgeVersion")) {
-			id("net.neoforged.gradle.vanilla") version "7.0.41"
-			id("net.neoforged.gradle.userdev") version "7.0.41"
-			id("net.neoforged.gradle.mixin") version "7.0.41"
+		val neoGradleVersion = settings.extra.get("neoGradleVersion") as? String
+		if (neoGradleVersion != null) {
+			id("net.neoforged.gradle.userdev") version neoGradleVersion
+			id("net.neoforged.gradle.mixin") version neoGradleVersion
 		}
 		
-		if (settings.extra.has("loomVersion")) {
-			id("fabric-loom") version "${settings.extra["loomVersion"]}-SNAPSHOT"
+		val loomVersion = settings.extra.get("loomVersion") as? String
+		if (loomVersion != null) {
+			id("fabric-loom") version "$loomVersion-SNAPSHOT"
 		}
 	}
 }

src/main/java/chylex/customwindowtitle/data/CommonTokenData.java

@@ -8,6 +8,7 @@ public final class CommonTokenData {
 	public static void register(final CommonTokenProvider provider) {
 		registerToken("mcversion", noArgs(provider::getMinecraftVersion));
 		registerToken("modversion", oneArg(provider::getModVersion));
+		registerToken("username", noArgs(provider::getUsername));
 	}
 	
 	private CommonTokenData() {}

src/main/java/chylex/customwindowtitle/data/CommonTokenProvider.java

@@ -1,6 +1,7 @@
 package chylex.customwindowtitle.data;
 
 import net.minecraft.SharedConstants;
+import net.minecraft.client.Minecraft;
 
 public interface CommonTokenProvider {
 	default String getMinecraftVersion() {
@@ -8,4 +9,8 @@ public interface CommonTokenProvider {
 	}
 	
 	String getModVersion(final String modId);
+	
+	default String getUsername() {
+		return Minecraft.getInstance().getUser().getName();
+	}
 }

src/multiloader/resources/META-INF/jarjar/metadata.json

@@ -0,0 +1,13 @@
+{
+  "jars": [{
+    "identifier": {
+      "group": "${group}",
+      "artifact": "${id}"
+    },
+    "version": {
+      "artifactVersion": "${version}",
+      "range": "[${version}]"
+    },
+    "path": "jars/${jarPrefix}-NeoForge.jar"
+  }]
+}

src/multiloader/resources/fabric.mod.json

@@ -0,0 +1,32 @@
+{
+  "schemaVersion": 1,
+  "id": "${id}_multiloader",
+  "name": "${name} (Multiloader)",
+  "description": "${description}",
+  "version": "${version}",
+  "license": "${license}",
+  
+  "authors": [
+    "${author}"
+  ],
+  
+  "contact": {
+    "homepage": "https://chylex.com",
+    "issues": "${issuesURL}",
+    "sources": "${sourcesURL}"
+  },
+  
+  "environment": "${sidesForFabric}",
+  
+  "jars": [{
+      "file": "jars/${jarPrefix}-Fabric.jar"
+  }],
+  
+  "custom": {
+    "modmenu": {
+      "parent": "${id}",
+      "badges": [ "library" ],
+      "update_checker": false
+    }
+  }
+}