Configuration (config.lua)

Everything adjustable in PSTUDIOS-HUD lives in a single file: config.lua. These values are sent to the NUI on start and translated into CSS variables, so changing them is reflected directly on screen. This page documents every option exactly as it ships, including its type, accepted values and real default.

General

Config.Framework

Framework integration. 'auto' detects es_extended / qb-core / qbx_core automatically, or force a specific one. Accepted values: 'auto' | 'esx' | 'qbcore' | 'qbox' | 'standalone'. Default: 'auto' (string). See the Frameworks page for how detection works.

Config.Units

Ground speed unit. Boats always use knots and aircraft always use airspeed, regardless of this setting. Accepted values: 'kmh' | 'mph'. Default: 'kmh' (string).

Config.Locale

HUD language (NUI texts + key descriptions). Available out of the box: 'es' | 'en' | 'fr' | 'de' | 'pt'. Add more in locales/ — see the Languages page. Default: 'es' (string).

Config.Brand

Optional corner branding text. Set to '' (empty string) to hide it. Default: 'PONEGLYPH' (string).

Config.Framework = 'auto'   -- 'auto' | 'esx' | 'qbcore' | 'qbox' | 'standalone'
Config.Units = 'kmh'        -- 'kmh' | 'mph'
Config.Locale = 'es'        -- 'es' | 'en' | 'fr' | 'de' | 'pt'
Config.Brand = 'PONEGLYPH'  -- '' to hide

Layout and appearance

Config.Scale

Global HUD scale, where 1.0 = 100%. Number. Default: 1.0.

Config.Opacity

Global HUD opacity. Number from 0.0 to 1.0. Default: 1.0.

Config.Position

Corner of the vehicle cluster. Accepted values: 'br' (bottom-right) | 'bl' (bottom-left). Default: 'br' (string).

Config.StatsPos

Custom position of the status rings, set by the /hud menu when you drag them. nil = anchored bottom-left. Format is a table { x = %, y = % }. Default: nil. See the Movable status rings page.

Config.Scale    = 1.0       -- escala global (1.0 = 100%)
Config.Opacity  = 1.0       -- 0.0 - 1.0
Config.Position = 'br'      -- esquina del cluster: 'br' | 'bl'

-- nil = anclados abajo-izquierda. Formato { x = %, y = % }.
Config.StatsPos = nil

Keybind and performance

Config.Keybind

Key to show/hide the entire HUD. Default: 'F7' (string). See Default controls & key bindings for all keys and how to rebind them.

Config.HudRefresh

HUD refresh while in a vehicle, in milliseconds. On foot the thread sleeps much longer. 75 ms (~13 fps) keeps resmon at ~0.03 ms in vehicle and ~0.00 ms on foot; the speedometer is digital + segmented arc, so 75 ms still looks fluid. Number. Default: 75. See the Performance page for the full breakdown.

Config.Keybind = 'F7'

-- Refresco del HUD en vehículo (ms). A pie el hilo duerme mucho más.
Config.HudRefresh = 75

Speedometer

Config.Speedo configures the analog speedometer ranges. All values are numbers.

• maxKmh — full-scale value in km/h. Default: 240.
• maxMph — full-scale value in mph. Default: 160.
• maxKnots — full-scale value in knots (boats). Default: 90.
• redlineRpm — % of RPM above which the ring turns red. Default: 85.

Config.Speedo = {
    maxKmh = 240,
    maxMph = 160,
    maxKnots = 90,
    redlineRpm = 85,        -- % de RPM a partir del cual el aro se pone rojo
}

Modules

Config.Modules toggles each HUD module on or off (true/false). These are respected per vehicle profile. Note the two defaults shipped as false: rpm and temp, because the Modern Pro cluster does not draw an RPM needle or temperature gauge, which saves one native per tick each.

• status — life/armor/hunger/thirst/oxygen rings. Default: true.
• mic — voice indicator. Default: true.
• speedo — speedometer. Default: true.
• rpm — RPM needle. Default: false (Modern Pro cluster does not draw it).
• gear — current gear. Default: true.
• fuel — fuel level. Default: true.
• temp — temperature. Default: false (Modern Pro cluster does not draw it).
• engine — engine health. Default: true.
• odometer — odometer. Default: true.
• compass — compass. Default: true.
• gps — GPS. Default: true.
• controls — indicators, seatbelt, lights, cruise control… Default: true.

