Installation

RB HUD by RB Scripts supports Qbox, QB-Core, ESX, Ox Core, and a framework-free standalone mode. It detects a running framework automatically by default, or you can select a mode explicitly in config.lua.

Download

After purchase, download rb_hud from Cfx.re Keymaster. RB Studios does not provide a separate download page or file-delivery service.

Requirements

RB HUD does not require a database migration or SQL import. The resource manifest enforces both ox_lib and pma-voice as startup dependencies.

Keep the resource folder named rb_hud. The HUD uses that exact resource name for its own exports and NUI integration; renaming the folder will break those calls.

Install the resource

1. Extract the download into your server's resources directory as resources/[rb]/rb_hud.
2. Open config.lua and leave framework = 'auto', or choose the framework explicitly. See Configuration.
3. Optionally set setr ox:locale en in server.cfg, replacing en with an installed locale code.
4. Ensure dependencies and the selected framework before rb_hud in server.cfg.
5. Restart the server and join with a loaded character.

Start order

Use the block for your framework. Dependencies already started elsewhere in your configuration do not need a second ensure line.

Qbox

ensure ox_lib
ensure qbx_core
ensure pma-voice
ensure rb_hud

QB-Core

ensure ox_lib
ensure qb-core
ensure pma-voice
ensure rb_hud

ESX

ensure ox_lib
ensure es_extended
ensure esx_status
ensure pma-voice
ensure rb_hud

Ox Core

ensure ox_lib
ensure ox_core
ensure ox_inventory
ensure pma-voice
ensure rb_hud

Standalone

Set framework = 'standalone' in config.lua, then start only the required libraries:

ensure ox_lib
ensure pma-voice
ensure rb_hud

Standalone mode omits hunger, thirst, stress, /cash, and /bank. It retains health, armour, stamina, oxygen, weapons, voice, vehicles, aircraft, the minimap, compass, /id, and the optional /edithud command.

Verify the installation

After joining with a loaded character:

• Player health, armour, stamina, voice, and weapon information should update.
• Hunger, thirst, and stress should also update unless standalone mode is selected.
• Entering a running vehicle should display the vehicle HUD and minimap according to the player's saved display mode.
• /id should return an ox_lib notification. /cash and /bank should do so unless standalone mode is selected.
• When enableEditorCommand = true, /edithud should open HUD Studio and allow the player to drag classes, change exact layout values, and manage named profiles.

The console reports a clear startup error when a manifest dependency or framework is missing outside standalone mode, esx_status is missing from an ESX installation, or ox_lib is older than 3.37.0.

Updating

Back up your edited config.lua and any custom logo before replacing the resource. Compare new configuration fields rather than blindly restoring an old file, then restart rb_hud.

Player profiles are stored locally in the versioned rb_hud_profiles KVP and survive ordinary resource updates. Existing rb_hud_settings layouts migrate into the player's Default profile automatically.

Next steps

• Review every server option in Configuration.
• Integrate another resource through Exports.
• See the built-in Commands.
• Connect seatbelt, nitrous, or stress systems in Integrations.