Custom Loading Screens

Custom Loading Screens define the screen when changing worlds, loading a world, starting the game, or reloading datapacks.

_images/icon11.webp

The dimension switching screen.

File location

/assets/minecraft/optifine/gui/loading/loading.properties

Controls the behaviour of the world loading screen.

_images/mojang.webp

The Vanilla loading screen since 1.16.

Custom loading screen backgrounds per dimension can be defined as: /assets/minecraft/optifine/gui/loading/backgroundDIM.png

Where DIM is the dimension ID:

  • 1: End

  • 0: Overworld

  • -1: Nether

Note

Modded dimensions can also be configured in this way.

Properties

Note

The properties scaleMode, scale, and center can also be configured per dimension:

dim<dim>.scaleMode=<fixed|full|stretch>
dim<dim>.scale=2
dim<dim>.center=<true|false>

scaleMode

Values: fixed, full, or stretch
Optional
Default: fixed

Custom scale mode for the background texture:

  • fixed: use fixed scale, pixel for pixel (default).

  • full: fullscreen, keep aspect ratio.

  • stretch: fullscreen, stretch picture.

scale

Values: Integer
Optional
Default: scaleMode=fixed: 2, scaleMode=full: 1

Custom scale for the background texture.

For scale mode fixed, it defines the pixel scale to use. This is combined with the curent GUI scale.

For scale modes full and stretch, it defines how many tiled textures should fit on the screen.

center

Values: Boolean
Optional
Default: false

Defines if the background texture should be centered on the screen.

JSON schema

Note

Although this page is .properties based, it can be mapped to JSON.

{
	"$schema": "http://json-schema.org/draft/2020-12/schema",
	"$id": "https://gitlab.com/whoatemybutter/optifinedocs/-/blob/master/schemas/custom_loading_screens.schema.json",
	"title": "Custom Loading Screens",
	"description": "Custom Loading Screens define the screen when changing worlds, loading a world, starting the game, or reloading datapacks.",
	"type": "object",
	"properties": {},
	"additionalProperties": false,
	"patternProperties": {
		"^(dim-?[0-9]+\\.)?scaleMode$": {
			"enum": [
				"fixed",
				"full",
				"stretch"
			],
			"description": "Custom scale mode for the background texture.",
			"default": "fixed"
		},
		"^(dim-?[0-9]+\\.)?scale$": {
			"type": "integer",
			"minimum": 0,
			"description": "Custom scale for the background texture.",
			"default": 1
		},
		"^(dim-?[0-9]+\\.)?center$": {
			"type": "boolean",
			"description": "Defines if the background texture should be centered on the screen.",
			"default": false
		}
	}
}
Assumes latest OptiFine version.
Updated to commit 8ed2130d.
Open source at https://gitlab.com/whoatemybutter/optifinedocs.