OptiGUI

OptiGUI is a client-side mod for Minecraft that unlocks endless possibilities for customizing in-game interfaces using resource packs. The mod has been completely rewritten from scratch in Kotlin, providing cleaner code, enhanced performance, expanded functionality, and better scalability.

Developers of other mods can easily integrate their own containers and customization options through OptiGUI. Detailed documentation is available to explore all capabilities.

Resource Pack Compatibility

The mod supports most resource packs created for OptiFine GUI. If any pack works incorrectly or behaves differently than in OptiFine, it's recommended to create a bug report using the appropriate template.

Check out the new OptiGUI resource pack for Minecraft 1.19+: Chest Boat GUI, which offers unique visual enhancements.

⚠️ Important note: OptiGUI 2.3.x versions prior to beta-8 are incompatible with Fabric Language Kotlin 1.13.5 and above. For stable operation, use Fabric Language Kotlin 1.13.4.

Simple Installation

If you're not a resource pack creator experimenting with OptiGUI 3 JSON resources, it's recommended to use stable OptiGUI 2.3.x versions.

The installation process includes several simple steps:

• Install Fabric or Quilt loader
• Add the mod to the mods folder
• Install required dependencies
• Activate a supported resource pack

Supported Languages

The mod has been translated into multiple languages including English, Chinese, German, Spanish, Italian, Malaysian, and Ukrainian. Translations are provided by the developer community, and anyone can add support for their native language.

Technical Features

Cobblemon Compatibility

When using Cobblemon 1.5.2 and earlier versions, Fabric Language Kotlin 1.10.11+kotlin.1.9.20 or earlier is required to prevent crashes.

Supported Loaders

Current OptiGUI 3 alpha versions work exclusively with Fabric and Quilt loaders. Quilt support is based on the ability to load Fabric mods through Quilt loader.

Using alternative clients or compatibility layers such as Sinytra Connector or Lunar client is supported on a best-effort basis, but issues may arise that are not directly related to OptiGUI.

Resource Packs for OptiGUI 2.3.x

The mod is compatible with a wide range of popular resource packs:

• Colourful Containers and its various modifications
• Animated RGB GUI (requires Animatica for animations)
• NEON20 ANIMATED
• Rybo's Enhanced GUI
• Animated Fox Guis and its dark version
• Recolourful Containers GUI + HUD

This list is constantly expanding. If you discover a working resource pack missing from the list or encounter compatibility issues, please report them.

Frequently Asked Questions

Can it be used in modpacks? Yes, without restrictions.

OptiFine GUI animation support? Only with the Animatica mod.

OptiFine colors (colors.properties) support? No, use Colormatic for this.

Performance impact? Minimal, varies depending on the resource packs used.

Configuration settings? Not required.

Sodium compatibility? Full.

Coexistence with OptiFine? OptiGUI and OptiFine can work simultaneously. For performance optimization, it's recommended to disable custom GUIs in OptiFine settings.