Docs /Ultra HUD/Configuration
v1.0.0

Configuration — foltone_ultra_hud

All settings are in config.lua. Most of these can be overridden at runtime via the admin panel.

Locale

Config.locale = "en" -- "en", "fr", etc.

Translation files are in locales/en.lua, locales/fr.lua. You can add your own language by creating a new file (e.g. locales/de.lua).

General

OptionTypeDefaultDescription
disableMinimapbooleanfalseHide the GTA minimap entirely
disableMinimapHealtharmourbooleantrueHide the default GTA health/armour bars on the minimap
disableNoMoneybooleantrueHide money fields when balance is 0
disableArmourbooleantrueAuto-hide armour bar when value is 0
disableApneabooleantrueAuto-hide apnea bar when full (not underwater)
disableStaminabooleantrueAuto-hide stamina bar when full (not sprinting)

Visibility

Each HUD element can be individually toggled. These serve as defaults and can be overridden via the admin panel.

OptionTypeDefaultDescription
idbooleantrueShow player server ID
jobbooleantrueShow job name and grade
job2booleanfalseShow second job / gang (ESX: job2, QB: gang)
moneybooleantrueShow cash (ESX: money, QB: cash)
bankbooleantrueShow bank balance
black_moneybooleantrueShow dirty money (ESX: black_money, QB: crypto)
positionbooleantrueShow street name
healthbooleantrueShow health bar
armourbooleantrueShow armour bar
hungerbooleantrueShow hunger bar
thirstbooleantrueShow thirst bar
staminabooleantrueShow stamina bar
apneabooleantrueShow apnea bar
speedometerbooleantrueShow speedometer when in vehicle

Display

OptionTypeDefaultDescription
type_needs_displaystring"bar"Status display mode: "bar", "circle", "square", "hexagon", "text"
shape_fill_modestring"stroke"Shape fill style: "stroke" (outline progress) or "fill" (bottom-to-top solid fill)
metricstring"kmh"Speed unit: "kmh" or "mph"

Default Colors

Colors are defined as RGBA arrays {R, G, B, A} with values from 0 to 255.

Config.colorText    = {255, 255, 255, 255}  -- White
Config.healthColor  = {53, 154, 71, 255}    -- Green
Config.armourColor  = {51, 131, 236, 255}   -- Blue
Config.hungerColor  = {245, 166, 35, 255}   -- Orange
Config.thirstColor  = {0, 168, 255, 255}    -- Cyan
Config.staminaColor = {245, 220, 63, 255}   -- Yellow
Config.apneaColor   = {123, 153, 229, 255}  -- Light blue
Config.fuelColor    = {255, 0, 0, 255}      -- Red

All colors can be changed via the admin panel color pickers.

Notifications

These serve as defaults. They can be overridden via the admin panel.

OptionTypeDefaultDescription
notifPositionstring"top-center"Notification position on screen
notifWidthnumber25Width in vw units (viewport width)
notifScalenumber1.0Scale multiplier (0.5 to 2.0)

Available positions: "top-left", "top-center", "top-right", "bottom-left", "bottom-center", "bottom-right"

When set to bottom-left, notifications automatically position above the GTA minimap and match its width (15vw).

Admin Menu

OptionTypeDefaultDescription
adminCommandstring"hudadmin"Chat command to open the admin panel
adminGroupstable{"admin", "superadmin", "god"}Framework groups allowed to access the panel

For standalone, you can define a custom admin check:

Config.customAdminCheck = function(src)
    return IsPlayerAceAllowed(src, "admin")
end

Admin permission is checked in this order:

  1. Framework group check (ESX group, QBCore permission)
  2. ACE permission fallback (command.<adminCommand>)