In-game settings menu (/hud)

PSTUDIOS-HUD ships with an in-game settings panel. Type /hud in the chat to open it; type /hud again (or click Close) to dismiss it. While the panel is open it takes mouse and keyboard focus.

How to open it

The menu is bound to the /hud command. A key mapping is also registered so players can assign their own key in FiveM > Settings > Key Bindings, under the entry "PSTUDIOS-HUD: open settings". By default no key is assigned to this menu; the player must set one. See Default controls & key bindings for the full list of keys.

RegisterCommand('hud', function()
    if menuOpen then closeMenu() else openMenu() end
end, false)
-- Tecla opcional (sin asignar por defecto; el jugador la asigna en Ajustes).
RegisterKeyMapping('hud', _U('key_menu'), 'keyboard', '')

What you can change

Visibility

• Compass — show or hide the compass.
• GPS / Route — show or hide the GPS/route module.
• Status — show or hide the status rings (health/armor/hunger/thirst/oxygen).
• Minimap on foot — show or hide the game minimap while on foot.
• Minimap in vehicle — show or hide the game minimap while driving.

Layout

• Position — vehicle cluster corner: Left (bl) or Right (br).
• Scale — global HUD scale.
• Opacity — global HUD opacity.
• Colorblind — switch to the alternate colorblind palette.
• Move status — drag the status rings to a custom position (see the Movable status rings page).

Saved per player

Every change is applied live and written to the player's resource KVP store under the key pshud:settings, so it survives reconnects and resource restarts. On resource load, loadSettings() runs before the HUD config is sent to the NUI, so the HUD starts with the saved preferences already applied.

local KVP = 'pshud:settings'

local function saveSettings()
    SetResourceKvp(KVP, json.encode(currentSettings()))
end

RegisterNUICallback('hud:set', function(data, cb)
    if data and data.key ~= nil then
        applySetting(data.key, data.value)
        saveSettings()
    end
    cb('ok')
end)