Home/Documentation/Vitality HUD
Interfaces / 1.4.70

Vitality HUD

Set up the QBOX HUD, customize widget layouts, and connect optional banking, notification, and mileage integrations.

Requirements

Vitality HUD is designed for QBOX / qbx_core. Optional integrations include vrp-notify, vrp-banking, vrp-progression, and vrp-mechanic; these are not bundled with the commercial HUD.

The distributed config.lua is readable even when protected by Cfx Asset Escrow.

Installation

  1. Place vrp-hud in your resource directory and confirm the fxmanifest.lua is in the folder root.
  2. Ensure QBOX loads first; then start Vitality HUD.
  3. Remove or disable competing HUDs that render the same modules/minimap.
  4. Join the server and run /hud to customize your layout.
cfg
ensure qbx_core
ensure vrp-hud

When updating, replace the full old vrp-hud resource folder to avoid leaving outdated UI files behind.

HUD Studio

Players can use /hud to move, resize, group, show, and hide widgets. Layouts are saved so each player can keep a personalized interface.

Common modules include health, armor, stamina, hunger/thirst, stress, breath, voice, minimap, money, ammo, and vehicle instrumentation. Vehicle widgets include speed, RPM, gear, fuel, and seatbelt.

in-game command
/hud

Configuration

  • Config.Command — editor command (default hud).
  • Config.DefaultUnit — mph or kmh.
  • Config.DefaultMinimapMode — always, vehicle, or off.
  • Config.EnableStress, Config.ShowVoice, Config.ShowBreath and other switches — server-wide modules.
  • Config.StatusProvider — callbacks for your server's hunger/thirst/stress values.
  • Config.BankingResource, Config.NotifyResource, and Config.MechanicMileageBridge — optional integrations.

The HUD's bank widget falls back to QBOX player bank data when its optional banking resource is absent.

Important release note

Dispatch was removed from the commercial HUD in v1.4.70. It no longer includes a dispatch board, dispatch alert integrations, or dispatch layout widget. Old dispatch-only saved preferences are discarded while other saved HUD layouts remain.

Use a dedicated dispatch system separately if your community requires dispatch.

Troubleshooting

  • Duplicate HUD elements: disable the existing HUD and relevant vanilla or third-party modules.
  • Vitals read incorrectly: adapt Config.StatusProvider to the state keys used by your framework.
  • Missing money or mileage: confirm the optional integration is running; those integrations are not required for the core HUD.
  • After an update: remove stale NUI files by replacing the whole resource rather than overwriting only a few files.

Still need assistance?

Include your resource version and any relevant console errors when asking for help.

Get support ↗All documentation