OptiGUI

A client side mod to customize the texture of in-game GUIs with resource packs. Now rewritten from scratch in Kotlin for cleaner code, better performance, more features, and extensibility. Other mods' developers can add their custom containers and customization options. See documentation link above.

Supports most OptiFine GUI resource packs. If a resource pack does not work or works differently than using OptiFine, please open an issue (select the Report a bug template).

Check out my new OptiGUI resource pack for Minecraft 1.19+: Chest Boat GUI

Because Fabric/Loom/Gradle/Java broke the pre-refactor codebase, Minecraft 1.20.2 will not get a stable 2.1.5-based release, only 2.2.0 alphas. I decided not to suffer. I have more important IRL stuff, and some burnout.

The stable OptiGUI 2.2.0 is planned to be released in 2024. Please be patient or use the alpha releases.

How to use it

1. Download and install Fabric loader or Quilt loader
2. Download this mod from your favorite service
3. Download the required dependencies as well
4. Put this mod in your mods folder

Resource pack docs

This mod supports a superset of OptiFine features, see documentation link above. Some of them are not supported by OptiFine, and are marked as such.

Supported resource packs

Excluding vanilla resource packs (which don't container OptiFine or OptiGUI-specific files)

• Colourful Containers
• Colourful Containers Add-On
• Colourful Containers Dark Mode
• Animated RGB GUI ¹
• NEON20 ANIMATED
• Rybo's Enhanced GUI
• Animated Fox Guis ¹
• [DARK] Animated Fox Guis ¹

¹ see FAQ for animation support

This list is not exhaustive. If you know a resource pack which works, and you'd like to see it here, or a resource pack, which does not work, but works with OptiFine, please open an issue.

Partially supported resource packs

Excluding vanilla resource packs (which don't container OptiFine or OptiGUI-specific files)

• New Default+ ¹

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

FAQ

Use in a modpack?

Yes.

OptiFine GUI animations?

Only with Animatica.

OptiFine colors (colors.properties)?

No, use Colormatic.

Configuration GUI/file?

Nothing to configure.

Sodium?

Yes.

OptiFine?

Actually, OptiGUI and OptiFine (with OptiFabric) can be loaded simultaneously. I have observed that OptiGUI mixins will be placed before OptiFine ones, so you can turn off custom GUIs in OptiFine to save performance.

However, I can't assist you with this.

Supported loaders?

Fabric & Quilt. Anything else is not supported, those may or may not work.