chylex/Minecraft-Window-Title
1
0
Fork 0
mirror of https://github.com/chylex/Minecraft-Window-Title.git synced 2025-04-07 19:15:45 +02:00
Code

Release 1.4.0 for Minecraft 1.21 or newer

Browse Source
This commit is contained in:
chylex 2024-10-19 14:00:07 +02:00
parent 05a081364d
commit 3de5e01e32
Signed by: chylex
GPG Key ID: 4DE42C8F19A80548
3 changed files with 38 additions and 20 deletions

27
docs/CURSEFORGE.md
View File

@ -17,6 +17,7 @@ icon32 = ''
```
Only edit text inside quotes or apostrophes.
### Changing the Title
You can use the following special tokens in the _title_ configuration entry:
@ -29,24 +30,32 @@ If any of the tokens aren't working, search the game log for **CustomWindowTitle
### Changing the Icon
**This feature is currently not supported in Minecraft 1.20+.**
#### Minecraft 1.21+
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.
**This feature is only available in Custom Window Title 1.4.0 and newer.**
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:
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.
* `.minecraft/config/customwindowtitle-client.toml`
* `.minecraft/config/customwindowtitle/icon16.png`
* `.minecraft/config/customwindowtitle/icon32.png`
The icon **must be saved with transparency** even if it don'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.
Then, the two icon entries should look like this:
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:
```toml

27
docs/MODRINTH.md
View File

@ -17,6 +17,7 @@ icon32 = ''
```
Only edit text inside quotes or apostrophes.
### Changing the Title
You can use the following special tokens in the _title_ configuration entry:
@ -29,24 +30,32 @@ If any of the tokens aren't working, search the game log for **CustomWindowTitle
### Changing the Icon
**This feature is currently not supported in Minecraft 1.20+.**
#### Minecraft 1.21+
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.
**This feature is only available in Custom Window Title 1.4.0 and newer.**
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:
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.
* `.minecraft/config/customwindowtitle-client.toml`
* `.minecraft/config/customwindowtitle/icon16.png`
* `.minecraft/config/customwindowtitle/icon32.png`
The icon **must be saved with transparency** even if it don'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.
Then, the two icon entries should look like this:
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:
```toml

4
gradle.properties
View File

@ -1,9 +1,9 @@
# Mod
modId=customwindowtitle
modName=Custom Window Title
modDescription=Customize window title.
modDescription=Customize window title and icon.
modAuthor=chylex
modVersion=1.3.0
modVersion=1.4.0
modLicense=Unlicense
modSourcesURL=https://github.com/chylex/Minecraft-Window-Title
modIssuesURL=https://github.com/chylex/Minecraft-Window-Title/issues