Custom GUIs¶

Custom GUIs can define a texture for each GUI, and apply them based on different criteria, such as the entity, biome, height, and more.

For each container GUI texture to override, create a .properties file in the /assets/minecraft/optifine/gui/container folder of the resource pack. Properties files can be organized into subfolders of any depth, as long as everything is within the top-level /assets/minecraft/optifine/gui/container folder.

General properties¶

container¶

Type: String

Values: anvil, beacon, brewing_stand, chest, crafting, dispenser, enchantment, furnace, hopper, horse, villager, shulker_box, creative, or inventory

Required

Type of container GUI to apply to.

• creative refers to the creative inventory with the tabs.

• inventory refers to the normal survival inventory (with the player in a window).

texture¶

Type: String

Values: File path

Required

The replacing texture for the default GUI texture.

texture.PATH¶

Type: String

Required

Replaces a specific sub-texture of the GUI; PATH is relative to /assets/minecraft/textures/gui.

Important

The creative inventory GUI does not have a default texture, so it must use texture.PATH properties.

Example for creative inventory:

/assets/minecraft/optifine/gui/container/creative/creative_desert.properties¶

container=creative
biomes=desert
texture.container/creative_inventory/tab_inventory=tab_inventory_desert
texture.container/creative_inventory/tabs=tabs_desert
texture.container/creative_inventory/tab_items=tab_items_desert
texture.container/creative_inventory/tab_item_search=tab_item_search_desert

Important

At least one texture or texture.PATH property is required.

name¶

Type: String

Optional

Custom entity or block entity name.

For example: Beacon, Brewing Stand, Enchanting Table, Furnace, Dispenser, Dropper, Hopper, and Command Blocks.

This will apply the replacement GUI only when the container matches this rule.

biomes¶

Type: List of strings

Values: Space-separated biome IDs

Optional

Biomes where this replacement applies.

Biomes added by mods can also be used with the same syntax.

heights¶

Type: Integer or integer range

Optional

Heights where this replacement applies.

Since 1.18, negative values may be specified for height. When used in a range they must be put in parenthesis: (-3)-64.

Specific properties¶

These additional properties do not need any separate files. They are just properties that apply only when container equals their required value.

Chests¶

large¶

Type: Boolean

Default: false

Optional

Whether to use the replacement GUI on a large (double) chest.

trapped¶

Type: Boolean

Default: false

Optional

Whether to use the replacement GUI on a trapped chest.

christmas¶

Type: Boolean

Default: false

Optional

Whether to use the replacement GUI on any Christmas chest. Christmas chests appear from December 24 to 26 of any year.

ender¶

Type: Boolean

Default: false

Optional

Whether to use the replacement GUI on an Ender Chest.

Beacons¶

levels¶

Type: Integer or integer range

Values: From 1 to 4

Optional

What levels of beacon power to apply the replacement to; how many bases of blocks.

Villagers¶

professions¶

Type: List of strings

Values: none, armorer, butcher, cartographer, cleric, farmer, fisherman, fletcher, leatherworker, librarian, mason, nitwit, shepherd, toolsmith, or weaponsmith

Optional

List of villager professions with an optional level specifier.

Entry format: <profession>[:level1,level2,...]

Examples:

• Professions farmer (all levels) or librarian (levels 1,3,4): professions=farmer librarian:1,3-4

• Professions fisher, shepard, nitwit: professions=fisherman shepherd nitwit

Horse¶

variants¶

Type: List of strings

Values: Any of horse, donkey, mule, llama

Optional

What specific horse type to apply this replacement to.

Dispenser, dropper¶

variants¶

Type: String

Values: dispenser or dropper

Default: dispenser

Optional

What specific block to apply the replacement GUI to.

Llama, shulker box¶

colors¶

Type: List of strings

Values: See contents

Optional

Shulker box color or llama carpet color to apply the replacement texture to.

Valid values: white, orange, magenta, light_blue, yellow, lime, pink, gray, light_gray, cyan, purple, blue, brown, green, red, black