Built-in Integrations

ZUI includes native support for several popular V Rising server mods. These integrations provide ready-to-use UI interfaces for mod functionality.

📋 Table of Contents

• Overview
• BloodCraft
• KinPonds
• ScarletSigns
• KindredCommands
• Enabling Integrations
• Configuration

Overview

ZUI provides pre-built UI integrations for popular V Rising mods. These integrations are:

• Optional - Disabled by default, enable in config
• Automatic - No coding required when enabled
• Server-side aware - Only activate when the server mod is detected
• Configurable - Can be enabled/disabled per integration

Supported Mods

BloodCraft

BloodCraft is an economy and progression system for V Rising servers.

Features

ZUI's BloodCraft integration provides:

• Economy Display - View your currency/points
• Shop Interface - Browse and purchase items
• Leaderboard Access - View top players
• Quick Actions - Common economy commands
• Progression Tracking - View your advancement

UI Elements

When enabled, ZUI adds a "BloodCraft" section to the main menu with:

• Currency balance display
• Shop access button
• Leaderboard viewer
• Quick purchase shortcuts
• Economy statistics

Requirements

• BloodCraft mod installed on server
• ZUI BloodCraft integration enabled in config
• Player connected to BloodCraft-enabled server

Configuration

Enable in ZUI.cfg:

[Integrations]
EnableBloodCraft = true

Usage

1. Open ZUI main menu
2. Navigate to "BloodCraft" section
3. View balance, access shop, or check leaderboards
4. Click buttons to execute commands

KinPonds

KinPonds is a custom clan management system.

Features

ZUI's KinPonds integration provides:

• Clan Information - View your clan details
• Member List - See clan members and status
• Clan Management - Invite, kick, promote members
• Clan Features - Access clan-specific commands
• Clan Chat - Quick access to clan communication

UI Elements

When enabled, ZUI adds a "KinPonds" section with:

• Clan name and tag display
• Member roster
• Management buttons (for leaders)
• Clan statistics
• Quick action buttons

Requirements

• KinPonds mod installed on server
• ZUI KinPonds integration enabled in config
• Player connected to KinPonds-enabled server
• Player in a clan (for full features)

Configuration

Enable in ZUI.cfg:

[Integrations]
EnableKinPonds = true

Usage

1. Open ZUI main menu
2. Navigate to "KinPonds" section
3. View clan info and members
4. Use management buttons (if clan leader)
5. Access clan features and commands

ScarletSigns

ScarletSigns is a custom sign creation and management system.

Features

ZUI's ScarletSigns integration provides:

• Sign Creation - Create custom signs
• Sign Editing - Modify existing signs
• Sign Management - List and manage your signs
• Template Access - Use pre-made sign templates
• Quick Placement - Easy sign positioning

UI Elements

When enabled, ZUI adds a "ScarletSigns" section with:

• Create new sign button
• Edit sign interface
• Sign list viewer
• Template selector
• Sign management tools

Requirements

• ScarletSigns mod installed on server
• ZUI ScarletSigns integration enabled in config
• Player connected to ScarletSigns-enabled server

Configuration

Enable in ZUI.cfg:

[Integrations]
EnableScarletSigns = true

Usage

1. Open ZUI main menu
2. Navigate to "ScarletSigns" section
3. Click "Create Sign" to make a new sign
4. Use editing tools to customize
5. Manage existing signs from the list

KindredCommands

KindredCommands is an extended command framework providing additional server commands.

Features

ZUI's KindredCommands integration provides:

• Command Quick Access - Frequently used commands as buttons
• Admin Tools - Administrative command shortcuts
• Player Commands - Common player commands
• Server Commands - Server management tools
• Organized Categories - Commands grouped by function

UI Elements

When enabled, ZUI adds a "Commands" section with:

• Player command category
• Admin command category (if admin)
• Server management category
• Utility commands
• Quick action buttons

Requirements

• KindredCommands mod installed on server
• ZUI KindredCommands integration enabled in config
• Player connected to KindredCommands-enabled server
• Admin permissions (for admin commands)

Configuration

Enable in ZUI.cfg:

[Integrations]
EnableKindredCommands = true

Usage

1. Open ZUI main menu
2. Navigate to "Commands" section
3. Browse categorized commands
4. Click button to execute command
5. Admin-only commands shown if you have permissions

