chylex/Minecraft-Window-Title
1
0
Fork 0
mirror of https://github.com/chylex/Minecraft-Window-Title.git synced 2024-11-14 17:42:49 +01:00
Code
1.19
Minecraft-Window-Title/README.md

3.2 KiB
Raw Permalink Blame History

For Users

Installation

The mod supports Forge and Fabric (*) mod loaders, the same mod file will work in both. Follow either mod loader's installation guide, then download the mod file 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 . 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}'  
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:modid} - version of installed mod with the identifier modid

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

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.

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:

  • .minecraft/config/customwindowtitle-client.toml
  • .minecraft/config/customwindowtitle/icon16.png
  • .minecraft/config/customwindowtitle/icon32.png

Then, the two icon entries should look like this:

icon16 = 'customwindowtitle/icon16.png'  
icon32 = 'customwindowtitle/icon32.png'

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
  • Forge/src/ contains source files specific for Forge

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

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.