How to Make Your Mod's Options Appear in Ukulib's Config Menu

Depend on Ukulib

For your options to show up in Ukulib's config menu, your mod must declare a dependency on Ukulib so it loads after the library and can call its API. Add the dependency in your mod metadata and reference Ukulib's config classes in your code. Without the dependency declared, load order is not guaranteed and your registration may run before Ukulib is ready, silently doing nothing.

Register Your Options

Create a config object through Ukulib's API and register each setting with a name, a default value, and a widget type. Ukulib uses that type to decide whether to draw a toggle, slider, or cycle button. Give each option a translation key so the label and tooltip display properly instead of a raw identifier. Organize options into categories if you have more than a handful, since Ukulib will render them as separate sections.

Expose the Entry Point

Provide the screen factory Ukulib calls when a player opens your config, and make sure your mod registers that factory during initialization. Then verify in-game: open the mod list, find your mod, and click its config button. If nothing appears, check that registration runs on the correct side and that your dependency is actually resolved at runtime. Confirm saved values persist by changing one, saving, and reopening the screen.