Installation

📥

One resource, multiple subsystems

The package bundles UI modules, announcements, radial compatibility, and an optional chat replacement in one resource.

Download the Resource

Download the latest version of mizu_interface from your Cfx.re Portal .

Place in Your Resources Folder

Extract the folder into your server’s resources directory. We recommend organizing it inside a [mizu] or [ui] subfolder.

⚠️

Warning

Do not rename the folder. The resource name must remain mizu_interface exactly because the UI files load by this name.

Add to server.cfg

Open your server.cfg and add the resource after your framework, but before scripts that call its exports.


stop chat            # only if you want to use the built-in mizu chat

# Framework first
ensure qb-core       # or qbx_core / es_extended

# Mizu Interface
ensure mizu_interface

If you only want the UI modules and do not plan to use the custom chat, you can leave the native chat resource running and simply ignore the chat exports.

Configure

Open config.lua and set your locale, module toggles, notification defaults, radial items, and chat settings to match your server. See the Configurations page for the full reference.

Done!

Restart your server. The resource initializes automatically:

🔍

Auto-detects

QBCore, QBOX, ESX, or Standalone

🌍

Loads locale

Based on Config.Locale

⚡

Module-based

Each system can be toggled independently

✅ Next Steps

→ Replace framework notify/progress/chat entry points with Integrations → Use the current export set, including chat hooks → Preview the UI modules and chat