Skip to content

FWB HUD β€” Configuration ​

FWB HUD has no config file to edit. Commands, language, keys, features and the default look are all set in game with /fwb_hud and saved in the server KVP. A few things that need code live in open Lua files under bridge/.


Admin Panel (/fwb_hud) ​

PageWhat you set there
OverviewActive framework and notification script, version check, players online, warnings.
Server lookStyle the HUD (theme, preset, logo, layout, values, map / speed / money) and save it as the default for everyone.
StatusesWhich statuses show, their order, icon, colour, low / warning levels, and custom statuses.
FeaturesSeatbelt (crashes, injuries, reminder, racing harness), cruise control, engine, indicators, nitro (settings, per vehicle, blacklist, refill), stress (settings, per job, per weapon), weapon card, clock.
VehiclesElectric models, speedometer type per model (car / cycle / aircraft / electric), fuel.
PlayersEvery online player's live statuses, stress and HUD; reset a player's HUD.
PermissionsWhat players may change in their own menu (theme, positions…).
Commands & keysCommand names, default keys, language, refresh rates and Debug.
BridgeFramework and notification script (auto-detect or pick one).

Player Menu (/hudsettings) ​

TabWhat players set there
ThemesPick a theme and preset, customise it, save their own presets.
LayoutShow or hide pieces, open the drag-and-drop editor, whole-HUD size.
ValuesWhen status numbers show (never, when low, always).
Map, speed & moneyMinimap shape and mode, speed unit and speedometer options, money display mode.
KeysEvery key the HUD uses.

Open Files ​

FileWhat it is for
bridge/defaults/statuses.luaWhere each status gets its value. Read on every start β€” edit and restart.
bridge/defaults/server.luaFirst-start values of the admin panel (commands, keys, features) and the safe ranges for its numbers.
bridge/defaults/themes.luaThemes and presets in the Themes tab. Add your own presets here.
bridge/defaults/minimap.luaMinimap position offsets for square and round maps.
bridge/integrations/client.luaFuel / battery, electric detection and other scripts' seatbelt, cruise and status events.
bridge/integrations/server.luaHooks for other server scripts (stress, statuses).
shared/stress.luaBuilt-in per-weapon and per-job stress tables (also edited in the admin panel).
locale/*.luaTranslations: en, de, fr, es.

TIP

bridge/defaults/server.lua only fills in values the admin has never changed. After the first start, change them in /fwb_hud.


Status Sources (bridge/defaults/statuses.lua) ​

lua
Defaults.Statuses = {
    { id = 'health',  label = 'Health',  icon = 'fa:heart',      color = '#ff4d6d', source = 'native', core = true, ring = true },
    { id = 'hunger',  label = 'Hunger',  icon = 'fa:burger',     color = '#ffb347', source = 'framework', status = 'hunger', low = 20, ring = true },
    { id = 'stress',  label = 'Stress',  icon = 'fa:brain',      color = '#c084fc', source = 'event', inverted = true, enabled = false, ring = true },
    { id = 'hygiene', label = 'Hygiene', icon = 'fa:soap',       color = '#5eead4', source = 'event', event = 'cr_hygiene:needs', field = 'hygiene', resource = 'cr_hygiene', low = 25, warn = 50 },
    -- ...
}
sourceWhere the value comes from
nativeThe game (health, armor, stamina, oxygen).
frameworkThe active bridge, by the name in status (ESX: esx_status names; QBCore / Qbox: metadata).
eventA client event with a 0–100 value (event, default fwb_hud:status:<id>).
exportexports[resource][export](), polled every status tick.

Every status also accepts exports.fwb_hud:SetStatus(id, value). The look fields (label, icon, colour, low / warn) are only starting values β€” after the first start, edit them in /fwb_hud β†’ Statuses.


Default Keys ​

ActionKey
SeatbeltK
Cruise controlY
EngineG
Indicators left / right / hazard← / β†’ / ↑
Nitro boostLeft Shift
Cancel a progress barX
Cinematic modeF9
Show money (hold)F10

Players can rebind them in GTA's key bindings (FiveM section) or in /hudsettings β†’ Keys.

FWB Studio documentation.