Reference
FAQ
Common questions about frameworks, real aircraft, performance, customization, escrow, languages and controls.
Which frameworks are supported?
It auto-detects ESX, QBCore and Qbox, or runs fully standalone. Set Config.Framework to 'auto' (default) to detect, or force 'esx', 'qbcore', 'qbox' or 'standalone'. A framework is only needed if you want status data like hunger, thirst or stress; without one, those rings stay full and cosmetic. See the Frameworks page for details.
Are planes and helis really supported, or just a generic gauge?
They are dedicated instrument clusters. The HUD auto-adapts per vehicle class. Planes show airspeed in knots, a real artificial horizon (pitch/roll), altitude (MSL + AGL), vertical speed and a landing-gear telltale. Helis show airspeed, artificial horizon, altitude and vertical speed. Boats show speed in knots plus a depth readout; trucks show a trailer indicator; bikes use a minimal speed + odometer mode.
How much does it cost in performance?
About ~0.00 ms on foot or parked and ~0.03 ms while driving (measured in resmon). This comes from a single dynamic-wait thread, a per-field dirty-check, a reused message buffer and movement-/time-gated heavy natives. See the Performance page for how to measure it.
Can I customize it?
Yes. Everything lives in config.lua: colors, global Scale, Opacity, cluster Position ('br' or 'bl'), per-module toggles in Config.Modules (status, mic, speedo, gear, fuel, engine, odometer, compass, gps, controls), units ('kmh' or 'mph'), the corner Brand watermark, seatbelt and compass options, and a colorblind-friendly palette via Config.ColorblindMode. The accent color (Config.Colors.accent) drives the whole amber theme. The Configuration (config.lua) page documents every option, and many can also be changed live from the In-game settings menu (/hud).
Is it escrow-protected? Can I still edit it?
The Lua logic and NUI are encrypted under keymaster escrow, but config.lua, the locale files (locales/*.lua), the README and the CHANGELOG are left open via escrow_ignore. That means you can fully configure the HUD and edit or add languages without touching protected code.
What languages are included?
Five out of the box: English, Espanol, Francais, Deutsch and Portugues. Pick one with Config.Locale, and add more by copying a locale file, translating it and registering it in fxmanifest.lua. See the Languages page.
What are the default controls?
Toggle HUD is F7 (command pshud_togglehud), seatbelt is B (pshud_seatbelt) and cruise control is Caps Lock (pshud_cruise). All keys are rebindable in FiveM under Settings > Key Bindings > PSTUDIOS-HUD. See the Default controls & key bindings page.