Sponge's UI Library

The shared toolkit that Sponge's mods draw their on-screen elements with.

This mod does nothing on its own. It adds no features, changes no gameplay and patches nothing. Install it only because another mod lists it as a dependency — your mod manager will normally do that for you.

What it does

Every mod that draws something on screen has to solve the same problems: make a canvas, scale it so it looks right on any monitor, pick colours, and place things relative to a corner. When each mod solves those separately you get overlapping elements, mismatched colours, and one canvas per mod for the game to rebuild.

This puts all of it in one place, so anything built on it shares a single canvas, a single theme, and one consistent way of describing where something sits.

What that means for you

• Consistent look. Panels, bars and lists match, because they are literally the same widgets.
• Rounded and detailed rather than flat. A mod cannot add artwork to a game, so every shape here is drawn in code: rounded corners are anti-aliased pixel by pixel, panels carry a rim and a soft sheen, and bars sit in a recessed well with a highlight along the fill.
• Themed for the game. Deep-water panels, warm brass accents, coral warnings — so a screenful of numbers does not read as a spreadsheet laid over a fishing game.
• Consistent placement. Offsets mean "distance inward from the corner you picked", so a positive value moves an element the same direction from any corner.
• Scales to your monitor. Sizes are described against 1920x1080 and scaled from there, favouring height so things keep their proportions on ultrawide displays.
• Cheap. One shared canvas, sprites cached and reused, and no animation coroutines.

When you want it

Only when something else asks for it.

Keys

None.

Compatibility

It draws into its own overlay and never touches the game's own interface, so it does not conflict with other interface changes. It never takes mouse input, so it cannot swallow a click.

For mod authors

Declare the dependency so you are refused a load rather than failing later with a missing-type error:

[BepInDependency(UILibPlugin.Id, UILibPlugin.Version)]

The version is a contract, bumped whenever the public widget surface changes in a way a dependent could notice.

License

See LICENSE in the package.