31 lines
3.9 KiB
HTML
31 lines
3.9 KiB
HTML
<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><version></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>
|
|
</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>
|