Admin Panel

HZ-Bridge ships a centralised admin panel that every HZ-Script module plugs into. Instead of each script shipping its own command + UI for config, everything lives behind a single /hzpanel accessible to admins. The panel auto-builds a typed editor for every config field declared in each module's bridge_schema.lua.

Opening the panel

In-game (chat, F8 console, or keybind):

/hzpanel

• Console-only (server F8) — /hzpanel from the server console does not open the NUI. Type it from in-game.
• Requires the ACE permission configured under HZBridge.Panel.AcePermission (default admin) — see Permissions setup below.
• Press Escape or click the close button to leave. Sessions are token-gated and time out after HZBridge.Panel.SessionTokenTtlMs (5 min default) — re-open to refresh.

-- server export — opens the panel for src and preselects the named module
exports['HZ-Bridge']:OpenPanel(src, 'HZ-Weather')

Permissions setup

The panel is gated by the canonical FXServer admin ACE node. Two server.cfg lines are required:

add_principal identifier.license:YOUR_LICENSE group.admin
add_ace group.admin admin allow

Replace YOUR_LICENSE with the player license from your server (visible by typing /hzpanel once — the failed-check console output prints all your identifiers + a copy-paste-ready block with your license already interpolated).

You can paste both lines directly into the server console for an instant fix — no restart required. If you put them in server.cfg, restart FXServer (or re-exec server.cfg) so they're loaded.

The framework probe falls back to qb-core / qbx_core / ESX / ox_core admin tables if the ACE check fails. So a player marked as admin in your qbcore_admins table can open the panel even without the ACE setup. But ACE is the recommended path because it's framework-agnostic and auditable in one place.

If the check fails, the server console prints :

• The exact ACE node being checked
• All your player identifiers
• An ACE probe matrix (which nodes are granted, which aren't)
• The two exact add_principal + add_ace lines to copy-paste, with your license already interpolated

Custom ACE node

If you don't want to use the canonical admin node (e.g. you only want a specific subset of staff to open the panel without giving them every other admin command), configure a custom node in config.lua :

HZBridge.Panel.AcePermission = 'hzbridge.panel.admin'

Then in server.cfg :

add_principal identifier.license:YOUR_LICENSE group.hzbridge.staff
add_ace group.hzbridge.staff hzbridge.panel.admin allow

The fallback (when AcePermission is nil or '') is 'admin' — aligned on the config default since v1.1.1. Older versions used 'HZ-Bridge.admin' as the fallback, which was a documented mismatch and locked out customers who only had the canonical admin ACE granted. Upgrade to v1.1.1 if you're affected.

What you can edit

The panel auto-discovers every resource that ships a bridge_schema.lua file at its root. As of HZ-Bridge v1.1.0, the following modules ship a schema and integrate into the panel:

The schema DSL

Each module's bridge_schema.lua is a small Lua DSL that declares the config the panel exposes. The DSL runs in a sandboxed environment (no _G, no raw io, restricted string / table / math subsets) so a buggy or malicious schema can't break the server.

Minimal example

-- resources/your-script/bridge_schema.lua
module('your-script', {
    schemaVersion = 1,
    label = { en = 'Your Script', fr = 'Ton script' },
}, function()
    section('general', {
        label = { en = 'General', fr = 'Général' },
    }, function()
        field('Enabled', 'boolean', {
            default = true,
            label = { en = 'Enabled', fr = 'Activé' },
            description = {
                en = 'Master on/off switch for the script.',
                fr = 'Interrupteur global du script.',
            },
        })

field('PlayerLimit', 'number', {
            default = 32, min = 1, max = 256, step = 1,
            label = { en = 'Max concurrent players', fr = 'Joueurs simultanés max' },
        })
    end)
end)

That's it — open /hzpanel, the "Your Script" tab appears with two typed fields, value changes are written back to disk and broadcast to every client that subscribes.

Field types

-- bridge_schema.lua
field('ZonesEditor', 'view', {
    component = 'HZ-Weather:ZoneEditor',
    events = {
        upsertZone = 'hz_weather:admin:upsertZone',
        deleteZone = 'hz_weather:admin:deleteZone',
    },
})

// web/src/views/HZ-Weather/index.tsx
import { registerView } from '../registry'
import { ZoneEditor } from './ZoneEditor'
registerView('HZ-Weather:ZoneEditor', ZoneEditor)

-- server (any resource)
AddEventHandler('HZ-Bridge:theme:updated', function(theme)
    -- theme: { preset, accent, accentHi, gold, surface, subpanel, tint,
    --         gradientMode, radiusNone, radiusXs, radiusSm, ..., radiusXl }
end)

-- client
RegisterNetEvent('HZ-Bridge:theme:updated', function(theme)
    SendNUIMessage({ action = 'theme', data = theme })
end)

local theme = exports['HZ-Bridge']:GetTheme()