Getting Started
Adding ModularUI to your mod
Add the CleanroomMC maven to the repositories (if not already present)
maven {
name 'Cleanroom Maven'
url 'https://maven.cleanroommc.com'
}and the dependency declaration to dependencies
api 'com.cleanroommc:modularui:2.5.0' { transitive false }Check the latest version on Github releases.
Development Tools
I highly recommend using IntelliJ in combination with the Single Hotswap plugin.
Other documentation
As always, the code itself is the best documentation. Most API classes have lots of useful javadoc information.
Creating a GUI
First you need to decide if you want a client only screen or a client-server synced gui.
Client only GUI
Client only GUIs are easier to work with, but they can't communicate with the server. You can open one by calling ClientGUI.open(ModularScreen). You can additionally pass in a UISettings or JeiSettings instance. Client only GUIs don't display JEI on the side by default. This can be changed in the JeiSettings. The options in UISettings are mostly for synced GUIs. The ModularScreen should be a new instance.
Go here to get started on creating a client GUI. Even if you are looking into making a synced GUI, I still recommend checking it out as it contains some information which is useful for both cases.
Examples
Here are some examples for some Client only GUIs made with ModularUI:
- A sortable list which allows adding options via a popup panel
- Various tests
- A custom screen with a custom panel and custom transformation
Synced GUI
Synced GUIs are much more complicated to open. The most important thing is that you must only open synced GUIs on server side. ModularUI automatically syncs to client. Choosing the correct UIFactory and GuiData is important here. A UIFactory is what finds the exact same IGuiHolder on client and server with the provided GuiData. The IGuiHolder is then responsible for creating the UI. ModularUI has build-in factories for:
- Standard tile entities (
GuiFactories.tileEntity(),PosGuiData) - Items in a players hand (
GuiFactories.item(),HandGuiData) - Sided tile entities (useful for GregTech covers) (
GuiFactories.sidedTileEntity(),SidedPosGuiData) - Simple factories (these always point to the same
IGuiHolder) (GuiFactories.createSimple(), gui data irrelevant)
Each factory may have its own custom method for opening a GUI. The factories then call GuiManager.open(...).
Go here to get started on creating a synced GUI.
Examples
Here are some examples for some synced GUIs made with ModularUI:
- Tile entity with very large widget tree with several tabs and all sorts of syncing
- Backpack item
- Tile entity with large amount of slots for testing
- Item editor allows editing meta, amount and nbt opened by command
Nullpinter
brachy84