Enabling Integrations

Configuration File Location

BepInEx/config/ZUI.cfg

Default Configuration

By default, all integrations are disabled:

[Integrations]
EnableBloodCraft = false
EnableKinPonds = false
EnableScarletSigns = false
EnableKindredCommands = false

Enabling an Integration

1. Open BepInEx/config/ZUI.cfg
2. Find the [Integrations] section
3. Set the desired integration to true:

   EnableBloodCraft = true
   

4. Save the file
5. Restart V Rising

Enabling Multiple Integrations

You can enable as many integrations as needed:

[Integrations]
EnableBloodCraft = true
EnableKinPonds = true
EnableScarletSigns = false
EnableKindredCommands = true

Configuration

Complete Integration Configuration

Here's the full integration section from ZUI.cfg:

[Integrations]

## Enable BloodCraft UI integration
# Setting type: Boolean
# Default value: false
EnableBloodCraft = false

## Enable KinPonds UI integration
# Setting type: Boolean
# Default value: false
EnableKinPonds = false

## Enable ScarletSigns UI integration
# Setting type: Boolean
# Default value: false
EnableScarletSigns = false

## Enable KindredCommands UI integration
# Setting type: Boolean
# Default value: false
EnableKindredCommands = false

When to Enable

Enable an integration when:

• ✅ You play on a server with that mod installed
• ✅ You want UI access to that mod's features
• ✅ You prefer UI buttons over chat commands

Keep disabled when:

• ❌ Server doesn't have the mod
• ❌ You prefer using chat commands
• ❌ You want a cleaner UI with fewer options

Server Detection

ZUI automatically detects if the server has these mods installed. Even if you enable an integration in config, it will only appear if:

1. Integration is enabled in ZUI.cfg
2. You're connected to a server
3. The server has that mod installed and running

Example:

EnableBloodCraft = true  # Enabled in config

• ✅ Connect to server with BloodCraft → UI appears
• ❌ Connect to server without BloodCraft → UI doesn't appear (no error)

This prevents clutter when playing on servers without certain mods.

Troubleshooting Integrations

Integration enabled but doesn't appear

Possible Causes:

1. Server doesn't have the mod installed
2. Server mod version incompatible
3. ZUI version outdated

Solutions:

✅ Verify server has the mod:

• Ask server admin
• Check server mod list
• Test the mod's commands manually

✅ Check versions:

• Update ZUI to latest version
• Ensure server mod is up to date
• Check compatibility notes

✅ Restart game:

• Configuration changes require restart
• Reconnect to server after config change

Integration appears but buttons don't work

Possible Causes:

1. Insufficient permissions
2. Command format changed
3. Server-side configuration

Solutions:

✅ Check permissions:

• Some features require admin/moderator status
• Verify your server permissions

✅ Test manually:

• Try the command in chat
• Example: .bloodcraft shop (for BloodCraft)
• If manual command works, report to ZUI

✅ Check server logs:

• Server may be blocking commands
• Server config may have restrictions

Multiple integrations cause clutter

Solution:

Disable integrations you don't use:

[Integrations]
EnableBloodCraft = true      # Keep enabled
EnableKinPonds = false       # Disable if not used
EnableScarletSigns = false   # Disable if not used
EnableKindredCommands = true # Keep enabled

This keeps your UI clean and focused.

Integration Updates

Checking for Updates

Integrations may be updated when:

• ZUI is updated
• The integrated mod is updated
• New features are added

Stay updated:

1. Check ZUI changelog for integration updates
2. Update ZUI when new versions release
3. Monitor integrated mod updates

Version Compatibility

Check ZUI release notes for specific version compatibility

_{Certain features of BloodCraft are WIP and do not always work as intended. Looking at you Level panel}

Custom Integration Development

Want to add your mod to ZUI? See the development documentation for:

• Integration API
• Registration process
• Best practices
• Example implementations

Note: Custom integrations are for mod developers. Players only need to enable built-in integrations via config.

Related Pages

• Getting Started - Initial ZUI setup
• Configuration - Full config options
• Troubleshooting - Common issues
• FAQ - Frequently asked questions

Enable the integrations you need and enjoy streamlined access to your favorite server mods!