1
0
mirror of https://github.com/chylex/Minecraft-Window-Title.git synced 2024-12-21 12:42:45 +01:00
Minecraft mod that lets you customize window title and icon. https://www.curseforge.com/minecraft/mc-mods/custom-window-title
Go to file
2024-10-19 14:21:39 +02:00
.github Update README 2020-09-16 17:11:06 +02:00
.idea Update to NeoForge + Gradle 8.2.1 2023-11-10 12:39:08 +01:00
docs Fix errors in README 2024-10-19 14:21:39 +02:00
Fabric Reimplement icon support 2024-10-19 13:11:53 +02:00
gradle/wrapper Update Gradle and build scripts for Minecraft 1.21 & switch to one multiloader jar 2024-07-03 03:33:36 +02:00
NeoForge Migrate from NeoGradle to ModDevGradle 2024-10-19 13:16:03 +02:00
src Reimplement icon support 2024-10-19 13:11:53 +02:00
.gitattributes Enforce LF line endings 2020-09-16 12:36:45 +02:00
.gitignore Update .gitignore and mods.toml 2023-06-12 23:29:24 +02:00
build.gradle.kts Migrate from NeoGradle to ModDevGradle 2024-10-19 13:16:03 +02:00
gradle.properties Release 1.4.0 for Minecraft 1.21 or newer 2024-10-19 14:02:33 +02:00
gradlew Update Gradle and build scripts for Minecraft 1.21 & switch to one multiloader jar 2024-07-03 03:33:36 +02:00
gradlew.bat Update Gradle and build scripts for Minecraft 1.21 & switch to one multiloader jar 2024-07-03 03:33:36 +02:00
LICENSE Initial commit 2020-01-30 21:53:38 +01:00
README.md Fix errors in README 2024-10-19 14:21:39 +02:00
settings.gradle.kts Migrate from NeoGradle to ModDevGradle 2024-10-19 13:16:03 +02:00

For Users

Installation

The mod supports NeoForge and Fabric (*) mod loaders. Follow either mod loader's installation guide, then download the mod file for your Minecraft version from CurseForge or Modrinth, 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 . 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:

title = 'Minecraft {mcversion}'  
icon = ''  

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 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:

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:

title = "Minecraft {mcversion} - Custom Window Title {modversion:customwindowtitle}"

For Developers

The mod sources are organized into 3 projects:

  • src/ contains common source files and mixins
  • Fabric/src/ contains source files specific for Fabric
  • NeoForge/src/ contains source files specific for NeoForge

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 neoForgeVersion or fabricVersion to disable them.