Custom Panoramas

_images/icon10.webp

The 1.17 main menu.

File location

/assets/minecraft/optifine/gui/background.properties

Custom Panoramas control the behaviour of the main menu panorama.

Danger

This feature has been broken since 1.13 See GH-2052.

Alternative panorama folders

Note

This is optional.

Alternative panorama folders can include a background.properties file to define custom properties for each panorama.

For example:

/assets/minecraft/optifine/gui/background1
    /panorama_0.png
    /panorama_1.png
    /panorama_2.png
    /panorama_3.png
    /panorama_4.png
    /panorama_5.png

Properties

weight

Values: Integer
Optional
Default: 1

Weights of selections, in descending order; higher weights will be selected more often.

Blurs

The main menu background uses 3 types of blur prior to 1.12.

Warning

Higher blur levels may decrease the main menu FPS.

Danger

This feature does not work past 1.12.

blur1

Values: Integer, 1 through 64
Optional
Default: 1

blur2

Values: Integer, 1 through 3
Optional
Default: 1

blur3

Values: Integer, 1 through 3
Optional
Default: 1

Overlay colors

Note

When the top and bottom colors are both 0, that overlay is disabled.

If enabled, two gradient overlays can be drawn on top of the background panorama.

The color format is ARGB (alpha [transparency], red, green, blue), in hexadecimal.

To read it, convert each interval of two values to decimal from hexadecimal (AABBCCDD == 0xAA, 0xBB, 0xCC, 0xDD == 170, 187, 204, 221).

overlay1.top

Values: AARRGGBB
Optional
Default: 80FFFFFF

First overlay, top gradient color.

overlay1.bottom

Values: AARRGGBB
Optional
Default: 00FFFFFF

First overlay, bottom gradient color.

overlay2.top

Values: AARRGGBB
Optional
Default: 00000000

Second overlay, top gradient color.

overlay2.bottom

Values: AARRGGBB
Optional
Default: 80000000

Second overlay, bottom gradient color.

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_panoramas.schema.json",
	"title": "Custom Panoramas",
	"description": "Custom Panoramas control the behaviour of the main menu panorama.",
	"type": "object",
	"properties": {
		"weight": {
			"type": "integer",
			"minimum": 0,
			"default": 1,
			"description": "Weights of selections, in descending order; higher weights will be selected more often."
		},
		"blur1": {
			"type": "integer",
			"minimum": 1,
			"maximum": 64,
			"default": 1
		},
		"blur2": {
			"type": "integer",
			"minimum": 1,
			"maximum": 3,
			"default": 1
		},
		"blur3": {
			"type": "integer",
			"minimum": 1,
			"maximum": 3,
			"default": 1
		},
		"overlay1.top": {
			"type": "string",
			"pattern": "^[0-9a-fA-F]{8}$",
			"default": "80FFFFFF",
			"description": "First overlay, top gradient color."
		},
		"overlay1.bottom": {
			"type": "string",
			"pattern": "^[0-9a-fA-F]{8}$",
			"default": "00FFFFFF",
			"description": "First overlay, bottom gradient color."
		},
		"overlay2.top": {
			"type": "string",
			"pattern": "^[0-9a-fA-F]{8}$",
			"default": "00FFFFFF",
			"description": "Second overlay, top gradient color."
		},
		"overlay2.bottom": {
			"type": "string",
			"pattern": "^[0-9a-fA-F]{8}$",
			"default": "00000000",
			"description": "Second overlay, bottom gradient color."
		}
	},
	"additionalProperties": false
}

Assumes the latest OptiFine version.
Updated to commit dc7b4aca.

Last update: 2024 March 13