1
0
mirror of https://github.com/chylex/Minecraft-Window-Title.git synced 2025-08-17 17:31:42 +02:00

27 Commits

Author SHA1 Message Date
2a17b46a1d Release 1.4.1 for Minecraft 1.21 or newer 2025-03-07 03:30:32 +01:00
Niels Pilgaard Grøndahl
5e64fd81e3 Fix crash on Linux 2025-03-05 01:57:28 +01:00
425eb3f380 Refactor changing window title 2025-01-29 18:48:36 +01:00
43698d23b5 Update Gradle and build scripts for Minecraft 1.21.4 2025-01-29 18:48:36 +01:00
dbbd5b60f5 Update FUNDING.yml 2025-01-29 16:27:29 +01:00
73dab6b277 Fix errors in README 2024-10-19 14:21:39 +02:00
3de5e01e32 Release 1.4.0 for Minecraft 1.21 or newer 2024-10-19 14:02:33 +02:00
05a081364d Migrate from NeoGradle to ModDevGradle 2024-10-19 13:16:03 +02:00
Kolotheegg
941ece888b Reimplement icon support 2024-10-19 13:11:53 +02:00
ba22745940 Update README and CurseForge description text & add Modrinth description text 2024-07-03 23:15:01 +02:00
13e6e63e81 Release 1.3.0 for Minecraft 1.21 or newer 2024-07-03 22:52:50 +02:00
44a10a09ca Add documentation for {username} token 2024-07-03 06:10:54 +02:00
701543c1e8 Add {username} token
Closes #8
2024-07-03 05:59:29 +02:00
ef0031a3dd Update for Minecraft 1.21 2024-07-03 05:53:10 +02:00
8a9e287061 Update Gradle and build scripts for Minecraft 1.21 & switch to one multiloader jar 2024-07-03 03:33:36 +02:00
c6b0e485de Update to NeoForge + Gradle 8.2.1 2023-11-10 12:39:08 +01:00
8190b1e1c1 Revert to Gradle 7 and ForgeGradle 5 2023-06-13 16:06:17 +02:00
cb81efe63b Update README 2023-06-13 00:59:02 +02:00
0ebd3a9ef3 Forge is broken 2023-06-13 00:52:47 +02:00
ddc0e4595a Release 1.2.0 for Minecraft 1.20 or newer 2023-06-13 00:29:10 +02:00
335c8cf87b Update for Minecraft 1.20 (excluding customizable icon) 2023-06-13 00:23:06 +02:00
e2fb18fdef Update Gradle and build scripts for Minecraft 1.20 2023-06-13 00:07:43 +02:00
8b12ddc7c7 Update .gitignore and mods.toml 2023-06-12 23:29:24 +02:00
02d6f2a63d Fix minimum Minecraft version constraint 2023-01-06 17:44:54 +01:00
30a12716b6 Release v1.1.2 for Minecraft 1.19.3 or newer 2023-01-06 17:30:10 +01:00
5325cdf282 Release v1.1.1 for Minecraft 1.19 or newer 2023-01-06 16:17:35 +01:00
6c4892dcd0 Update build scripts 2023-01-04 06:53:55 +01:00
39 changed files with 946 additions and 559 deletions

2
.github/FUNDING.yml vendored
View File

@@ -1,3 +1 @@
github: chylex
patreon: chylex
ko_fi: chylex

51
.gitignore vendored
View File

@@ -1,29 +1,30 @@
bin/
[Bb]uild/
eclipse/
run/
out/
# gradle
.gradle/
.idea/$CACHE_FILE$
.idea/codeStyles/
.idea/compiler.xml
.idea/dictionaries
.idea/inspectionProfiles/
.idea/jarRepositories.xml
.idea/libraries/
.idea/misc.xml
.idea/modules/
.idea/modules.xml
.idea/runConfigurations/
.idea/shelf/
.idea/uiDesigner.xml
.idea/workspace.xml
.settings/
.updateclasses/
.classpath
.project
.DS_Store
build/
out/
classes/
# eclipse
*.launch
# idea
.idea/
*.iml
*.ipr
*.iws
Thumbs.db
# vscode
.settings/
.vscode/
bin/
.classpath
.project
# fabric
run/
logs/

5
.idea/gradle.xml generated
View File

@@ -4,15 +4,12 @@
<component name="GradleSettings">
<option name="linkedExternalProjectsSettings">
<GradleProjectSettings>
<option name="delegatedBuild" value="true" />
<option name="testRunner" value="GRADLE" />
<option name="distributionType" value="DEFAULT_WRAPPED" />
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="modules">
<set>
<option value="$PROJECT_DIR$" />
<option value="$PROJECT_DIR$/Fabric" />
<option value="$PROJECT_DIR$/Forge" />
<option value="$PROJECT_DIR$/NeoForge" />
</set>
</option>
</GradleProjectSettings>

View File

