SFK UILib

v1.0.0·Updated 2025-11-25

UI Library to allow easy creation of various components

Screenshots 1 screenshots

About this mod Author’s original text

SFK UILib

A library to allow easy creation of various UI components in game.

Examples

  • Overlays
  • Text
  • Buttons
  • Layouts

This is just a dependency library for developers to use in their mods. It is not a standalone mod.

Code is available on my github. If you have questions or suggestions feel free to reach out of me in the Super Fantasy Kingdom Discord @ButterandCream or raise an issue on github.

All classes use a static factory pattern and have a associated Create method. I tried to chain methods as best as possible with a inheritance hierarchy so everything can be used together.

I also tried to mirror the existing in game components as best as possible, so if you are having trouble figuring out a layout, look in unity explorer

Here is an example snippet

void CreateModsOverlay()

{

var overlay = UIOverlay.Create(

"ModsOverlay",

new Vector2(-300, 0),

bgMode: OverlayBackgroundMode.PanelFixed,

bgColor: new Color(0f, 0f, 0f, 0.7f),

panelSize: new Vector2(300, 400)

).AddHeader("SFK UILib");

foreach (var mod in loadedPlugins)

{

var t = UIText.Create(

mod.Value.Metadata.Name,

overlay.Menu.container.Rect,

Vector2.zero,

size: 16,

alignment: TextAlignmentOptions.TopLeft

);

overlay.Menu.Add(t);

}

}

Install & use Install: follow the bundled instructions

  1. Unzip the archive from playbuff and read the bundled readme / instructions first.
  2. Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
  3. For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
  4. Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.

Install locations vary a lot between mods — the bundled readme is the most reliable guide.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack

File & checksum

Filename
SFK_UILib-1.0.0.zip
File size
24.1 KiB