ModularUI

What is ModularUI?

ModularUI is a library for Minecraft aiming to make GUI's much easier.

Key features

• panel system similar to windows
• widgets are placed in a tree like structure
• widget rendering and interactions are automatically handled
• built in widgets like buttons, scroll views, item slots, fluid slots and text fields
• no need to create GUI texture sheets, each widget is rendered dynamically
• easy and dynamic widget sizing and positioning
• build in APIs for various UI things like color, stencil (fancy scissor) and animations
• easy syncing between client and server handled by MUI
• good for client only GUIs and client-server synced GUIs
• GUI themes are loaded via JSON and can be added and modified by resourcepacks
• recipe viewer compat for things like exclusion zones and ghost ingredients

Mod versions

• MUI begann as 1.0.0 in Minecraft 1.12.2
• A rewrite of core features was introduced in 2.0.0. MUI 1 and 2 are so fundamentally different, that every mod using it, is incompatible with the other version. I took McLib as an inspiration for this version.
• Years later, over many release candidates, version 3.0.0 was released. This change was much less drastic than 2.0.0, but was still very large. When people say "MUI2" they often mean 3.0.0 at this point in time.

Minecraft Versions

• 1.7.10 is maintained by the GTNH Team, which is where the repository can be found. Many big changes from my modern repository will not be back ported.
• 1.12.2 MUI was created in this version under the CleanroomMC org, this is no longer maintained.
• 1.20.1 and up is maintained at my own repository, by me and the GTCEM Team.

At this point in time, 1.20.1 is my main focus, but commits are forward ported to 1.21.1 by the GTCEM Team.

Need help?

For version 1.7.10 best place to ask is the GTNH discord.

Otherwise you can join the MUI discord. This is only meant for developers!

ModularUI

This is the ultimate GUI mod for minecraft.

History

The first time I encountered a form of a ModularUI was in GTCE in version 1.12.2. The concept was great. Much less boiler plate code. No GUI texture sheets. And more. However there were a lot of problems. There were lots of bugs. The code was a mess and compat with other mods such as Inventorytweaks was very difficult. Then GTCEu was made as a fork of GTCE. The UI code received some improvements, but somehow it got even messier. At that point CleanroomMC already decided to make a reworked, standalone version of ModularUI. So I volunteered to do the job. And I did. On May 22nd 2022 the first version was released on CF. It was a huge improvement compared to GTCE/GTCEu, but I still was not happy enough. So a few updates and month later i started to rewrite some portions of the mod. However the rewrite became so large that it was almost a full rewrite. Was it worth it? I don't know, but now I'm happy with the result.

Features

• Panel system similar to windows
• Widgets like buttons, text fields (custom, not mc garbage) or slider
• layout widgets like rows, columns, grids and lists
• custom implementation of scrolling with smooth animations
• math expression parser for number text fields
• viewport implementation for transformation of certain parts (like a scrollable list)
• easy syncing of any value making the mod usable for things like TileEntities/BlockEntities
• open and close animations of panels
• compat with InventoryBogoSorter