Skip to content

helix_hud ​

helix_hud is a high-performance FiveM HUD that leverages the helix_lib framework bridge and NUI design system for a seamless experience across ESX, QBCore, and Qbox.

Version: 1.0.0 | License: MIT | Dependency: helix_lib


Features ​

  • Sub-0.05ms idle resmon — Built for performance with zero polling overhead
  • Event-driven updates — Player data (money, job) synced via framework events, not polling
  • Vehicle HUD — Speed, fuel, seatbelt, and engine status when in a vehicle
  • Status bars — Health, armour, hunger, thirst, stress (configurable)
  • Pause menu awareness — HUD auto-hides in the pause menu
  • Framework agnostic — Works identically on ESX, QBCore, and Qbox via helix_lib bridge

Requirements ​

Installation ​

  1. Download the latest release from GitHub
  2. Place helix_hud in your resources folder
  3. Add ensure helix_hud to your server.cfg (after helix_lib)
  4. Configure config.lua to your liking
  5. Restart your server

Directory Structure ​

helix_hud/
├── fxmanifest.lua
├── config.lua              # All configuration
├── client/
│   ├── utils.lua           # Client utility functions
│   ├── status.lua          # Health, armour, hunger, thirst, stress
│   ├── vehicle.lua         # Vehicle speed, fuel, engine, seatbelt
│   └── main.lua            # HUD controller, NUI bridge, exports
├── server/
│   └── main.lua            # Player data provider
└── html/                   # Built NUI output (React + Vite)

Configuration ​

All configuration lives in config.lua. Key options:

General ​

OptionTypeDefaultDescription
Config.frameworkstring'auto''auto', 'qbox', 'qbcore', 'esx', or 'standalone'
Config.themestring'dark'Theme: 'dark' or 'light'
Config.positionstring'bottom-right''bottom-right', 'bottom-left', or 'bottom-center'
Config.scalenumber1.0Global scale multiplier
Config.hideInPauseMenubooleantrueAuto-hide the HUD when the pause menu is open

Elements ​

Toggle individual HUD elements on or off:

ElementDefaultDescription
healthtrueHealth bar
armortrueArmour bar
hungertrueHunger bar
thirsttrueThirst bar
stressfalseStress bar (off by default; not all servers use it)
staminatrueStamina bar
cashtrueCash display
bankfalseBank balance (off by default for privacy)
jobtrueCurrent job label
serverIdtruePlayer server ID

Vehicle HUD ​

OptionTypeDefaultDescription
Config.vehicle.enabledbooleantrueEnable or disable the vehicle HUD entirely
Config.vehicle.speedUnitstring'kmh''kmh' or 'mph'
Config.vehicle.fuelScriptstring'auto'Auto-detect or force: 'LegacyFuel', 'ox_fuel', 'cdn-fuel'
Config.vehicle.seatbeltbooleantrueShow seatbelt indicator

Update Intervals ​

OptionTypeDefaultDescription
Config.updateIntervals.healthnumber200Milliseconds between status polls (health, armour, hunger, thirst, stress, stamina)
Config.updateIntervals.vehiclenumber100Milliseconds between vehicle polls (speed, fuel, engine, seatbelt)

Exports ​

Client Exports ​

ExportReturnsDescription
setVisible(visible)voidShow or hide the HUD
isVisible()booleanCheck if the HUD is currently visible
lua
-- Hide the HUD (e.g. during a cutscene)
exports.helix_hud:setVisible(false)

-- Check visibility
if exports.helix_hud:isVisible() then
    print('HUD is showing')
end

Commands ​

CommandDescription
/hudToggle HUD visibility on or off

Premium FiveM Scripts for Qbox, QBCore & ESX