Ukulib Mod Wiki › FAQ
Ukulib Mod FAQ
10 questions players actually ask, answered.
What does Ukulib actually do?
Ukulib is a library mod that other mods use to build their config screens, so on its own it mostly sits in the background. You'll see it working when another mod's options open in a clean, consistent menu instead of a plain text file.
Do I need to install Ukulib by itself?
No, Ukulib has zero dependencies and doesn't add its own gameplay content, so installing it alone won't change your game. You only need it because another mod you're using requires it.
How do I open a Ukulib config screen in-game?
Ukulib itself doesn't add a hotkey; the config screen is opened through the mod that uses it, usually via that mod's own keybind or its entry in the mod list. If a mod depends on Ukulib, check that mod's controls or its config button.
Where do I find the config menu for a mod that uses Ukulib?
Open the mod list and look for the config button on the mod that uses Ukulib, or use that mod's own options keybind. Ukulib provides the screen, but the mod that depends on it decides how you reach it.
Why is my Ukulib config screen blank or not opening?
This usually means the mod that owns the screen failed to register its config, often because of a version mismatch between that mod and Ukulib. Make sure the dependent mod and Ukulib are both up to date and built for the same game version.
Can I use Ukulib to make config screens for my own mod?
Yes, that's exactly what it's for; you register your config options with Ukulib and it generates the widgets and screen for you. You'll need to declare Ukulib as a dependency in your mod's metadata so it loads first.
How do I make my mod's options show up in Ukulib's config menu?
You define your options through Ukulib's config system and register them during mod initialization, then point your config button at the generated screen. If nothing appears, the options likely weren't registered before the screen was built.
Does Ukulib work on both client and server?
Ukulib is primarily a client-side library for building config screens, so it's mainly needed on the client. Check the dependent mod's requirements, since some mods may want it present on both sides.
Will Ukulib slow down my game or cause lag?
No, it's a lightweight library that only does work when a config screen is opened, so it has no meaningful impact on gameplay performance. Any lag you see is almost certainly from another mod.
Is Ukulib compatible with other config mods?
Yes, Ukulib is self-contained with no dependencies, so it doesn't conflict with other config libraries. Each mod just uses whichever library it was built against, and they can coexist.