Skip to Content
Mizu InterfaceDependencies

Dependencies

ℹ️
The UI stack has zero hard dependencies.

Notifications, progress bars, TextUI, skill checks, menus, dialogs, and the action panel run standalone. Frameworks only become relevant for data-driven features such as names, admin checks, dispatch, or job chat.

Core Dependencies

None required
The resource ships its own NUI, JS, CSS, localization, and compatibility layers.

Supported Frameworks

mizu_interface auto-detects your environment on startup and adapts behavior where server data matters, for example inv_busy state, admin checks, support visibility, dispatch access, and character names.

QBCore
QBCore
qb-core
  • ✓ Permission checks for /announce
  • ✓ inv_busy state sync
  • ✓ Notification routing
  • ✓ Chat character names
QBOX
QBOX
qbx_core
  • ✓ Permission checks for /announce
  • ✓ inv_busy state sync
  • ✓ Notification routing
  • ✓ Chat character names
ESX
ESX Legacy
es_extended
  • ✓ Permission checks for /announce
  • ✓ Notification routing
  • ✓ Player group detection
  • ✓ Chat character names

Radial Menu Replacement

mizu_interface automatically declares itself as a provider for native radial menu resources via the FiveM provide system. You do not need to run any of these alongside it:

qb-radialmenuqbx_radialmenuesx_radialmenu

Stub exports (AddOption, RemoveOption, setupSubItems, setupAppItems) are provided automatically to prevent crashes from scripts that try to interact with native radial menu APIs.


Chat Replacement

If you enable the built-in chat module, mizu_interface also provides the native chat resource name.

chat

Do not run the stock chat resource at the same time as the mizu_interface chat replacement. If you only want the UI modules and do not want the custom chat, keep the stock chat enabled and ignore the chat exports.


Optional Integrations

While not required, these systems unlock additional features automatically:

🛡️
txAdmin
Automatically captures Announcements, Restart Warnings, Player Warnings, Kicks, and DMs and styles them through mizu_interface.
📦
ox_inventory
Progress bars and radial menus set inv_busy state to prevent item exploits during actions.
💬
Native chat bridges
Legacy chat events such as chat:addMessage and chat:addSuggestion are forwarded into the custom chat UI.
📡
Discord Webhook
Route announcement logs to a Discord channel. Set in Config.Announce.Logging.
📊
FiveManage V3
Send announcement metadata to FiveManage centralized logging. Set in Config.Announce.Logging.
Last updated on