README.md

OptiGUI

OptiGUI is a client-side mod, which enables the customization of in-game GUI screen textures 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).

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

Supported languages

• 🇺🇸 by opekope2
• 🇲🇽 by Santiago Hernandez
• 🇹🇼 by dirtTW, notlin4
• 🇨🇳 by dirtTW, notlin4
• 🇩🇪 by Lucanoria

Want to see your name here? Translate OptiGUI to your native language.

Resource pack docs

OptiGUI supports OptiFine custom GUI resource packs, and also supports OptiGUI resource packs. OptiGUI resource packs are more flexible than OptiFine resource packs. See documentation link above to get started.

Supported resource packs

Excluding vanilla resource packs (which don't contain 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.

Performance impact?

OptiGUI's performance impact is negligible (tho it varies a bit depending on which resource packs are used).

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.