> For the complete documentation index, see [llms.txt](https://galaxis-studios.gitbook.io/galaxis-studios/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://galaxis-studios.gitbook.io/galaxis-studios/getting-started/hud-v2.md).

# HUD v2

GLXS HUD v2 is a premium FiveM HUD. Every player can pick styles, colors and positions in game, and server owners control the defaults and limits from a single JSON file.

## Features

* **Status indicators:** health, armor, hunger, thirst, stamina, oxygen, stress and voice, in 8 status bar styles
* **Minimap:** 8 frame styles (round and square), each with its own integrated health/armor layout
* **Vehicle HUD:** 3 speedometers plus dedicated aircraft, boat and bicycle variants; speed, RPM, gear, fuel, engine, body health, lights, seatbelt/harness and nitro
* **Compass:** 3 styles, camera- or player-oriented, always visible or only in vehicles
* **Info widget:** 3 styles; logo, player ID, player count, job, gang, duty badge, cash, bank, black money, active weapon (with image), date and time
* **In-game settings panel** (`/hud`) with a live preview of every style
* **Edit mode** (`/hudedit`): drag, scale and hide every element, with separate walking and vehicle layouts
* **Seatbelt:** follows qbx\_seatbelt and other seatbelt scripts automatically, or uses a built-in belt when none is installed
* **Stress:** optional, stored in framework metadata, with configurable gain triggers and screen effects
* **Alerts:** seatbelt warning and low-fuel sounds, hunger/thirst low warnings
* **Performance profiles:** ultra-optimize, default and ultra-fast
* **7 languages:** English, Turkish, French, German, Spanish, Portuguese (Brazil), Dutch
* **No database required.** Player layouts are stored client-side.

## Supported frameworks

| Framework | `Config.Framework`   |
| --------- | -------------------- |
| Qbox      | `qbox`               |
| QBCore    | `qb-core` / `old-qb` |
| ESX       | `esx` / `old-esx`    |
| ND Core   | `nd_core`            |
| vRP       | `vrp`                |

The framework is detected automatically when `Config.Framework = 'auto'`.

## Editions

|                                                            | Escrow edition | Open-source edition |
| ---------------------------------------------------------- | -------------- | ------------------- |
| Runs out of the box                                        | ✅              | ✅                   |
| `config.lua`, `stress-config.lua`, `config.json`, locales  | Editable       | Editable            |
| `client/editable-client.lua`, `server/editable-server.lua` | Editable       | Editable            |
| Core Lua (client, server, shared)                          | Encrypted      | Editable            |
| Vue source of the UI (`resources/`)                        | Not included   | Included            |

Both editions have the same features. The open-source edition is for developers who want to change the core logic or the UI itself. See [Building the UI](broken://pages/0a0987c72086c8e6c99ed76857565aa5c5493320).

## Next steps

* [Installation](broken://pages/e29dff864025dfbf07f5874822899770e7c3c4c3)
* [Commands & Keybinds](broken://pages/3cdbbae2e071cca35c0169c4264a50b05b36e5cc)
* [config.lua](broken://pages/0cd75d1b0c24edd0b4f5a547b10a54dc9d06ac96)
