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

# Configuration

Everything is in `config.lua`. Every line has a short comment.

## General

| Setting                                   | Default                  | What it does                                          |
| ----------------------------------------- | ------------------------ | ----------------------------------------------------- |
| `Config.Locale`                           | `'en'`                   | Language file from `locales/`                         |
| `Config.Debug`                            | `false`                  | Extra console logs and the test commands              |
| `Config.Framework`                        | `'auto'`                 | `auto`, `qbx`, `qb`, `esx` or `none`                  |
| `Config.MenuCommand`                      | `'hud'`                  | Opens the settings menu                               |
| `Config.EditCommand` / `Config.EditKey`   | `'hudedit'` / `'INSERT'` | Edit mode command and default key                     |
| `Config.SettingsMenu` / `Config.EditMode` | `true`                   | Let players open the menu and edit mode               |
| `Config.Cinematic`                        | `true`                   | Players can turn on cinematic bars                    |
| `Config.Accent`                           | `'#AD3F42'`              | Default accent color, players can change it           |
| `Config.HideInPauseMenu`                  | `true`                   | Hide the HUD while the pause menu is open             |
| `Config.DefaultStyle`                     | `1`                      | `1` body map or `3` ECG monitor for new players       |
| `Config.DefaultPerformance`               | `'balanced'`             | `smooth`, `balanced` or `performance` for new players |

## Modules

`Config.Modules` decides which modules exist on your server. `false` removes a module for everyone. Players can hide the remaining modules themselves in the settings menu.

| Module                        | Default | Shows                                                           |
| ----------------------------- | ------- | --------------------------------------------------------------- |
| `statusCluster`               | `true`  | Status row in the bottom-left corner                            |
| `body`                        | `true`  | Body map with zone damage                                       |
| `healthMonitor`               | `true`  | ECG monitor (style 3)                                           |
| `injuries`                    | `true`  | Injury icons                                                    |
| `noiseIndicator`              | `true`  | How far the player's noise carries                              |
| `voice`                       | `true`  | Voice range, talking and radio in the status row                |
| `vehicle`                     | `true`  | Speed, gear, fuel, engine and seatbelt                          |
| `oxygen`                      | `true`  | Breath in the status row while under water                      |
| `minimap`                     | `true`  | Round minimap                                                   |
| `compass`                     | `true`  | Compass strip                                                   |
| `health`, `armor`             | `true`  | Health and armor in the status row (armor hides at 0)           |
| `hunger`, `thirst`, `stamina` | `true`  | Hunger, thirst and stamina in the status row                    |
| `radiation`                   | `false` | Radiation in the status row, the value comes from other scripts |
| `logo`                        | `false` | Your server logo from `web/logo.png`                            |

### Status row designs

Players pick the look of the status row in **/hud > Styles > Status Row Design**:

* **Urban**: coloured icons that fill up
* **Outline**: white line icons that fill up, red when critical
* **Diamond**: worn diamond badges

Every design shows the value under each icon (**/hud > General > Show Values**). In **/hud > Modules** each item can be turned off or set to **Only When Low**, for example hunger only shows below 50%.

![Status row designs](https://2487709298-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqcEXX242M9YYHjASblGi%2Fuploads%2Fgit-blob-b2b99bc27414f7ba2e5b8ac0a64c7d9f6ef6f3ca%2Fdaddy-hud-designs.jpg?alt=media)

## Vehicle

| Setting                           | Default              | What it does                                                                   |
| --------------------------------- | -------------------- | ------------------------------------------------------------------------------ |
| `SpeedUnit`                       | `'kmh'`              | `kmh` or `mph`                                                                 |
| `Fuel`                            | `'auto'`             | `auto`, `native`, `ox_fuel`, `LegacyFuel`, `cdn-fuel`, `ps-fuel`, `lc_fuel`    |
| `Seatbelt`                        | `'auto'`             | `auto` detects a seatbelt script, `builtin` uses the HUD's own, `off` hides it |
| `SeatbeltKey` / `SeatbeltCommand` | `'B'` / `'seatbelt'` | Built-in seatbelt key and command                                              |

The built-in seatbelt keeps the player in the seat in crashes and blocks leaving the vehicle until it is unbuckled.

## Oxygen

| Setting                          | Default      | What it does                                              |
| -------------------------------- | ------------ | --------------------------------------------------------- |
| `MaxTime`                        | `0`          | Seconds of breath under water, `0` keeps the game default |
| `Drowning.Enabled`               | `false`      | Extra damage after the breath runs out                    |
| `Drowning.IntervalMs` / `Damage` | `1000` / `5` | Damage tick and amount                                    |

## Minimap and compass

`Config.Minimap.mode` is `always`, `vehicle` or `off`. With `off` the HUD does not touch the radar, so another script can manage it. `Config.Compass.mode` is the default for new players (`always`, `onFoot`, `vehicle`, `off`); players can change it in the settings menu.

## Languages

Copy `locales/en.json` to `locales/xx.json`, translate the values and set `Config.Locale = 'xx'`. Missing keys fall back to English. The key `brand` is the small title above the settings menu.

![Settings menu](https://2487709298-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqcEXX242M9YYHjASblGi%2Fuploads%2Fgit-blob-e3f6c86e7103f5ab83588a2716bd6a2ea1cc219a%2Fdaddy-hud-settings.jpg?alt=media)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://daddy-studios.gitbook.io/daddy-studios-docs/scripts/daddy-hud/configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.