> For the complete documentation index, see [llms.txt](https://nanoscripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nanoscripts.gitbook.io/docs/scripts/nn_hud_ultimate.md).

# nn\_hud\_ultimate

A HUD every player can restyle, move and resize in game — and you decide what they may change.

**nnHUD Ultimate Edition** is not one fixed layout. Every widget has a gallery of looks, every look can be recoloured, moved and resized from an in-game studio, and the result is saved per player. You set the server's look and the rules; your players make it theirs.

{% hint style="info" %}
**At a glance** — Resource: `nn_hud_ultimate` · Author: NANO Scripts · Version: 1.0.4 · Frameworks: QBox, QBCore, ESX (via `community_bridge`) · Studio: **F7** or `/hudmenu` · Admin: `/hudconfig` · Languages: 9 · Database: creates its own tables, nothing to import.
{% endhint %}

#### Features

<table><thead><tr><th width="212">Feature</th><th>What it does</th></tr></thead><tbody><tr><td><strong>Setup wizard</strong></td><td>You walk a short owner setup once and it becomes the server's look. Each player then gets a one-time welcome setup: language, a base look, optional fine-tuning.</td></tr><tr><td><strong>HUD Studio</strong></td><td><strong>F7</strong> opens a page per widget: pick a look, recolour it, resize it, and see it live on the real screen before you keep it.</td></tr><tr><td><strong>Widget galleries</strong></td><td>21 speedometers, 17 status-bar looks, 14 info bars, 12 radar shapes, 11 compasses, 9 voice indicators, 5 ammo counters, 7 aircraft instrument styles, 4 marine helms.</td></tr><tr><td><strong>Placement editor</strong></td><td>One stage with every widget on it. Drag, resize, rotate, reset — or scale the whole HUD at once.</td></tr><tr><td><strong>Brand colour</strong></td><td>Paste one hex and the HUD derives a full palette across every widget, checking text contrast as it goes.</td></tr><tr><td><strong>Vehicle dock</strong></td><td>Hold <strong>Left Alt</strong> in a vehicle and a deck covers the radar: doors and lights on a painted car, seat swap, limiter and gearbox, nearest places, the radio.</td></tr><tr><td><strong>Radar &#x26; minimap</strong></td><td>Twelve mask shapes, a themed rim, 3D tilt, a waypoint pocket, speed zoom, north lock and hide-indoors — placed on the real screen.</td></tr><tr><td><strong>Presets</strong></td><td>Twelve slots of your own, your server's shelf, and the community feed. One click applies a whole look; a Look Code hands it to a friend.</td></tr><tr><td><strong>Vehicle systems</strong></td><td>Seatbelt with windscreen ejection, cruise control, speed limiter, gearbox mode, turn signals, speed-limit signs, nearest places.</td></tr><tr><td><strong>Aircraft &#x26; marine</strong></td><td>Helicopter and plane instruments with hover hold, landing gear and autopilot; a boat helm with knots, depth and sea state.</td></tr><tr><td><strong>Stress</strong></td><td>Shooting, speeding, crashes, falls and low health raise it; time and relief items calm it. Screen shake, tint and an optional blackout.</td></tr><tr><td><strong>Admin page</strong></td><td><code>/hudconfig</code> decides who runs setup, who opens the studio, who publishes, and which widgets each role gets. Saved in game, applies at once.</td></tr><tr><td><strong>Nine languages</strong></td><td>Every surface, not just notifications: wizards, studio, presets, key names and widget labels.</td></tr></tbody></table>

#### What you will need

<table><thead><tr><th width="252">Dependency</th><th width="160">Required</th><th>Why</th></tr></thead><tbody><tr><td><strong>nn_lib</strong></td><td>Yes</td><td>Licence check. Must start <strong>before</strong> the HUD.</td></tr><tr><td><strong>community_bridge</strong></td><td>Yes</td><td>Framework, inventory, notifications, fuel and banking.</td></tr><tr><td><strong>oxmysql</strong></td><td>Yes</td><td>Saves every player's look, presets and the server look.</td></tr><tr><td><strong>ox_lib</strong></td><td>Yes</td><td>Caches and shared helpers.</td></tr><tr><td>A framework</td><td>Yes</td><td>QBox, QBCore or ESX, through the bridge.</td></tr><tr><td>A voice resource</td><td>For the voice indicator</td><td><code>pma-voice</code>, <code>SaltyChat</code> or <code>mumble-voip</code>.</td></tr></tbody></table>

{% hint style="warning" %}
**Stop your current HUD first.** Two HUDs draw over each other and fight over the minimap. Remove the `ensure` line of your current HUD, any resource that moves the minimap or streams its own `minimap.gfx` / `minimap.ytd`, and `qbx_seatbelt` if you run it — the HUD ships its own seatbelt.
{% endhint %}

#### Compatibility

<table><thead><tr><th width="186">Area</th><th>Supported</th></tr></thead><tbody><tr><td>Framework</td><td>QBox · QBCore · ESX</td></tr><tr><td>Voice</td><td>pma-voice · SaltyChat · mumble-voip</td></tr><tr><td>Fuel</td><td>Any fuel script. The vehicle <code>fuel</code> statebag updates instantly; anything else is read every two seconds.</td></tr><tr><td>Vehicle keys</td><td><code>qbx_vehiclekeys</code> · <code>qb-vehiclekeys</code> · <code>wasabi_carlock</code>, else the dock locks the car directly.</td></tr><tr><td>Languages</td><td>English · Français · Deutsch · Español · Português (BR) · Polski · Русский · العربية · 简体中文</td></tr></tbody></table>

#### Common questions

<details>

<summary>Do I need to import SQL?</summary>

No. On first start the HUD creates `nn_hud_players` and `nn_hud_server` itself.

</details>

<details>

<summary>Do players all get the same HUD?</summary>

They all **start** from the same look — the one you build in the owner setup. From there each player changes their own, and their changes are saved. You can lock individual settings, or switch a widget off for everyone.

</details>

<details>

<summary>Can I stop players changing anything?</summary>

Yes. In `/hudconfig` set **Who can open this menu** to admins or the owner. Players then keep the server's look and cannot open **F7**.

</details>

<details>

<summary>Does the HUD replace my minimap resource?</summary>

Yes. It draws the radar itself, including the mask shape. Remove anything else that moves the minimap or streams its own minimap files.

</details>

<details>

<summary>Is anything sent outside my server?</summary>

Only the community preset feed, over HTTPS, and only while `Config.Community.Enabled` is on. Nothing else leaves the server, and the feed can be switched off.

</details>

<details>

<summary>Do config changes need a restart?</summary>

Yes — every value in `shared/config.lua` is read when the resource starts. Anything saved in `/hudconfig` or the studio applies at once instead.

</details>

#### What's next

**Installation** → **The setup wizard** → **The HUD Studio**.

#### Support

* **Discord:** <https://discord.gg/nanoscripts>