ModularUI

What is ModularUI?

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

Why ModularUI?

Minecrafts (and Forges) gui code is not very good and the code gets really messy really fast. With ModularUI you can build GUIs fast by adding Widgets to panels with layout widgets, so you don't have to calculate positions and sizes yourself. ModularUI is very dynamic and allows for very complicated client only or even client-server synced GUIs. A good example is fluid slots in GUIs. Minecraft and Forge don't offer anything to add fluid slots or tanks to a GUI. With ModularUI you simply call .child(new FluidSlot().syncHandler(new FluidTank(16000))) (along with some setters).

Key features

• panel system similar to windows
• widgets are placed in a tree like structure
• widget rendering and interactions are automatically handled
• 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 without
• 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

History

• First appearance of ModularUI in GTCE by Archengius
• on 30th December 2021 GTCEu released with some improvements to its GUI library
• on 16th January 2022 Rongmario created the ModularUI repository in the CleanroomMC organization with the intention to rewrite it
• on 19th February I (brachy) started working on ModularUI
• on 21st May 2022 ModularUI version 1.0.0 was released on Curseforge
• miozune decided to port ModularUI to 1.7.10 for GTNH
• after 3 month of updates I decided to rewrite some parts of the library
• the rewrite turned very large and thus ModularUI 2 was born
• on 21st March 2023 I uploaded version 2.0.0 to Curseforge
• since then ModularUI is constantly receiving updates

I need help

1.12.2

The 1.12.2 version is part of CleanroomMC. It's discord is here.

Any version

You can contact me on Discord (Username: 'brachy.'). Do not ask to ask a question. Just ask your question. If you just say 'Hi' I will ignore you.

If you are a developer i can give you access to a discord sever which is meant for developers only.

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