ZUI-Lib

UI library for Zort mods.

Features

• Custom submenus and buttons in the Main Menu and Pause Menu
• Standalone split screens without opening the vanilla pause menu
• Custom right-panel cards and buttons in the pause menu
• Action buttons on player cards with volume slider auto-collapse
• Mod settings modals styled like native settings
• Custom popups, subtitles, and top banner notifications

Setup

Requires .NET SDK and UMK.

Install UMK:

dotnet tool install -g krwclassic.umk

Setup project on a fresh clone:

git clone https://github.com/KRWCLASSIC/ZUI-Lib.git
cd ZUI-Lib
umk setup

Running

• umk run - builds clean library and launches Zort with the mod
• umk run-example - builds with showcase examples and launches Zort
• umk build - compiles clean library and copies DLL to BepInEx plugins
• umk build-example - compiles with showcase examples and copies DLL to plugins
• umk pack - builds clean release and packages Thunderstore zip into dist/
• umk modlessrun - launches clean vanilla Zort
• umk compile - builds the project
• umk clean - cleans build files
• umk list - shows all available scripts and variables

Documentation

API reference for each subsystem:

• Core - Plugin info, module discovery, ZUIAPI, ZUIImage, ZUICrashHandler
• Main Menu - Custom buttons, submenus, pagination, and breadcrumbs
• Pause Menu - Pause drawers, player card actions, right panels and cards
• Screens - Standalone custom split screens (ZUIScreen)
• Panels - Modal settings dialogs (ZUIPanel)
• Settings - Native InGameUI settings injection (ZUISettings)
• Popups - Dialogs, alerts, confirmations, and ESC handling (ZUIPopup)
• Notifications - Top banner alerts (ZUIInfoText)
• Dialogue - Subtitles (ZUISubtitle) and sequences (ZUIDialogueSequence)