chylex/Minecraft-Window-Title
1
0
Fork 0
mirror of https://github.com/chylex/Minecraft-Window-Title.git synced 2024-11-24 20:42:48 +01:00
Code

Compare commits

base: chylex:ba22745940da89e0cc60737531d20eeb5f967aab
Branches Tags
chylex:master
chylex:1.20
chylex:1.19
chylex:1.15
chylex:1.17
chylex:1.12/older
chylex:1.14
..
compare: chylex:44a10a09ca6338594675d36fdfa3722410a855f8
Branches Tags
chylex:1.20
chylex:master
chylex:1.19
chylex:1.15
chylex:1.17
chylex:1.12/older
chylex:1.14

No commits in common. "ba22745940da89e0cc60737531d20eeb5f967aab" and "44a10a09ca6338594675d36fdfa3722410a855f8" have entirely different histories.
ba22745940 ... 44a10a09ca

5 changed files with 44 additions and 124 deletions
Show Stats Expand all files Collapse all files

31
CURSEFORGE.html Normal file
View File

@ -0,0 +1,31 @@
<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>
<li><strong>{username}</strong> - current username</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>

20
README.md
View File

@ -2,7 +2,7 @@
## 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 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.
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.
@ -10,7 +10,7 @@ The mod supports [NeoForge](https://neoforged.net/) and [Fabric](https://fabricm
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}'
@ -24,19 +24,19 @@ Only edit text inside quotes or apostrophes.
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
* **{mcversion}** - current Minecraft version
* **{modversion:<span style="text-decoration: underline;">modid</span>}** - version of installed mod with the identifier _modid_
* **{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
**This feature is currently not supported in Minecraft 1.20+.**
**This feature is currently not supported in Minecraft 1.20.**
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:
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`
@ -64,8 +64,10 @@ 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
- `NeoForge/src/` contains source files specific for NeoForge
- `Forge/src/` contains source files specific for Forge
The `assemble` Gradle task creates a single `.jar` file for both mod loaders in the `build/dist` folder.
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 `neoForgeVersion` or `fabricVersion` to disable them.

56
docs/CURSEFORGE.md
View File

@ -1,56 +0,0 @@
## 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
**This feature is currently not supported in Minecraft 1.20+.**
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:
```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">

57
docs/MODRINTH.md
View File

@ -1,57 +0,0 @@
## 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
**This feature is currently not supported in Minecraft 1.20+.**
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:
```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)

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.2.0
modLicense=Unlicense
modSourcesURL=https://github.com/chylex/Minecraft-Window-Title
modIssuesURL=https://github.com/chylex/Minecraft-Window-Title/issues