Skip to content

Customising your modpack's branding

Paint_Ninja edited this page May 25, 2021 · 2 revisions

itlt allows you to customise the window title and icon of the game. This page walks you through setting these up and tells you how to make the most of it.

Title

By default, itlt changes the window title to include your modpack's name when it is able to detect it from a supported launcher. When this fails, it falls back to the value of the autoDetectedDisplayNameFallback config option.

You can change the format of the window title text with the customWindowTitleText config option. Or turn it off entirely by setting enableCustomWindowTitle to false.

Iconography

There's a robust system in place for handling icons that is HiDPI-aware and has various fallback mechanisms. The icon is used in the window titlebar and taskbar/dock and uses the appropriate size for each. If there's no perfect fit, it'll resize the closest size available.

Before we talk about the different options and how to use them, let me explain their priorities.

Priorities

The fallback mechanisms go as follows, from highest priority to lowest:

  1. Provided ico file
  2. Provided icns file
  3. Provided png file
  4. Auto-detected icon
  5. Enhanced Vanilla icon
  6. Vanilla icon

Providing an icon file

If you already have an icon file to provide to itlt, place it in config/itlt and name it "icon" like so:

itlt supports ICO, ICNS and PNG formats on all operating systems. If you want to keep things simple, use a square icon.png with a max size of 128px² and call it a day. If you want crisp icons at many different screen sizes and resolutions or you want to show a different icon for the taskbar and window title, you should use the ICO format and dump all relevant sizes as separate images embedded inside that. If you already have an ICNS icon file, you can use it directly without needing to convert it to ICO.

Getting the best results out of your icon

For best results, ideally use an ICO with as many embedded size variations as possible and a 1:1 (square) aspect ratio. Do NOT make an ICO with a bunch of resized variations, instead you should use an ICO that has all of the sizes individually made if you can and skip the sizes you don't have.

Recommended embedded size variations include: 256x, 192x, 160x, 128x, 96x, 80x, 72x, 64x, 48x, 40x, 32x, 24x, 20x, 16x. Or if you want to save some time: 128x, 64x, 48x, 32x and 16x.

Don't simply resize existing sizes to make more variations as that just wastes space, itlt will automatically resize the closest available size for you.

You may find an example icon file here.

This icon file is used for testing itlt and includes unique text for each icon size to help easily distinguish them. You probably want to use the same icon for each size, merely adapting it to the pixel budget rather than having completely different designs for each size, but you're the boss.

What format should I use?

Ideally you should use ICO if you have multiple sizes, PNG if you have only one size and ICNS is an option if you need it.

Format Supported embedded sizes Supports multiple sizes in same file?
ICO Any Yes
ICNS 48x, 32x, 16x Yes
PNG Any No

Auto-detected icon

When using a supported launcher, itlt will automatically grab the icon used for your modpack's listing when an icon file isn't provided. This is enabled by default, so it should just work out of the box - providing an icon is entirely optional.

Enhanced Vanilla icon

Vanilla Minecraft on Windows and Linux uses two fixed icon sizes: 16px² and 32px².

On MacOS, it uses an ICNS file embedded in the jar that has sizes that go up to 256px² - significantly higher.

itlt grabs the ICNS file from the running game, splits each of its sizes into their own images and converts them all into a format that GLFW accepts. This allows for a higher quality icon on Windows and Linux, especially when using a high resolution display.

When no custom icon is provided and auto-detection fails or is disabled, the enhanced vanilla icon is used by default. You can turn this off and revert to Vanilla behaviour of a max 32px icon if you prefer.