@@ -1,30 +0,0 @@
<h2>Installation</h2>
<p>The mod supports <a href="https://files.minecraftforge.net/">Forge</a> and <a href="https://fabricmc.net/">Fabric</a> (*) mod loaders. Follow either mod loader's installation guide, then <a href="https://www.curseforge.com/minecraft/mc-mods/custom-window-title/files">download the mod file</a> for your Minecraft version and mod loader, and install it into the <strong>.minecraft/mods</strong> folder.</p>
<p>(*) Fabric API is <strong>not</strong> required.</p>
<h2>Configuration</h2>
<p>Run the game once to create the configuration file. By default, the window title will be set to <strong>Minecraft <em>&lt;version&gt;</em></strong>. Unlike in vanilla 1.15.2 onwards, the title will not change when you enter a world/server.</p>
<p>To change the title or icon, navigate to the <strong>.minecraft/config</strong> folder, and open <strong>customwindowtitle-client.toml</strong> in a text editor. You will see the following entries:</p>
<p><span style="font-family: courier new,courier,monospace;">title = '<span style="color: #808000;">Minecraft {mcversion}</span>'</span><br /> <span style="font-family: courier new,courier,monospace;">icon16 = ''</span><br /> <span style="font-family: courier new,courier,monospace;">icon32 = ''</span></p>
<p>Only edit text inside quotes or apostrophes.</p>
<h3>Changing the Title</h3>
<p>You can use the following special tokens in the <em>title</em> configuration entry:</p>
<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>
</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>
<p>You must create two PNG images with sizes 16x16 and 32x32 pixels. The images <strong>must be saved with transparency</strong> even if they don't use it, <strong>otherwise the icons will appear corrupted</strong>. In Krita for example, you must check <em>Store alpha channel (transparency)</em> when saving the image.</p>
<p>The <em>icon16</em> and <em>icon32</em> configuration entries point to the PNG files relative to the <strong>.minecraft/config</strong> folder. For example, if you place the two icons in a folder named <em>customwindowtitle</em> as follows:</p>
<ul>
<li><span style="font-family: courier new, courier, monospace;">.minecraft/config/<span style="color: #008080;">customwindowtitle-client.toml</span></span></li>
<li><span style="font-family: courier new, courier, monospace;">.minecraft/config/<span style="color: #808000;">customwindowtitle/icon16.png</span></span></li>
<li><span style="font-family: courier new, courier, monospace;">.minecraft/config/<span style="color: #808000;">customwindowtitle/icon32.png</span></span></li>
</ul>
<p>Then, the two icon entries should look like this:</p>
<p><span style="font-family: courier new,courier,monospace;">icon16 = '<span style="color: #808000;">customwindowtitle/icon16.png</span>'</span><br /> <span style="font-family: courier new,courier,monospace;">icon32 = '<span style="color: #808000;">customwindowtitle/icon32.png</span>'</span></p>
<p><strong>Custom icons require Custom Window Title 1.1.0 or newer.</strong></p>
<h2>Screenshots</h2>
<p>These screenshots were taken using the following example configuration:</p>
<p><span style="font-family: courier new,courier,monospace;">title = "<span style="color: #808000;">Minecraft {mcversion} - Custom Window Title {modversion:customwindowtitle}</span>"</span></p>
<p><img src="https://media.forgecdn.net/attachments/277/212/customwindowtitlefabric.png" width="417" height="284" /><img src="https://media.forgecdn.net/attachments/277/213/customwindowtitleforge.png" alt="" width="417" height="284" /></p>

View File

