Simple GUI API

A reusable configuration GUI API with themes, profiles, key bindings, and responsive layouts.

Client-sideFabricForgeNeoForge1.21.x26.1.x26.2.x

Documented version: 1.5.6Dependency: NoneModrinth ↗

Controls

There is no global everyday key. Open a client mod’s settings through that mod’s key binding or a compatible mod menu.

First-time workflow

1. Install Simple GUI API alongside a supported client mod in the same Minecraft instance.
2. Open that mod’s configuration screen and use the shared themes, tabs, search, and key controls.
3. Create profiles to save and switch complete value sets for different play styles.
4. High resolutions show more settings, while low resolutions use a scrollable responsive layout.
5. Developers build client settings with definitions, callbacks, tabs, and the key registry API.

Recommended way to learn the mod

Start in a single-player test world or an approved server area. Change one option at a time, reproduce the same action, and keep the previous value in mind. This makes it much easier to identify whether a behavior comes from this mod, Minecraft, or another client mod.

Profiles and shared settings UI

When the screen is provided by Simple GUI API, use tabs to move between feature groups and profiles to keep separate value sets. Save or apply the current page before leaving it. A profile changes settings; it does not replace the installed JAR or create a separate Minecraft instance.

Multiplayer notes

This mod does not override server rules. Features that automate input, reveal client-side information, or change how actions are presented may be restricted by a server. Test with the server owner’s rules in mind, and disable the feature when uncertain.

Daily checklist

• Confirm the feature’s toggle after joining a world.
• Confirm that the active profile is the intended one.
• Recheck key conflicts after adding another mod.
• If behavior changes after an update, compare with default settings before reporting a bug.