https://github.com/chylex/minecraft-window-title
Minecraft mod that lets you customize window title and icon.
https://github.com/chylex/minecraft-window-title
fabric forge java minecraft mod
Last synced: about 1 year ago
JSON representation
Minecraft mod that lets you customize window title and icon.
- Host: GitHub
- URL: https://github.com/chylex/minecraft-window-title
- Owner: chylex
- License: unlicense
- Created: 2020-01-30T20:53:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T02:47:18.000Z (about 1 year ago)
- Last Synced: 2025-03-25T22:21:22.811Z (about 1 year ago)
- Topics: fabric, forge, java, minecraft, mod
- Language: Java
- Homepage: https://www.curseforge.com/minecraft/mc-mods/custom-window-title
- Size: 584 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: .github/README/screenshot.png
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# For Users
## 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.
(*) 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:
```toml
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:}` - version of installed mod with the identifier ``
* `{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
#### 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:
```toml
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
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.