
You are viewing a potentially older version of this package. View Latest Version
ZUI Lib
Modular UI, split-screen layout, and menu library for Zort mods.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
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 modumk run-example- builds with showcase examples and launches Zortumk build- compiles clean library and copies DLL to BepInEx pluginsumk build-example- compiles with showcase examples and copies DLL to pluginsumk pack- builds clean release and packages Thunderstore zip intodist/umk modlessrun- launches clean vanilla Zortumk compile- builds the projectumk clean- cleans build filesumk 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)