You are viewing a potentially older version of this package.
View all versions.
| Date uploaded | 3 days ago |
| Version | 0.2.0 |
| Download link | KRWMods-ZUI_Lib-0.2.0.zip |
| Downloads | 15 |
| Dependency string | KRWMods-ZUI_Lib-0.2.0 |
This mod requires the following mods to function
BepInEx-BepInExPack
BepInEx pack for Mono Unity games. Preconfigured and ready to use.
Preferred version: 5.4.2100README
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 with 3-zone layouts (leading icons, metadata, selection, action buttons)
- 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,ZUIDefaultIcons,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)
CHANGELOG
Changelog
0.2.0
- Added 3-zone layout to right panel cards (leading icons, content, trailing metadata and action buttons)
- Added active card selection (
SetSelected) and background tinting without needing bracket tags - Added right-aligned metadata text (
SetRightText) - Added left-aligned action buttons (
AddLeftButton) in addition to right action buttons - Added custom content escape hatch (
AttachCustomContent) to mount custom UI hierarchies into cards - Added default circle indicator icon (
ZUIDefaultIcons.CircleIndicator) - Fixed bottom text and subtitle leaking out of card buttons due to line height and font sizing
0.1.0
- Initial release