Configuration
All settings are in config.lua. By default, everything is on 'auto' — you only need to change settings if auto-detection doesn't work for your setup.
Framework
HZBridge.Framework = 'auto'
| Option | Description |
|---|---|
'auto' | Auto-detect (recommended) |
'esx' | Force ESX |
'qbcore' | Force QBCore |
'qbox' | Force QBox (QBX) |
'ox' | Force Ox Core |
'vrp' | Force vRP |
'standalone' | No framework |
qbx_core > qb-core > es_extended > ox_core > vRP > standalone
Inventory
HZBridge.Inventory = 'auto'
| Option | Description |
|---|---|
'auto' | Auto-detect (recommended) |
'ox_inventory' | Force ox\_inventory |
'qs-inventory' | Force qs-inventory |
'ps-inventory' | Force ps-inventory |
'codem-inventory' | Force codem-inventory |
'core_inventory' | Force core\_inventory |
'origen_inventory' | Force origen\_inventory |
'tgiann-inventory' | Force tgiann-inventory |
'framework' | Use framework native inventory |
Notifications
HZBridge.Notifications = 'auto'
| Option | Description |
|---|---|
'auto' | Auto-detect (recommended) |
'ox_lib' | Force ox\_lib notifications |
'okok' | Force okokNotify |
'mythic' | Force mythic\_notify |
'codem' | Force codem-notification |
'pnotify' | Force pNotify |
'framework' | Use framework native notify |
'gta' | GTA V native text |
Target / Interaction
HZBridge.Target = 'auto'
| Option | Description |
|---|---|
'auto' | Auto-detect (recommended) |
'ox_target' | Force ox\_target |
'qb-target' | Force qb-target |
'interact' | Force interact system |
'builtin' | Built-in TextUI fallback |
Menu / UI
HZBridge.Menu = 'auto'
| Option | Description | Features |
|---|---|---|
'auto' | Auto-detect (recommended) | — |
'ox_lib' | Force ox\_lib | Context, Input, Alert, TextUI, Progress, Menu |
'qb-menu' | Force qb-menu | Context, Input (qb-input), TextUI (qb-core) |
'esx' | Force ESX menu | Context, List menu, TextUI |
'native' | GTA native fallback | Keyboard input, help text (limited) |
ox_lib > qb-menu > esx_menu_default > native
The
'native' fallback provides basic functionality but is limited. For the best experience, install ox\_lib or qb-menu.Dispatch
HZBridge.Dispatch = 'auto'
| Option | Description |
|---|---|
'auto' | Auto-detect (recommended) |
'cd_dispatch' | Force cd\_dispatch |
'ps-dispatch' | Force ps-dispatch |
'qs-dispatch' | Force qs-dispatch |
'rcore_dispatch' | Force rcore\_dispatch |
'emergencydispatch' | Force emergencydispatch |
'builtin' | Built-in notification + blip |
Callbacks
HZBridge.Callback = {
Timeout = 15000, -- ms before timeout (default 15s)
RateLimit = 50, -- max requests/second per player (0 = disabled)
}
| Parameter | Type | Description |
|---|---|---|
Timeout | integer | Milliseconds before a callback times out |
RateLimit | integer | Max requests per second per player (0 = no limit) |
Debug
HZBridge.Debug = false
Set to true to enable verbose logging with [HZ Bridge] prefix in the console. Useful for troubleshooting detection issues.
Full Example
HZBridge = {}
HZBridge.Framework = 'auto'
HZBridge.Inventory = 'auto'
HZBridge.Notifications = 'auto'
HZBridge.Dispatch = 'auto'
HZBridge.Target = 'auto'
HZBridge.Menu = 'auto'
HZBridge.Callback = {
Timeout = 15000,
RateLimit = 50,
}
HZBridge.Debug = false
Recommendation: Leave everything on
'auto' unless you have a specific reason to override. The auto-detection is reliable and covers all common setups.