ModularUI Mod Wiki › FAQ
ModularUI Mod FAQ
10 questions players actually ask, answered.
How do I start creating a GUI with ModularUI?
Begin by extending the appropriate GUI class and use the modular widget system to add components like panels, buttons, and slots. The mod provides a builder pattern that lets you stack widgets together without writing complex layout code.
What's the difference between a client-only GUI and a server-synced GUI?
Client-only GUIs exist purely for display and don't affect game state, while server-synced GUIs (typically for TileEntities) keep data consistent between server and client so changes made in the interface actually modify the block's behavior. Use server-synced GUIs when your interface controls machine settings or inventory operations.
How do I sync values between server and client?
ModularUI provides built-in synchronization methods that automatically send widget value changes from client to server and vice versa. Check the guides on value syncing to see how to bind your GUI widgets to the data you want to keep in sync.
Can I make my GUI look like vanilla Minecraft?
Yes—ModularUI is specifically designed to match vanilla aesthetics by default. You can further customize the appearance using the color theme system to adjust colors and textures while maintaining that cohesive in-game look.
Does ModularUI work with JEI?
Yes, ModularUI has built-in compatibility with JEI and other popular mods like InventoryBogoSorter. Refer to the JEI compatibility guide to ensure your GUI's item slots interact correctly with these tools.
Why are my GUI values not updating on the server?
Make sure you've properly configured the synchronization between your client widgets and server-side data—check that your value sync bindings are correctly set up and that your TileEntity is handling the incoming packets. Common mistakes include forgetting to mark fields as synchronized or not implementing the sync handler.
Can I reuse GUI components across multiple blocks?
Yes, that's a core feature of ModularUI—the modular approach lets you create reusable widget panels and components that you can add to different GUIs, reducing code duplication and making maintenance easier.
How do I add buttons and interactive elements to my GUI?
ModularUI provides widget classes for buttons, toggles, sliders, and text fields that you can add to your GUI layout. Each widget can have click handlers or value-change listeners attached to trigger actions when players interact with them.
Will ModularUI GUIs cause performance issues?
ModularUI is optimized for performance and won't cause lag when used properly. Avoid creating excessive numbers of widgets in a single GUI, and be mindful of frequent synchronization calls if you're syncing many values per tick.
How do I apply a custom color theme to my GUI?
ModularUI's color theme system lets you define a palette of colors that automatically applies to all your GUI components. See the color themes guide to learn how to create and assign themes that match your mod's visual identity.