diff --git a/.github/README/screenshot.png b/.github/README/screenshot.png new file mode 100644 index 0000000..d7c8463 Binary files /dev/null and b/.github/README/screenshot.png differ diff --git a/README.md b/README.md index 1967a5a..b1b906a 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,48 @@ 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. -(*) Fabric API is not required. +(*) 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, navigate to the **.minecraft/config** folder, and open **customwindowtitle-client.toml** in a text editor. You will see the following line: +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}" +title = 'Minecraft {mcversion}' +icon16 = '' +icon32 = '' ``` -Change only text inside the quotes. You can use the following special tokens: +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:<span style="text-decoration: underline;">modid</span>}** - 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](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. + +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: + +```toml +icon16 = 'customwindowtitle/icon16.png' +icon32 = 'customwindowtitle/icon32.png' +``` + ## Screenshots These screenshots were taken using the following example configuration: @@ -31,7 +54,7 @@ These screenshots were taken using the following example configuration: title = "Minecraft {mcversion} - Custom Window Title {modversion:customwindowtitle}" ``` - + # For Developers