STG ScriptsDocumentation
UI PackHUD

HUD

STG UI Pack HUD with status, player info, speedometer, seatbelt, nitro and a player settings menu.

Status, player info and vehicle HUD in the UI Pack design. The resource is stg-hudv2 and it is free.

Installation

Download the script

Download stg-hudv2 from the Cfx.re portal Granted Assets.

Remove your old HUD

Stop any other HUD (qbx_hud, qb-hud, esx_hud, stg-hud), otherwise two HUDs draw on top of each other.

Start it

Put stg-hudv2 inside resources/[STG], after your framework, ox_lib and stg_lib (ensure [STG]). Restart the whole server.

Add the nitro item

The HUD's nitro uses an item called nos, which is not in the default item lists. Add it:

In ox_inventory/data/items.lua, paste above the last }:

['nos'] = {
    label = 'NOS',
    weight = 1000,
    stack = true,
    close = true,
    description = 'Use it next to a vehicle to fill its nitro tank',
},

In qb-core/shared/items.lua, add:

nos = { name = 'nos', label = 'NOS', weight = 1000, type = 'item', image = 'nitrous.png', unique = false, useable = true, shouldClose = true, description = 'Use it next to a vehicle to fill its nitro tank' },

Or set Config.Nitro.Item = 'nitrous' to use the stock QBCore item.

What it shows

  • Health, armour, hunger, thirst, stamina, oxygen under water, stress and the pma-voice range.
  • Ping, server ID, online players, clock, character name and job, cash, bank and black money.
  • Speed, gear, fuel, engine, lock, seatbelt and lights while driving.

Player settings

/hud or F10 opens the settings: status style, colours, speedometer style, speed unit, size, clock, minimap, cinematic mode (F9) and a drag editor. Each player's choices are saved on their own PC.

Configuration

stg-hudv2/shared/config.lua:

SettingWhat it does
Config.ColorAccent colour
Config.BrandLogo text in the top right
Config.SettingsCommand / Config.SettingsKey/hud and F10
Config.StatusWhich gauges hide when empty
Config.BlackMoney'auto' reads black_money on ESX and markedbills on QBCore / QBOX
Config.SeatbeltBuilt-in seatbelt on B
Config.NitroNitro item and tank
Config.HelpKeysKey hints on the left, empty table hides them

shared/functions.lua: fuel, notify and seatbelt resources.

Good to know

  • Seatbelt on ESX: if esx_cruisecontrol runs, its seatbelt (also on B) is used and the HUD follows it. Stop it to use the STG seatbelt. Other seatbelt scripts: set Config.Seatbelt.Enabled = false and point IsSeatbeltOn in shared/functions.lua at their state.
  • Stress on ESX: ESX has no stress, so the gauge stays hidden until a script sends hud:client:UpdateStress or an esx_status called stress.

Exports (client)

exports['stg-hudv2']:hideHud()
exports['stg-hudv2']:showHud()
exports['stg-hudv2']:isVisible()
exports['stg-hudv2']:setColor('#00A6FA')
exports['stg-hudv2']:setCinematic(true)
exports['stg-hudv2']:progress(label, duration) -- returns true when finished
exports['stg-hudv2']:cancelProgress()

Still having trouble?

Open a ticket on our Discord. Our team answers around 15 hours a day.

Get help on Discord

On this page