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

# Dm Hud

\`dm-hud\` is a modular heads-up display for FiveM. It supports QBCore, Qbox and ESX-style frameworks through automatic bridges.

Status bars, minimap, compass, speedometer, vehicle controls and a drag-and-drop layout editor. Every element can be turned off, restyled, locked, or handed to a script you already run.

{% hint style="success" %}
**In a hurry?** [Install it](/devmosaic/resources/devmosaic-dm-hud/installation.md), then open `shared/config.lua` and change two lines: `DashCfg.locale` and `DashCfg.units`. That is a working setup.
{% endhint %}

## I want to…

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-download">:download:</i></td><td><strong>Get it running</strong></td><td>Six steps, then check one line in the console.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/installation.md">Installation</a></td></tr><tr><td><i class="fa-gear">:gear:</i></td><td><strong>Change a setting</strong></td><td>Units, language, keys, speed limits, stress. Every option in one place.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/configuration.md">Configuration</a></td></tr><tr><td><i class="fa-user-gear">:user-gear:</i></td><td><strong>Change what players start with</strong></td><td>The defaults a brand new player gets, before they touch the menu.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/defaults.md">What Players Start With</a></td></tr><tr><td><i class="fa-palette">:palette:</i></td><td><strong>Change the colours</strong></td><td>One line recolours the whole HUD. 100 presets, or any hex you like.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/ui-theme.md">Colours And Theme</a></td></tr><tr><td><i class="fa-lock">:lock:</i></td><td><strong>Stop players changing something</strong></td><td>Hide an element, grey out a setting, or force a value.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/policy-and-locks.md">Policy And Locks</a></td></tr><tr><td><i class="fa-sliders">:sliders:</i></td><td><strong>Know what players can change</strong></td><td>The settings menu and the layout editor, as a player sees them.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/player-settings.md">What Players Can Change</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>Call it from my script</strong></td><td>Every export with a worked example, plus framework and fuel bridges.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/exports-and-bridges.md">Exports And Bridges</a></td></tr><tr><td><i class="fa-puzzle-piece">:puzzle-piece:</i></td><td><strong>Add my own status bar</strong></td><td>Your own bars and info chips, from the config or another resource.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/extending.md">Adding Your Own</a></td></tr><tr><td><i class="fa-wrench">:wrench:</i></td><td><strong>Fix something</strong></td><td>The problems people actually hit, and the one-line answers.</td><td><a href="/devmosaic/resources/devmosaic-dm-hud/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>

## Which file do I edit?

Everything you can change is in `shared/`. You will spend almost all your time in the first one.

<table><thead><tr><th width="180">File</th><th>Edit it when you want to…</th></tr></thead><tbody><tr><td><code>config.lua</code></td><td>change anything about how the HUD behaves on your server</td></tr><tr><td><code>defaults.lua</code></td><td>change what a <strong>new player</strong> starts with</td></tr><tr><td><code>policy.lua</code></td><td>stop players changing or seeing something</td></tr><tr><td><code>ui.lua</code></td><td>pick an accent colour by name</td></tr><tr><td><code>tuning.lua</code></td><td>nothing. Internal numbers, leave it alone</td></tr></tbody></table>

## What it needs

* [ox\_lib](https://github.com/overextended/ox_lib) — the only requirement
* QBCore, Qbox, ESX, or no framework at all

## At a glance

|                |                                                  |
| -------------- | ------------------------------------------------ |
| **Languages**  | 30, matching ox\_inventory                       |
| **Frameworks** | qbx\_core · qb-core · es\_extended · standalone  |
| **Fuel**       | 11 scripts detected automatically                |
| **Voice**      | pma-voice · saltychat · tokovoip · mumble-voip   |
| **Vehicles**   | cars · motorcycles · bicycles · boats · aircraft |
| **Exports**    | 37                                               |