> 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/installation.md).

# Installation

Getting dm-hud running on your server, with default keys and commands.

{% stepper %}
{% step %}

## Install the dependency

[ox\_lib](https://github.com/overextended/ox_lib) is the only requirement. Make sure it starts before the HUD.
{% endstep %}

{% step %}

## Drop the resource in

Put the `dm-hud` folder in your resources directory, then add it to `server.cfg` **after** ox\_lib and after your framework.

{% tabs %}
{% tab title="Qbox" %}

```cfg
ensure ox_lib
ensure qbx_core
ensure dm-hud
```

{% endtab %}

{% tab title="QBCore" %}

```cfg
ensure ox_lib
ensure qb-core
ensure dm-hud
```

{% endtab %}

{% tab title="ESX" %}

```cfg
ensure ox_lib
ensure es_extended
ensure dm-hud
```

{% endtab %}

{% tab title="Standalone" %}

```cfg
ensure ox_lib
ensure dm-hud
```

No framework is required. Health, armour, speed, fuel and the vehicle panel all work from the game itself — only job, gang, cash, bank, hunger and thirst go quiet.
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

## Turn off your old HUD

{% hint style="warning" %}
Running two HUDs at once gives you two minimaps and two sets of status bars. This is the most common installation problem.
{% endhint %}

```cfg
# ensure qbx_hud
# ensure qb-hud
```

{% endstep %}

{% step %}

## Set your units and language

Open `shared/config.lua`:

```lua
DashCfg.locale = 'en'
DashCfg.currency = '$'

DashCfg.units = {
    speed = 'mph',
    distance = 'ft',
}
```

Language files live in `locale/`. **30 languages ship with the resource**, the same set ox\_inventory supports, so your players see one language across both:

`ar` العربية · `cs` Čeština · `da` Dansk · `de` Deutsch · `el` Ελληνικά · `en` English · `es` Español · `et` Eesti · `fi` Suomi · `fr` Français · `hr` Hrvatski · `hu` Magyar · `id` Bahasa Indonesia · `it` Italiano · `ja` 日本語 · `ko` 한국어 · `lt` Lietuvių · `nl` Nederlands · `no` Norsk · `pl` Polski · `pt` Português · `pt-br` Português (Brasil) · `ro` Română · `ru` Русский · `sl` Slovenščina · `sr` Srpski · `sv` Svenska · `tr` Türkçe · `zh-cn` 简体中文 · `zh-tw` 繁體中文

Missing keys fall back to English automatically, so a partial translation can never leave the interface blank. Copy any file to add your own.

{% hint style="info" %}
Fonts for Latin, Latin Extended, Cyrillic, Greek and Arabic are bundled, so Polish, Czech, Turkish, Russian, Greek and Arabic all render correctly out of the box. Japanese, Korean and Chinese use the fonts already installed on Windows.
{% endhint %}
{% endstep %}

{% step %}

## Add your logo

Replace `media/logo.png` with your own, or point the config at a different file:

```lua
DashCfg.logo = 'logo.png'
```

Animated `.gif` and `.webp` both work.

{% hint style="warning" %}
Keep it small. An animated logo repaints constantly, and that costs frames for every player on your server.
{% endhint %}
{% endstep %}

{% step %}

## Restart and check the console

```
[dm-hud] v1.0.0 ready — framework: qbx
```

{% hint style="success" %}
If you see that line with your framework named, the install worked.
{% endhint %}

If the framework says `none` when you are running one, see [Troubleshooting](/devmosaic/resources/devmosaic-dm-hud/troubleshooting.md).
{% endstep %}
{% endstepper %}

## Default keys

Players can rebind all of these in **GTA Settings → Key Bindings → FiveM**.

| Key     | Does                           |
| ------- | ------------------------------ |
| `F7`    | Open the settings panel        |
| `F6`    | Open the vehicle control panel |
| `B`     | Toggle seatbelt                |
| `J`     | Toggle cruise control          |
| `←` `→` | Indicators                     |
| `↑`     | Hazards                        |

Change the defaults in `DashCfg.keys`. Set one to `false` to leave it unbound — useful when another script already owns that key.

```lua
DashCfg.keys = {
    panel = 'F7',
    rig = 'F6',
    belt = 'B',
    cruise = false,   -- another script handles cruise control
    signalLeft = 'LEFT',
    signalRight = 'RIGHT',
    hazards = 'UP',
}
```

## Commands

| Command       | Does                           |
| ------------- | ------------------------------ |
| `/dashhud`    | Show or hide the whole HUD     |
| `/dashlayout` | Open the layout editor         |
| `/dashrig`    | Open the vehicle control panel |
| `/dashbelt`   | Toggle seatbelt                |
| `/dashcruise` | Toggle cruise control          |
| `/dashtoggle` | Toggle HUD visibility          |