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

# Installation

1. Download the resource from [Cfx Keymaster](https://keymaster.fivem.net/) and put the `daddy-hud` folder in your `resources` directory.
2. Add it to `server.cfg` after your framework and voice script:

   ```cfg
   ensure qbx_core        # or qb-core / es_extended, optional
   ensure pma-voice       # optional
   ensure daddy-hud
   ```
3. Stop any other HUD that draws health, armor, hunger, thirst or a speedometer, or that controls the minimap (for example `qb-hud`, `ps-hud`, `esx_hud`).
4. Start the server and join. Type `/hud` to open the settings menu and `/hudedit` (or press **INSERT**) to move modules.

## What is detected automatically

| Resource                                                                    | Used for                                            |
| --------------------------------------------------------------------------- | --------------------------------------------------- |
| `qbx_core`, `qb-core` or `es_extended`                                      | Login state, hunger, thirst and death state         |
| `esx_status`                                                                | Hunger and thirst on ESX                            |
| `pma-voice`, `saltychat`, `mumble-voip`, `tokovoip_script`                  | Voice range and talking state                       |
| `ox_fuel`, `LegacyFuel`, `cdn-fuel`, `ps-fuel`, `lc_fuel`                   | Fuel level (the native fuel level otherwise)        |
| `qbx_smallresources` or any script sending `seatbelt:client:ToggleSeatbelt` | Seatbelt state                                      |
| `ml_healthsystem`                                                           | Only with `Config.HealthSystem = 'ml_healthsystem'` |

Without a framework the HUD shows as soon as the player spawns, and hunger and thirst stay at 100 unless another script sets them with `SetModuleValue`.

## Server logo

Put your logo at `web/logo.png` (square, transparent PNG works best) and set `Config.Modules.logo = true`.

## Escrow

`config.lua`, `client/bridge.lua` and the `locales/` files are open in the escrow edition. The bridge holds the framework code, so you can connect a custom framework or status script there.


---

# 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/installation.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.