Installation

📥

Plug & Play

No dependencies required. Start the resource and everything works automatically.

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 — the UI files load by this name.

Add to server.cfg

Open your server.cfg and add the resource early in your startup list. UI resources should start before any scripts that use their exports.


# Mizu Framework
ensure mizu_interface

Configure

Open config.lua and set your locale, notification position, and any other 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

⚡

0.00ms idle

No active polling at rest

✅ Next Steps

→ Replace your framework’s native notifications with Integrations → Start using exports in your scripts → Customize every setting in config.lua