Config.Modules = {
    status   = true,   -- anillos de vida/armadura/hambre/sed/oxígeno
    mic      = true,   -- indicador de voz
    speedo   = true,
    rpm      = false,  -- el cluster Modern Pro no dibuja aguja de RPM
    gear     = true,
    fuel     = true,
    temp     = false,  -- el cluster Modern Pro no dibuja temperatura
    engine   = true,
    odometer = true,
    compass  = true,
    gps      = true,
    controls = true,   -- intermitentes, cinturón, luces, crucero…
}

Player status extras

Config.Status

Extra player status flags. stress shows a stress ring and requires a framework that provides it. Default: stress = false (boolean).

Config.Status = {
    stress = false,    -- requiere framework que lo aporte
}

Seatbelt

Config.Seatbelt configures the seatbelt system.

• enabled — turns the seatbelt feature on/off (boolean). Default: true.
• key — key to fasten/unfasten the seatbelt (string). Default: 'B'.
• ejectOnCrash — eject the player through the windshield on a crash (boolean). Default: false.
• crashSpeedKmh — speed threshold (km/h) that counts as a crash (number). Default: 110.0.

Config.Seatbelt = {
    enabled      = true,
    key          = 'B',
    ejectOnCrash = false,
    crashSpeedKmh= 110.0,
}

Compass / world

Config.Compass controls the compass and world-info bar.

• enabled — turns the compass on/off (boolean). Default: true.
• showStreet — show the current street name (boolean). Default: true.
• showZone — show the current zone (boolean). Default: true.
• showTime — show the in-game time (boolean). Default: true.
• tick — update interval in ms (with dirty-check, almost free) (number). Default: 150.

Config.Compass = {
    enabled    = true,
    showStreet = true,
    showZone   = true,
    showTime   = true,
    tick       = 150,  -- ms (con dirty-check, casi gratis)
}

Minimap / radar

Config.Minimap controls the visibility of GTA's minimap/radar.

• showOnFoot — show the map on foot (boolean). Default: true.
• showInVehicle — show the map while driving (boolean). Default: true.

Config.Minimap = {
    showOnFoot    = true,   -- ver el mapa a pie
    showInVehicle = true,   -- ver el mapa conduciendo
}

Colorblind mode

Config.ColorblindMode

Enables the alternative palette (Config.ColorsCB) instead of the default Config.Colors. Boolean. Default: false. When set to true, the HUD uses the deuteranopia/protanopia-friendly colors.

Config.ColorblindMode = false

Colors

Config.Colors is dumped to CSS :root variables and is hot-swappable. Each value is a hex color string. These are the defaults that ship.

• health — '#f43f5e'
• armor — '#2dd4bf'
• hunger — '#eab308'
• thirst — '#3b82f6'
• oxygen — '#06b6d4'
• stress — '#a855f7'
• stamina — '#f59e0b'
• accent — '#e0a94a' (Poneglyph brand gold)

Config.Colors = {
    health  = '#f43f5e',
    armor   = '#2dd4bf',
    hunger  = '#eab308',
    thirst  = '#3b82f6',
    oxygen  = '#06b6d4',
    stress  = '#a855f7',
    stamina = '#f59e0b',
    accent  = '#e0a94a',  -- dorado de marca Poneglyph
}

Colorblind palette

Config.ColorsCB is the alternative palette used when Config.ColorblindMode = true (deuteranopia/protanopia friendly). Each value is a hex color string.

• health — '#ff7f0e'
• armor — '#1f77b4'
• hunger — '#f0e442'
• thirst — '#56b4e9'
• oxygen — '#009e9e'
• stress — '#cc79a7'
• stamina — '#e69f00'
• accent — '#e69f00'

Config.ColorsCB = {
    health  = '#ff7f0e',
    armor   = '#1f77b4',
    hunger  = '#f0e442',
    thirst  = '#56b4e9',
    oxygen  = '#009e9e',
    stress  = '#cc79a7',
    stamina = '#e69f00',
    accent  = '#e69f00',
}