OptiGUI

A client side drop-in replacement for OptiFine custom GUIs.

This mod supports most OptiFine GUI resource packs. I didn't do an extensive test with the .properties files, because I couldn't find such a resource pack. If a resource pack does not work or works differently than using OptiFine, please open an issue.

How do I use it

1. Download and install Fabric
2. Download Fabric API and put it in your mods folder
3. Download this mod from GitHub releases, Modrinth, or CurseForge
4. Put this mod in your mods folder

Supported resource packs

• Colourful Containers
• Colourful Containers Add-On
• Colourful Containers Dark Mode
• Animated RGB GUI ¹
• NEON20 ANIMATED
• Rybo's Enhanced GUI

¹ see FAQ for animation support

This list is not exhaustive. If you know a resource pack which works, please open an issue. If you know a resource pack which does not work, but works with OptiFine, please open an issue.

Partially supported resource packs

• Advanced GUI ¹
• New Default+ ²

¹ Color shulker boxes, Ender chests and Villager Professions do not work. The resource pack does not include OptiFine-specific assets, and these features are not supported by OptiGUI. (Some mods (Colourful Containers) include assets for these features and work with OptiGUI)

² Barrel does not work, neither does it work with OptiFine. The resource pack does not specify it according to the format.

Mods with incompatibilities

These mods are known to have issues with OptiGUI. Unless noted otherwise, these mods can be loaded alongside OptiGUI, but interfere with this mod's functionality.

• Litematica Printer - print mode resets any open GUI texture. Reopening the GUI fixes the texture. #15

Resource pack format

See OptiFine docs.

This mod supports some additional GUIs which are not (yet) supported by OptiFine. These start with an underscore (_) to minimize the chance of an incompatibility with an upcoming OptiFine update.

container additions:

• container accepts the following additional types: _cartography_table, _grindstone, _loom, _smithing_table, _stonecutter to replace the GUI of a cartography table, grindstone, loom, smithing table, or stonecutter, respectively.

container=chest additions:

• _barrel=true|false: replace the GUI of a barrel.

container=furnace additions:

• variants accepts the following values: _furnace, _blast, _blast_furnace, _smoker to replace the GUI of a furnace, blast furnace (2x), or smoker, respectively.

container=villager additions:

• professions additionally accepts the value _wandering_trader to replace the GUI of a wandering trader.

Currently broken features

• Custom name matching in .properties #19
  • This has been broken for a while
  • Workaround: Use Know My Name server-side mod

Does this mod affect game performance?

v0.1.0-v1.1.1

Yes, to a high extent.

The code is absolutely not optimized, the mod queries the last interacted block or entity multiple times per rendered frame, for every non-block texture rendered.

Please do not use these versions.

v1.1.2-v1.1.3

Yes, to an estimated moderately high extent.

Introduced caching, but still queries the last interacted block or entity at least once per rendered frame, for every non-block texture rendered.

Please do not use these versions.

v1.1.4

Yes, to an estimated moderate extent.

While all optimizations planned for v1.1.2 have been implemented, further optimizations will be implemented soon.

Caches are updated after every game tick instead of every rendered texture, but some code paths do not use the cache.

v1.1.5+

Not much, or to an estimated low extent.

All code paths (except for villager and llama matcher) use cache now.

FAQ

Can I use this mod in a modpack?

Yes, the license allows that.

The mod is included in the Fabulously Optimized modpack.

Does this mod support OptiFine GUI animations?

Not by itself, please check out Animatica. Supported as of OptiGUI v0.2.0.

Does this mod support OptiFine colors (colors.properties)?

No, see Colormatic.

Does this mod have a configuration GUI/file?

No. Just load a resource pack and it works out-of-the-box.

Does this mod work with Sodium?

Yes. As of 2022-09-08, Sodium does not interfere with OptiGUI. If Sodium introduces a change which breaks OptiGUI, please open an issue.

What loaders are supported?

• Fabric is supported.
• Fabric derivates like Quilt are not supported, it may or may not work, feel free to try it.
• Forge is not supported.
• Other loaders are not supported.
• No support is planned for loaders other than Fabric as of now.