Installation

Before you start, make sure you're logged into the CFX portal. This ensures you can download the asset and receive future updates.

Downloading Dependencies

Framework must be running. Integrations (status, voice, fuel, seatbelt, inventory) are auto-detected when their resources are started.

1

Framework

One of:

• ESX (es_extended)

• QBCore (qb-core)

• Qbox (qbx_core)

Standalone mode works for UI-only testing, but money / job / status will be limited.

2

Status (recommended)

• ESX: esx_status

• QBCore: metadata via qb-core

• Qbox: built-in metadata bridge (qbox)

3

Voice (optional)

pma-voice, mumble-voip or saltychat

4

Fuel (optional)

ox_fuel, LegacyFuel, ps-fuel, cdn-fuel, and similar. Falls back to native fuel when none is found.

---

Server.cfg

Start your framework first, then the HUD. Example:

ensure es_extended   # or qb-core / qbx_core
ensure esx_status    # if ESX hunger/thirst
ensure pma-voice     # optional
ensure ox_fuel       # optional
ensure op-hud

Resource folder name must stay op-hud (matches fxmanifest.lua / NUI paths).

---

First Setup

1

Locale and branding

Edit config/MainConfig.lua (Config.Locale) and config/HudConfig.lua (Config.Branding).

2

Grant HUD admin

Follow How to grant HUD admin, then open /hudsettings and use the Default Settings / Permissions tabs.

3

Set server defaults (optional)

Follow How to set server defaults so new players start with your layout.

4

Wire other scripts

Use Notify and Progress from jobs / inventory / phone scripts.