@@ -1,10 +1,13 @@
import net.fabricmc.loom.configuration.ide.RunConfigSettings
import org.gradle.jvm.tasks.Jar
val modId: String by project
val modSides: String by project
val minecraftVersion: String by project
val fabricVersion: String by project
plugins {
idea
id("fabric-loom") version "0.10-SNAPSHOT"
id("fabric-loom")
}
dependencies {
@@ -15,16 +18,36 @@ dependencies {
loom {
runs {
named("client") {
val runJvmArgs: Set<String> by project
configureEach {
runDir("../run")
vmArgs(runJvmArgs)
ideConfigGenerated(true)
}
fun side(name: String, configure: RunConfigSettings.() -> Unit) {
if (modSides == "both" || modSides == name) {
named(name, configure)
}
else {
findByName(name)?.let(::remove)
}
}
side("client") {
configName = "Fabric Client"
client()
runDir("../run")
ideConfigGenerated(true)
}
side("server") {
configName = "Fabric Server"
server()
}
}
mixin {
add(sourceSets.main.get(), "$modId.refmap.json")
defaultRefmapName.set("$modId.refmap.json")
}
}
@@ -34,6 +57,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.
}

View File

@@ -1,8 +1,8 @@
package chylex.customwindowtitle.fabric;
import chylex.customwindowtitle.TitleChanger;
import chylex.customwindowtitle.TitleConfig;
import chylex.customwindowtitle.TitleParser;
import chylex.customwindowtitle.data.CommonTokenData;
import com.mojang.blaze3d.platform.Window;
import net.fabricmc.api.ClientModInitializer;
import net.fabricmc.loader.api.FabricLoader;
import net.minecraft.client.Minecraft;
@@ -11,21 +11,12 @@ public class CustomWindowTitle implements ClientModInitializer {
private final TitleConfig config;
public CustomWindowTitle() {
config = TitleConfig.read(FabricLoader.getInstance().getConfigDirectory().getAbsolutePath());
config = TitleConfig.load(FabricLoader.getInstance().getConfigDir().toAbsolutePath().toString());
}
@Override
public void onInitializeClient() {
CommonTokenData.register(new TokenProvider());
Minecraft.getInstance().execute(this::updateTitle);
}
private void updateTitle() {
final Window window = Minecraft.getInstance().getWindow();
window.setTitle(TitleParser.parse(config.getTitle()));
if (config.hasIcon()) {
window.setIcon(config.readIcon16(), config.readIcon32());
}
Minecraft.getInstance().execute(() -> TitleChanger.setTitle(config));
}
}

View File

@@ -1,4 +1,5 @@
package chylex.customwindowtitle.fabric;
import chylex.customwindowtitle.TokenException;
import chylex.customwindowtitle.data.CommonTokenProvider;
import net.fabricmc.loader.api.FabricLoader;

View File

@@ -1,6 +1,6 @@
{
"schemaVersion": 1,
"id": "customwindowtitle",
"id": "${id}",
"name": "${name}",
"description": "${description}",
"version": "${version}",
@@ -16,18 +16,20 @@
"sources": "${sourcesURL}"
},
"environment": "client",
"environment": "${sidesForFabric}",
"entrypoints": {
"client": [
"chylex.customwindowtitle.fabric.CustomWindowTitle"
]
},
"mixins": [
"customwindowtitle.mixins.json"
],
"mixins": [{
"config": "${id}.mixins.json",
"environment": "${sidesForFabric}"
}],
"depends": {
"fabricloader": ">=0.7.2",
"minecraft": ">=1.17"
"fabricloader": ">=${minimumFabricVersion}",
"minecraft": ">=${minimumMinecraftVersion}"
}
}

View File

@@ -1,78 +0,0 @@
import net.minecraftforge.gradle.userdev.UserDevExtension
import org.gradle.api.file.DuplicatesStrategy.INCLUDE
import org.spongepowered.asm.gradle.plugins.MixinExtension
val modId: String by project
val minecraftVersion: String by project
val forgeVersion: String by project
val mixinVersion: String by project
buildscript {
repositories {
maven("https://maven.minecraftforge.net")
maven("https://repo.spongepowered.org/maven")
mavenCentral()
}
dependencies {
classpath(group = "net.minecraftforge.gradle", name = "ForgeGradle", version = "5.1.+") { isChanging = true }
classpath(group = "org.spongepowered", name = "mixingradle", version = "0.7-SNAPSHOT")
}
}
plugins {
java
eclipse
}
apply {
plugin("net.minecraftforge.gradle")
plugin("org.spongepowered.mixin")
}
dependencies {
"minecraft"("net.minecraftforge:forge:$minecraftVersion-$forgeVersion")
if (System.getProperty("idea.sync.active") != "true") {
annotationProcessor("org.spongepowered:mixin:$mixinVersion:processor")
}
}
configure<UserDevExtension> {
mappings("official", minecraftVersion)
runs {
create("client") {
taskName = "Client"
workingDirectory(rootProject.file("run"))
ideaModule("${rootProject.name}.${project.name}.main")
property("mixin.env.remapRefMap", "true")
property("mixin.env.refMapRemappingFile", "$projectDir/build/createSrgToMcp/output.srg")
arg("-mixin.config=$modId.mixins.json")
mods {
create(modId) {
source(sourceSets.main.get())
source(rootProject.sourceSets.main.get())
}
}
}
}
}
configure<MixinExtension> {
add(sourceSets.main.get(), "$modId.refmap.json")
}
tasks.processResources {
from(sourceSets.main.get().resources.srcDirs) {
include("META-INF/mods.toml")
expand(inputs.properties)
duplicatesStrategy = INCLUDE
}
}
tasks.jar {
finalizedBy("reobfJar")
}

View File

@@ -1,40 +0,0 @@
package chylex.customwindowtitle.forge;
import chylex.customwindowtitle.TitleConfig;
import chylex.customwindowtitle.TitleParser;
import chylex.customwindowtitle.data.CommonTokenData;
import com.mojang.blaze3d.platform.Window;
import net.minecraft.client.Minecraft;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fml.IExtensionPoint.DisplayTest;
import net.minecraftforge.fml.ModLoadingContext;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
import net.minecraftforge.fml.loading.FMLPaths;
import net.minecraftforge.fmllegacy.network.FMLNetworkConstants;
@Mod("customwindowtitle")
public class CustomWindowTitle {
private final TitleConfig config;
public CustomWindowTitle() {
config = TitleConfig.read(FMLPaths.CONFIGDIR.get().toString());
ModLoadingContext.get().registerExtensionPoint(DisplayTest.class, () -> new DisplayTest(() -> FMLNetworkConstants.IGNORESERVERONLY, (a, b) -> true));
FMLJavaModLoadingContext.get().getModEventBus().addListener(this::onClientSetup);
CommonTokenData.register(new TokenProvider());
}
@SubscribeEvent
public void onClientSetup(final FMLClientSetupEvent e) {
e.enqueueWork(this::updateTitle);
}
private void updateTitle() {
final Window window = Minecraft.getInstance().getWindow();
window.setTitle(TitleParser.parse(config.getTitle()));
if (config.hasIcon()) {
window.setIcon(config.readIcon16(), config.readIcon32());
}
}
}

View File

@@ -1,27 +0,0 @@
modLoader = "javafml"
loaderVersion = "[31,)"
authors = "${author}"
license = "${license}"
issueTrackerURL = "${issuesURL}"
[[mods]]
modId = "customwindowtitle"
version = "${version}"
displayName = "${name}"
description = "${description}"
displayURL = "${sourcesURL}"
[[dependencies.customwindowtitle]]
modId = "minecraft"
mandatory = true
versionRange = "[1.17,)"
ordering = "NONE"
side = "CLIENT"
[[dependencies.customwindowtitle]]
modId = "forge"
mandatory = true
versionRange = "[31.2.45,)"
ordering = "NONE"
side = "CLIENT"

View File

@@ -1,7 +0,0 @@
{
"pack": {
"description": "Custom Window Title",
"pack_format": 5,
"_comment": ""
}
}

51
NeoForge/build.gradle.kts Normal file
View File

@@ -0,0 +1,51 @@
import net.neoforged.moddevgradle.dsl.RunModel
val modId: String by project
val modSides: String by project
val neoForgeVersion: String by project
plugins {
id("net.neoforged.moddev")
}
neoForge {
version = neoForgeVersion
mods {
register(modId) {
sourceSet(sourceSets.main.get())
sourceSet(rootProject.sourceSets.main.get())
}
}
runs {
val runJvmArgs: Set<String> by project
configureEach {
gameDirectory = file("../run")
jvmArguments.addAll(runJvmArgs)
}
fun side(name: String, configure: RunModel.() -> Unit) {
if (modSides == "both" || modSides == name) {
register(name, configure)
}
}
side("client") {
ideName.set("NeoForge Client")
client()
}
side("server") {
ideName.set("NeoForge Server")
server()
}
}
}
tasks.processResources {
filesMatching("META-INF/neoforge.mods.toml") {
expand(inputs.properties)
}
}

View File

@@ -0,0 +1,27 @@
package chylex.customwindowtitle.neoforge;
import chylex.customwindowtitle.TitleChanger;
import chylex.customwindowtitle.TitleConfig;
import chylex.customwindowtitle.data.CommonTokenData;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.bus.api.SubscribeEvent;
import net.neoforged.fml.common.Mod;
import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent;
import net.neoforged.fml.loading.FMLPaths;
@Mod("customwindowtitle")
public class CustomWindowTitle {
private final TitleConfig config;
public CustomWindowTitle(IEventBus eventBus) {
config = TitleConfig.load(FMLPaths.CONFIGDIR.get().toString());
eventBus.addListener(this::onClientSetup);
}
@SubscribeEvent
public void onClientSetup(final FMLClientSetupEvent e) {
CommonTokenData.register(new TokenProvider());
e.enqueueWork(() -> TitleChanger.setTitle(config));
}
}

View File

@@ -1,9 +1,10 @@
package chylex.customwindowtitle.forge;
package chylex.customwindowtitle.neoforge;
import chylex.customwindowtitle.TokenException;
import chylex.customwindowtitle.data.CommonTokenProvider;
import net.minecraftforge.fml.ModList;
import net.minecraftforge.forgespi.language.IModFileInfo;
import net.minecraftforge.forgespi.language.IModInfo;
import net.neoforged.fml.ModList;
import net.neoforged.neoforgespi.language.IModFileInfo;
import net.neoforged.neoforgespi.language.IModInfo;
final class TokenProvider implements CommonTokenProvider {
@Override

View File

@@ -0,0 +1,30 @@
modLoader = "javafml"
loaderVersion = "[0,)"
license = "${license}"
issueTrackerURL = "${issuesURL}"
[[mods]]
modId = "${id}"
displayName = "${name}"
displayURL = "${sourcesURL}"
description = "${description}"
authors = "${author}"
version = "${version}"
[[mixins]]
config = "${id}.mixins.json"
[[dependencies.${id}]]
modId = "minecraft"
type = "required"
versionRange = "[${minimumMinecraftVersion},)"
ordering = "NONE"
side = "${sidesForNeoForge}"
[[dependencies.${id}]]
modId = "neoforge"
type = "required"
versionRange = "[${minimumNeoForgeVersion},)"
ordering = "NONE"
side = "${sidesForNeoForge}"

View File

@@ -2,7 +2,7 @@
## Installation
The mod supports [Forge](https://files.minecraftforge.net/) and [Fabric](https://fabricmc.net/) (*) mod loaders, **the same mod file will work in both**. Follow either mod loader's installation guide, then [download the mod file](https://www.curseforge.com/minecraft/mc-mods/custom-window-title/files) for your Minecraft version, and install it into the **.minecraft/mods** folder.
The mod supports [NeoForge](https://neoforged.net/) and [Fabric](https://fabricmc.net/) (*) mod loaders. Follow either mod loader's installation guide, then download the mod file for your Minecraft version from [CurseForge](https://www.curseforge.com/minecraft/mc-mods/custom-window-title/files) or [Modrinth](https://modrinth.com/mod/custom-window-title/versions), and install it into the `.minecraft/mods` folder.
(*) Fabric API is **not** required.
@@ -10,12 +10,11 @@ The mod supports [Forge](https://files.minecraftforge.net/) and [Fabric](https:/
Run the game once to create the configuration file. By default, the window title will be set to **Minecraft _<version>_**. Unlike in vanilla 1.15.2 onwards, the title will not change when you enter a world/server.
To change the title or icon, navigate to the **.minecraft/config** folder, and open **customwindowtitle-client.toml** in a text editor. You will see the following entries:
To change the title or icon, navigate to the `.minecraft/config` folder, and open `customwindowtitle-client.toml` in a text editor. You will see the following entries:
```toml
title = 'Minecraft {mcversion}'
icon16 = ''
icon32 = ''
icon = ''
```
Only edit text inside quotes or apostrophes.
@@ -24,28 +23,38 @@ Only edit text inside quotes or apostrophes.
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_
* `{mcversion}` - current Minecraft version
* `{modversion:<mod_id>}` - version of installed mod with the identifier `<mod_id>`
* `{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.
### Changing the Icon
You must create two PNG images with sizes 16x16 and 32x32 pixels. The images **must be saved with transparency** even if they don't use it, **otherwise the icons will appear corrupted**. In Krita for example, you must check _Store alpha channel (transparency)_ when saving the image.
#### Minecraft 1.21+
The _icon16_ and _icon32_ configuration entries point to the PNG files relative to the **.minecraft/config** folder. For example, if you place the two icons in a folder named _customwindowtitle_ as follows:
**This feature is only available in Custom Window Title 1.4.0 and newer.**
* `.minecraft/config/customwindowtitle-client.toml`
* `.minecraft/config/customwindowtitle/icon16.png`
* `.minecraft/config/customwindowtitle/icon32.png`
Create a square PNG image whose dimensions are a power of two, such as 32x32 or 48x48. Put the PNG file into the `.minecraft/config` folder, either directly or into a subfolder.
Then, the two icon entries should look like this:
The icon **must be saved with transparency** even if it doesn't use it, otherwise the icon may be corrupted or not appear at all. In Krita, for example, you must check _Store alpha channel (transparency)_ when saving.
The _icon_ configuration entry points to the PNG file relative to `.minecraft/config`.
For example, if you placed the icon into `.minecraft/config/customwindowtitle/icon.png`, then the configuration entry should look like this:
```toml
icon16 = 'customwindowtitle/icon16.png'
icon32 = 'customwindowtitle/icon32.png'
icon = 'customwindowtitle/icon.png'
```
#### Minecraft 1.20
This feature is not available in Minecraft 1.20.
#### Minecraft 1.19 and older
Instead of one `icon` configuration entry, there are two configuration entries `icon16` and `icon32` for icons with dimensions 16x16 and 32x32.
## Screenshots
These screenshots were taken using the following example configuration:
@@ -61,10 +70,8 @@ title = "Minecraft {mcversion} - Custom Window Title {modversion:customwindowtit
The mod sources are organized into 3 projects:
- `src/` contains common source files and mixins
- `Fabric/src/` contains source files specific for Fabric
- `Forge/src/` contains source files specific for Forge
- `NeoForge/src/` contains source files specific for NeoForge
The Gradle project provides the following tasks:
- `setupIdea` generates Minecraft sources and run configurations for IntelliJ IDEA
- `assemble` creates 2 `.jar` files in the `build/dist` folder - one for Forge, one for Fabric
The `assemble` Gradle task creates a single `.jar` file for both mod loaders in the `build/dist` folder.
When building against a Minecraft version that is only supported by one mod loader, open `gradle.properties` and comment or remove either `forgeVersion` or `fabricVersion` to disable them.
When building against a Minecraft version that is only supported by one mod loader, open `gradle.properties` and comment or remove either `neoForgeVersion` or `fabricVersion` to disable them.

View File

@@ -1,6 +1,6 @@
import org.gradle.api.file.DuplicatesStrategy.EXCLUDE
import java.text.SimpleDateFormat
import java.util.Date
@file:Suppress("ConvertLambdaToReference")
import org.gradle.jvm.tasks.Jar
val modId: String by project
val modName: String by project
@@ -10,23 +10,21 @@ 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
val modNameStripped = modName.replace(" ", "")
val jarVersion = "$minecraftVersion+v$modVersion"
val minimumMinecraftVersion: String by project
val minimumNeoForgeVersion: String by project
val minimumFabricVersion: String by project
buildscript {
repositories {
maven("https://repo.spongepowered.org/maven")
}
}
val modNameStripped = modName.replace(" ", "")
plugins {
`java-library`
idea
id("org.spongepowered.gradle.vanilla") version "0.2.1-SNAPSHOT"
`java-library`
id("fabric-loom")
}
idea {
@@ -34,8 +32,8 @@ idea {
excludeDirs.add(file("gradle"))
excludeDirs.add(file("run"))
if (findProject(":Forge") == null) {
excludeDirs.add(file("Forge"))
if (findProject(":NeoForge") == null) {
excludeDirs.add(file("NeoForge"))
}
if (findProject(":Fabric") == null) {
@@ -45,64 +43,67 @@ idea {
}
repositories {
maven("https://repo.spongepowered.org/maven")
mavenCentral()
}
dependencies {
implementation("org.spongepowered:mixin:$mixinVersion")
api("com.google.code.findbugs:jsr305:3.0.2")
}
base {
archivesName.set("$modNameStripped-Common")
}
minecraft {
version(minecraftVersion)
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 {
group = "com.$modAuthor.$modId"
version = modVersion
apply(plugin = "java")
dependencies {
implementation("org.jetbrains:annotations:22.0.0")
}
apply(plugin = "java-library")
extensions.getByType<JavaPluginExtension>().apply {
toolchain.languageVersion.set(JavaLanguageVersion.of(16))
toolchain.languageVersion.set(JavaLanguageVersion.of(21))
}
tasks.withType<JavaCompile> {
options.encoding = "UTF-8"
options.release.set(16)
options.release.set(21)
}
}
subprojects {
repositories {
maven("https://repo.spongepowered.org/maven")
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(rootProject)
implementation("org.jetbrains:annotations:24.1.0")
}
base {
archivesName.set("$modNameStripped-${project.name}")
}
tasks.withType<JavaCompile> {
source({ rootProject.sourceSets.main.get().allSource })
}
tasks.processResources {
from(rootProject.sourceSets.main.get().resources)
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)
@@ -110,56 +111,104 @@ subprojects {
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)
from(rootProject.file("logo.png")) {
into("assets/$modId")
}
}
tasks.withType<AbstractArchiveTask>().configureEach {
isPreserveFileTimestamps = false
isReproducibleFileOrder = true
}
}
subprojects {
dependencies {
implementation(project(rootProject.path, configuration = "namedElements"))
}
base {
archivesName.set("$modNameStripped-${project.name}")
}
tasks.compileJava {
source({ rootProject.sourceSets.main.get().allSource })
}
tasks.processResources {
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,
"Implementation-Timestamp" to SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").format(Date()),
"MixinConfigs" to "$modId.mixins.json"
)
packageInformation(modId, "$modNameStripped-${project.name}")
}
}
}
tasks.register("setupIdea") {
group = "mod"
dependsOn(tasks.findByName("decompile"))
val forge = findProject(":Forge")
if (forge != null) {
dependsOn(forge.tasks.getByName("genIntellijRuns"))
}
val fabric = findProject(":Fabric")
if (fabric != null) {
dependsOn(fabric.tasks.getByName("genSources"))
tasks.test {
onlyIf { false }
}
}
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)
}

65
docs/CURSEFORGE.md Normal file
View File

@@ -0,0 +1,65 @@
## Installation
The mod supports [NeoForge](https://neoforged.net/) and [Fabric](https://fabricmc.net/) (*) mod loaders. Follow either mod loader's installation guide, then [download the mod file](https://www.curseforge.com/minecraft/mc-mods/custom-window-title/files) for your Minecraft version, and install it into the `.minecraft/mods` folder.
(*) Fabric API is **not** required.
## Configuration
Run the game once to create the configuration file. By default, the window title will be set to **Minecraft _<version>_**. Unlike in vanilla 1.15.2 onwards, the title will not change when you enter a world/server.
To change the title or icon, navigate to the `.minecraft/config` folder, and open `customwindowtitle-client.toml` in a text editor. You will see the following entries:
```toml
title = 'Minecraft {mcversion}'
icon16 = ''
icon32 = ''
```
Only edit text inside quotes or apostrophes.
### Changing the Title
You can use the following special tokens in the _title_ configuration entry:
* `{mcversion}` - current Minecraft version
* `{modversion:mod_id}` - version of installed mod with the identifier `mod_id`
* `{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.
### Changing the Icon
#### Minecraft 1.21+
**This feature is only available in Custom Window Title 1.4.0 and newer.**
Create a square PNG image whose dimensions are a power of two, such as 32x32 or 48x48. Put the PNG file into the `.minecraft/config` folder, either directly or into a subfolder.
The icon **must be saved with transparency** even if it doesn't use it, otherwise the icon may be corrupted or not appear at all. In Krita, for example, you must check _Store alpha channel (transparency)_ when saving.
The _icon_ configuration entry points to the PNG file relative to `.minecraft/config`.
For example, if you placed the icon into `.minecraft/config/customwindowtitle/icon.png`, then the configuration entry should look like this:
```toml
icon = 'customwindowtitle/icon.png'
```
#### Minecraft 1.20
This feature is not available in Minecraft 1.20.
#### Minecraft 1.19 and older
Instead of one `icon` configuration entry, there are two configuration entries `icon16` and `icon32` for icons with dimensions 16x16 and 32x32.
## Screenshots
These screenshots were taken using the following example configuration:
```toml
title = "Minecraft {mcversion} - Custom Window Title {modversion:customwindowtitle}"
```
<img src="https://media.forgecdn.net/attachments/277/212/customwindowtitlefabric.png" width="417" height="284"><img src="https://media.forgecdn.net/attachments/277/213/customwindowtitleforge.png" alt="" width="417" height="284">

66
docs/MODRINTH.md Normal file
View File

@@ -0,0 +1,66 @@
## Installation
The mod supports [NeoForge](https://neoforged.net/) and [Fabric](https://fabricmc.net/) (*) mod loaders. Follow either mod loader's installation guide, then [download the mod file](https://modrinth.com/mod/custom-window-title/versions) for your Minecraft version, and install it into the `.minecraft/mods` folder.
(*) Fabric API is **not** required.
## Configuration
Run the game once to create the configuration file. By default, the window title will be set to **Minecraft _<version>_**. Unlike in vanilla 1.15.2 onwards, the title will not change when you enter a world/server.
To change the title or icon, navigate to the `.minecraft/config` folder, and open `customwindowtitle-client.toml` in a text editor. You will see the following entries:
```toml
title = 'Minecraft {mcversion}'
icon16 = ''
icon32 = ''
```
Only edit text inside quotes or apostrophes.
### Changing the Title
You can use the following special tokens in the _title_ configuration entry:
* `{mcversion}` - current Minecraft version
* `{modversion:<mod_id>}` - version of installed mod with the identifier `<mod_id>`
* `{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.
### Changing the Icon
#### Minecraft 1.21+
**This feature is only available in Custom Window Title 1.4.0 and newer.**
Create a square PNG image whose dimensions are a power of two, such as 32x32 or 48x48. Put the PNG file into the `.minecraft/config` folder, either directly or into a subfolder.
The icon **must be saved with transparency** even if it doesn't use it, otherwise the icon may be corrupted or not appear at all. In Krita, for example, you must check _Store alpha channel (transparency)_ when saving.
The _icon_ configuration entry points to the PNG file relative to `.minecraft/config`.
For example, if you placed the icon into `.minecraft/config/customwindowtitle/icon.png`, then the configuration entry should look like this:
```toml
icon = 'customwindowtitle/icon.png'
```
#### Minecraft 1.20
This feature is not available in Minecraft 1.20.
#### Minecraft 1.19 and older
Instead of one `icon` configuration entry, there are two configuration entries `icon16` and `icon32` for icons with dimensions 16x16 and 32x32.
## Screenshots
These screenshots were taken using the following example configuration:
```toml
title = "Minecraft {mcversion} - Custom Window Title {modversion:customwindowtitle}"
```
![Screenshot 1](https://cdn.modrinth.com/data/RGH5gtzF/images/583e2cde5254f758f890abe5d018f46201dd856e.png)
![Screenshot 2](https://cdn.modrinth.com/data/RGH5gtzF/images/68b89c57f5505625c2cff00fd5fe7489571dcae3.png)

View File

@@ -3,16 +3,29 @@ modId=customwindowtitle
modName=Custom Window Title
modDescription=Customize window title and icon.
modAuthor=chylex
modVersion=1.1.1
modVersion=1.4.1
modLicense=Unlicense
modSourcesURL=https://github.com/chylex/Minecraft-Window-Title
modIssuesURL=https://github.com/chylex/Minecraft-Window-Title/issues
modSides=client
# Dependencies
minecraftVersion=1.17.1
forgeVersion=37.0.75
fabricVersion=0.11.7
mixinVersion=0.8.4
minecraftVersion=1.21.4
neoForgeVersion=21.4.77-beta
neoModDevVersion=2.0.76
fabricVersion=0.16.10
loomVersion=1.9
mixinVersion=0.12.5+mixin.0.8.5
# https://projects.neoforged.net/neoforged/neoforge
# https://projects.neoforged.net/neoforged/moddevgradle
# https://fabricmc.net/develop/
# https://github.com/FabricMC/fabric-loom/releases
# Constraints
minimumMinecraftVersion=1.21
minimumNeoForgeVersion=21.0.0-beta
minimumFabricVersion=0.12.3
# Gradle
org.gradle.jvmargs=-Xmx3G

Binary file not shown.

View File

@@ -1,5 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

296
gradlew vendored
View File

@@ -1,7 +1,7 @@
#!/usr/bin/env bash
#!/bin/sh
#
# Copyright 2015 the original author or authors.
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -15,69 +15,103 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#
##############################################################################
##
## Gradle start up script for UN*X
##
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# 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/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# 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"'
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
MAX_FD=maximum
warn () {
echo "$*"
}
} >&2
die () {
echo
echo "$*"
echo
exit 1
}
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MSYS* | MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
@@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD="$JAVA_HOME/bin/java"
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
@@ -98,86 +132,120 @@ Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
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=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
ARGV=("$@")
eval set -- $DEFAULT_JVM_OPTS
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
IFS=$'
' read -rd '' -a JAVA_OPTS_ARR <<< "$(echo $JAVA_OPTS | xargs -n1)"
IFS=$'
' read -rd '' -a GRADLE_OPTS_ARR <<< "$(echo $GRADLE_OPTS | xargs -n1)"
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
exec "$JAVACMD" "$@" "${JAVA_OPTS_ARR[@]}" "${GRADLE_OPTS_ARR[@]}" "-Dorg.gradle.appname=$APP_BASE_NAME" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "${ARGV[@]}"
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
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, 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" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

37
gradlew.bat vendored
View File

@@ -13,8 +13,10 @@
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@rem SPDX-License-Identifier: Apache-2.0
@rem
@if "%DEBUG%" == "" @echo off
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@@ -25,7 +27,8 @@
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
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
@@ -56,11 +59,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
@@ -75,13 +78,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal

View File

@@ -3,13 +3,25 @@ rootProject.name = "Minecraft-Window-Title"
pluginManagement {
repositories {
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 {
val neoModDevVersion = settings.extra.get("neoModDevVersion") as? String
if (neoModDevVersion != null) {
id("net.neoforged.moddev") version neoModDevVersion
}
val loomVersion = settings.extra.get("loomVersion") as? String
if (loomVersion != null) {
id("fabric-loom") version "$loomVersion-SNAPSHOT"
}
}
}
if (settings.extra.has("forgeVersion")) {
include("Forge")
if (settings.extra.has("neoForgeVersion")) {
include("NeoForge")
}
if (settings.extra.has("fabricVersion")) {

View File

@@ -0,0 +1,65 @@
package chylex.customwindowtitle;
import net.minecraft.client.Minecraft;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.lwjgl.glfw.GLFW;
import org.lwjgl.glfw.GLFWImage;
import org.lwjgl.stb.STBImage;
import org.lwjgl.system.MemoryStack;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.IntBuffer;
import java.nio.file.Files;
import java.nio.file.Path;
public final class IconChanger {
private static final Logger LOGGER = LogManager.getLogger("CustomWindowTitle");
private IconChanger() {}
public static void setIcon(Path iconPath) {
long windowHandle = Minecraft.getInstance().getWindow().getWindow();
setWindowIcon(windowHandle, iconPath);
}
private static void setWindowIcon(long windowHandle, Path iconPath) {
ByteBuffer icon = null;
try (MemoryStack stack = MemoryStack.stackPush()) {
IntBuffer w = stack.mallocInt(1);
IntBuffer h = stack.mallocInt(1);
IntBuffer channels = stack.mallocInt(1);
icon = loadIcon(iconPath, w, h, channels);
if (icon == null) {
return;
}
try (GLFWImage.Buffer icons = GLFWImage.malloc(1)) {
GLFWImage iconImage = icons.get(0);
iconImage.set(w.get(0), h.get(0), icon);
GLFW.glfwSetWindowIcon(windowHandle, icons);
}
} catch (Exception e) {
LOGGER.error("Failed to set window icon from path: {}", iconPath, e);
} finally {
if (icon != null) {
STBImage.stbi_image_free(icon);
}
}
}
private static ByteBuffer loadIcon(Path path, IntBuffer w, IntBuffer h, IntBuffer channels) throws IOException {
byte[] iconBytes = Files.readAllBytes(path);
ByteBuffer buffer = ByteBuffer.allocateDirect(iconBytes.length).put(iconBytes).flip();
ByteBuffer icon = STBImage.stbi_load_from_memory(buffer, w, h, channels, 4);
if (icon == null) {
LOGGER.error("Failed to load image from path: {} - {}", path, STBImage.stbi_failure_reason());
}
return icon;
}
}

View File

@@ -0,0 +1,11 @@
package chylex.customwindowtitle;
import net.minecraft.client.Minecraft;
public final class TitleChanger {
private TitleChanger() {}
public static void setTitle(TitleConfig config) {
Minecraft.getInstance().getWindow().setTitle(TitleParser.parse(config.getTitle()));
}
}

View File

@@ -1,79 +1,89 @@
package chylex.customwindowtitle;
import com.google.common.collect.ImmutableMap;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.stream.Collectors;
public final class TitleConfig {
private static final Map<String, String> DEFAULTS;
private static final String KEY_TITLE = "title";
private static final String KEY_ICON = "icon";
static {
final Map<String, String> defaults = new LinkedHashMap<>();
private static final ImmutableMap<String, String> DEFAULTS = ImmutableMap.<String, String>builder()
.put(KEY_TITLE, "Minecraft {mcversion}")
.put(KEY_ICON, "")
.buildOrThrow();
defaults.put("title", "Minecraft {mcversion}");
defaults.put("icon16", "");
defaults.put("icon32", "");
private static volatile TitleConfig instance;
DEFAULTS = Collections.unmodifiableMap(defaults);
public static TitleConfig getInstance() {
return instance;
}
public static TitleConfig read(final String folder) {
final Path configFile = Paths.get(folder, "customwindowtitle-client.toml");
final Map<String, String> config = new LinkedHashMap<>(DEFAULTS);
public static TitleConfig load(String folder) {
if (instance != null) {
throw new IllegalStateException("TitleConfig has already been loaded and cannot be loaded again.");
}
if (instance == null) {
synchronized(TitleConfig.class) {
if (instance == null) {
instance = loadImpl(folder);
}
}
}
return instance;
}
private static TitleConfig loadImpl(String folder) {
Path configFile = Paths.get(folder, "customwindowtitle-client.toml");
Map<String, String> config = new LinkedHashMap<>(DEFAULTS);
try {
if (!Files.exists(configFile)) {
Files.write(configFile, config.entrySet().stream().map(entry -> String.format("%s = '%s'", entry.getKey(), entry.getValue())).collect(Collectors.toList()), StandardCharsets.UTF_8);
Files.write(configFile, config.entrySet().stream()
.map(entry -> String.format("%s = '%s'", entry.getKey(), entry.getValue()))
.collect(Collectors.toList()), StandardCharsets.UTF_8);
}
else {
Files.readAllLines(configFile, StandardCharsets.UTF_8).stream().map(String::trim).filter(line -> !line.isEmpty()).forEach(line -> {
final String[] split = line.split("=", 2);
Files.readAllLines(configFile, StandardCharsets.UTF_8).stream()
.map(String::trim)
.filter(line -> !line.isEmpty())
.forEach(line -> {
String[] split = line.split("=", 2);
if (split.length != 2) {
throw new RuntimeException("CustomWindowTitle configuration has an invalid line: " + line);
}
if (split.length != 2) {
throw new RuntimeException("CustomWindowTitle configuration has an invalid line: " + line);
}
final String key = split[0].trim();
final String value = parseTrimmedValue(split[1].trim());
String key = split[0].trim();
String value = parseTrimmedValue(split[1].trim());
if (config.containsKey(key)) {
config.put(key, value);
}
else {
throw new RuntimeException("CustomWindowTitle configuration has an invalid key: " + key);
}
});
if (config.containsKey(key)) {
config.put(key, value);
}
else {
throw new RuntimeException("CustomWindowTitle configuration has an invalid key: " + key);
}
});
}
} catch (final IOException e) {
} catch (IOException e) {
throw new RuntimeException("CustomWindowTitle configuration error", e);
}
final String icon16 = config.get("icon16");
final String icon32 = config.get("icon32");
final Path pathIcon16 = icon16.isEmpty() ? null : Paths.get(folder, icon16);
final Path pathIcon32 = icon32.isEmpty() ? null : Paths.get(folder, icon32);
if ((pathIcon16 == null) != (pathIcon32 == null)) {
throw new RuntimeException("CustomWindowTitle configuration specifies only one icon, both 'icon16' and 'icon32' must be set.");
String iconPathStr = config.get(KEY_ICON);
Path iconPath = iconPathStr.isEmpty() ? null : Paths.get(folder, iconPathStr);
if (iconPath != null && Files.notExists(iconPath)) {
throw new RuntimeException("CustomWindowTitle configuration points to a missing icon: " + iconPath);
}
if (pathIcon16 != null && Files.notExists(pathIcon16)) {
throw new RuntimeException("CustomWindowTitle 16x16 icon not found: " + pathIcon16);
}
if (pathIcon32 != null && Files.notExists(pathIcon32)) {
throw new RuntimeException("CustomWindowTitle 32x32 icon not found: " + pathIcon32);
}
return new TitleConfig(config.get("title"), pathIcon16, pathIcon32);
return new TitleConfig(config.get(KEY_TITLE), iconPath);
}
private static String parseTrimmedValue(String value) {
@@ -96,13 +106,11 @@ public final class TitleConfig {
}
private final String title;
private final Path icon16;
private final Path icon32;
private final Path icon;
private TitleConfig(final String title, final Path icon16, final Path icon32) {
private TitleConfig(final String title, final Path icon) {
this.title = title;
this.icon16 = icon16;
this.icon32 = icon32;
this.icon = icon;
}
public String getTitle() {
@@ -110,22 +118,10 @@ public final class TitleConfig {
}
public boolean hasIcon() {
return icon16 != null && icon32 != null;
return icon != null;
}
public InputStream readIcon16() {
try {
return Files.newInputStream(icon16, StandardOpenOption.READ);
} catch (final IOException e) {
throw new RuntimeException("CustomWindowTitle could not open the specified 16x16 icon: " + icon16, e);
}
}
public InputStream readIcon32() {
try {
return Files.newInputStream(icon32, StandardOpenOption.READ);
} catch (final IOException e) {
throw new RuntimeException("CustomWindowTitle could not open the specified 32x32 icon: " + icon16, e);
}
public Path getIconPath() {
return icon;
}
}

View File

@@ -1,4 +1,5 @@
package chylex.customwindowtitle;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
@@ -6,12 +7,12 @@ import org.apache.logging.log4j.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public final class TitleParser {
final class TitleParser {
private static final Pattern tokenRegex = Pattern.compile("\\{([a-z]+)(?::([^}]+))?}");
private static final Logger logger = LogManager.getLogger("CustomWindowTitle");
public static String parse(final String input) {
final StringBuffer buffer = new StringBuffer();
final StringBuilder buffer = new StringBuilder();
final Matcher matcher = tokenRegex.matcher(input);
while (matcher.find()) {

View File

@@ -1,4 +1,5 @@
package chylex.customwindowtitle;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;

View File

@@ -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() {}

View File

@@ -1,10 +1,16 @@
package chylex.customwindowtitle.data;
import net.minecraft.SharedConstants;
import net.minecraft.client.Minecraft;
public interface CommonTokenProvider {
default String getMinecraftVersion() {
return Minecraft.getInstance().getGame().getVersion().getName();
return SharedConstants.getCurrentVersion().getName();
}
String getModVersion(final String modId);
default String getUsername() {
return Minecraft.getInstance().getUser().getName();
}
}

View File

@@ -1,4 +1,5 @@
package chylex.customwindowtitle.mixin;
import net.minecraft.client.Minecraft;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.injection.At;

View File

@@ -0,0 +1,20 @@
package chylex.customwindowtitle.mixin;
import chylex.customwindowtitle.IconChanger;
import chylex.customwindowtitle.TitleConfig;
import net.minecraft.client.Minecraft;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
@Mixin(Minecraft.class)
public final class InitializeCustomIcon {
@Inject(method = "onResourceLoadFinished", at = @At("HEAD"))
private void onFinishedLoading(CallbackInfo callbackInfo) {
TitleConfig config = TitleConfig.getInstance();
if (config != null && config.hasIcon()) {
IconChanger.setIcon(config.getIconPath());
}
}
}

View File

@@ -3,9 +3,10 @@
"minVersion": "0.8",
"package": "chylex.customwindowtitle.mixin",
"refmap": "customwindowtitle.refmap.json",
"compatibilityLevel": "JAVA_16",
"compatibilityLevel": "JAVA_17",
"client": [
"DisableVanillaTitle"
"DisableVanillaTitle",
"InitializeCustomIcon"
],
"injectors": {
"defaultRequire": 1

View File

@@ -0,0 +1,7 @@
{
"pack": {
"description": "${name}",
"pack_format": 7,
"_comment": ""
}
}

View File

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

View File

@@ -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
}
}
}