Known Bugs

Current known issues with ZUI and their status.

📋 Table of Contents

• Critical Issues
• Major Issues
• Reporting New Bugs
• Contributing Fixes

Critical Issues

1. Level Up Panel - Incorrect Values

Status: 🔴 Critical - Do Not Use

Description: The level up panel sometimes sends incorrect values and requires a complete rework. The functionality is unreliable and may cause unexpected behavior.

Impact:

• Incorrect data being passed to level-up systems
• Potential game-breaking bugs if used in production
• Can corrupt player progression or save files
• Unpredictable behavior

Recommendation:

⚠️ DO NOT USE the level up panel feature in your mods until this issue is resolved.

The level up panel may or may not work correctly and should be avoided in production environments. Using this feature could result in broken gameplay or save file corruption.

Workaround: Implement your own level-up UI system outside of ZUI's built-in panel, or wait for the rework to be completed.

Resolution Plan: This feature requires a full rework from the ground up. It is currently on the development roadmap but does not have an estimated completion date.

Major Issues

2. Input Blocking Not Working

Status: 🟡 Active Issue

Description: Input blocking functionality does not work as intended. When ZUI windows are open, game inputs are not properly blocked, which can cause unintended interactions with the game world behind the UI.

Impact:

• Players may accidentally interact with game elements while using UI
• Reduces UI usability and user experience
• Can lead to accidental actions (movement, attacks, etc.)

Workaround: None currently available. Users should be careful when interacting with ZUI windows to avoid unintended game actions.

Bounty Status:

💰 $20 Bounty Available

If input blocking has not been resolved by March 1, 2026, a $20 bounty will be placed for anyone who successfully submits a Pull Request to the ZUI main repository that fixes this issue.

Requirements for bounty:

• PR must be submitted to the official ZUI repository
• Fix must properly block all game inputs when the user is interacting with ZUI panels
• Code must be well-documented and maintainable
• Must pass testing and review process

Minor Issues

3. Custom UI Panels - Unnecessary Scrolling

Status: 🟢 Minor Issue

Description: Custom UI panels allow scrolling even when the panel is at full size and does not need scrolling. The scroll functionality remains active regardless of whether there is overflow content.

Impact:

• Slight UX annoyance
• Can accidentally scroll content that doesn't need scrolling
• Visual confusion for users
• No functional breaking issues

Workaround: None needed - this is a cosmetic/UX issue that doesn't prevent functionality.

Resolution Plan: Low priority fix. Scrolling should be conditionally enabled only when content exceeds panel dimensions.

Reporting New Bugs

Found a bug not listed here? Help improve ZUI by reporting it!

How to Report

1. Check existing issues - Make sure it hasn't been reported already
2. Gather information:
   • ZUI version
   • V Rising version
   • Steps to reproduce
   • Expected behavior vs actual behavior
   • Any error messages or logs
3. Create detailed report - The more information, the better

What to Include

**Bug Title:** Brief description

**ZUI Version:** X.X.X
**V Rising Version:** X.X.X
**BepInEx Version:** X.X.X

**Description:**
Clear description of the issue

**Steps to Reproduce:**
1. First step
2. Second step
3. etc.

**Expected Behavior:**
What should happen

**Actual Behavior:**
What actually happens

**Logs/Screenshots:**
Attach relevant logs or screenshots

**Additional Context:**
Any other relevant information

Where to Report

• GitHub Issues - Official bug tracker (preferred)
• Discord - Community discussion and support
• Nexus Mods - Bug reports section

Contributing Fixes

Want to help fix these bugs? Contributions are welcome!

Getting Started

1. Fork the repository - Create your own copy
2. Create a feature branch - git checkout -b fix/issue-name
3. Make your changes - Fix the bug with well-documented code
4. Test thoroughly - Ensure the fix works and doesn't break anything else
5. Submit a Pull Request - Include description of changes and testing done

Coding Standards

• Follow existing code style and conventions
• Add comments explaining complex logic
• Include XML documentation for public methods
• Test with and without other mods installed
• Verify performance impact is minimal

Pull Request Guidelines

Your PR should include:

• Clear title describing the fix
• Detailed description of the problem and solution
• List of changes made
• Testing methodology and results
• Any breaking changes or migration notes

Example PR Description:

## Fix: Input Blocking Not Working

### Problem
Input blocking was not properly preventing game inputs when ZUI windows were active.

### Solution
Implemented proper input capture using Unity's new Input System and added event blocking for legacy input methods.

### Changes
- Added InputBlocker.cs class to manage input state
- Hooked into Unity Input System events
- Added fallback for legacy Input class
- Updated window activation to enable/disable input blocking

### Testing
- Tested with multiple windows open
- Verified game inputs blocked when UI active
- Confirmed inputs resume when UI closed
- Tested with both keyboard and mouse inputs
- No performance impact detected

### Breaking Changes
None - backwards compatible with existing integrations

Bug Priority Levels

🔴 Critical

• Breaks core functionality
• Causes crashes or data loss
• Major security issues
• Must be avoided in production

🟡 Major

• Significant functionality impaired
• Noticeable impact on user experience
• Workarounds available but inconvenient

🟢 Minor

• Small issues with limited impact
• Cosmetic problems
• Edge cases
• Nice-to-have fixes

Stability Notes

ZUI is actively developed and maintained. While these bugs exist, the core functionality remains stable for most use cases. The majority of ZUI features work as intended and are production-ready.

Stable Features:

• ✅ Main menu button integration
• ✅ Custom window creation
• ✅ Text, buttons, and categories
• ✅ Image support
• ✅ Rich text formatting
• ✅ Event system (OnButtonsChanged)

Unstable Features:

• ❌ Input blocking
• ❌ Level up panel

When using ZUI, focus on the stable features and avoid known problematic areas until they are resolved.

Update Frequency

This page is updated as:

• New bugs are discovered and confirmed
• Existing bugs are fixed or worked around
• Status changes occur (bounties placed, fixes in progress, etc.)

Last Updated: January 2026

Related Pages

• Troubleshooting - Common issues and solutions
• API Reference - Complete method documentation
• Getting Started - Installation and setup
• Contributing - How to contribute to ZUI

Help make ZUI better by reporting bugs and contributing fixes!