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

# Overview

**Modern escrowed HUD system for FiveM**

zloma\_hud is a free HUD resource with a polished NUI interface, responsive scaling, vehicle systems, stress, mileage, minimap styling, voice/radio indicators, and in-game layout customization.

The resource supports ESX, QBCore, Qbox, and standalone setups through auto-detection and open configuration files.

***

## Highlights

| Feature               | Description                                                                                         |
| --------------------- | --------------------------------------------------------------------------------------------------- |
| **Responsive HUD UI** | Automatically scales between 720p, 1080p, 1440p, and resolutions between them                       |
| **Player Status**     | Health, armor, hunger, thirst, stress, voice activity, and server/player info                       |
| **Vehicle HUD**       | Speed, RPM, fuel, gear, engine health, seatbelt, headlights, cruise, and mileage                    |
| **Radio Indicator**   | Shows active radio channel and radio talking state with animation                                   |
| **Weapon HUD**        | Displays current weapon image, name, clip ammo, reserve ammo, and inventory durability              |
| **Minimap Styling**   | Custom radar/minimap assets with configurable visibility and offset                                 |
| **HUD Settings Menu** | Theme, car HUD style, 3D perspective, module visibility, status modes, and drag/scale layout editor |
| **Stress System**     | Speeding and shooting stress gain, screen effects, persistence, admin command, and tablet items     |
| **Mileage Tracking**  | Persistent per-vehicle mileage with automatic SQL setup                                             |
| **Escrow Ready**      | Core implementation is protected while config, customization, and stress files remain open          |

***

## Dependencies

| Resource       | Required | Purpose                                                              |
| -------------- | -------- | -------------------------------------------------------------------- |
| `ox_lib`       | Yes      | Cache helpers, callbacks, notifications, and NUI flow                |
| `oxmysql`      | Yes      | Stress persistence and mileage database storage                      |
| `es_extended`  | Optional | ESX framework data and needs integration                             |
| `qb-core`      | Optional | QBCore framework data and needs integration                          |
| `qbx_core`     | Optional | Qbox framework data and needs integration                            |
| `ox_inventory` | Optional | Stress tablet items and weapon durability metadata                   |
| `qb-inventory` | Optional | Stress tablet items and weapon durability metadata on QBCore servers |
| `pma-voice`    | Optional | Radio channel and radio talking indicator                            |

***

## Escrow Layout

zloma\_hud is a free escrowed resource.

Open files in escrow builds:

* `config/*.lua`
* `client/cl_customization.lua`
* `server/sv_customization.lua`
* `client/stress.lua`
* `server/stress.lua`

Everything else is intended to be protected by escrow.

***

## Quick Links

* [Installation](/zloma-scripts/zloma_hud-free-escrow/installation.md)
* [Configuration](/zloma-scripts/zloma_hud-free-escrow/configuration.md)
* [Customization](/zloma-scripts/zloma_hud-free-escrow/customization.md)
* [Features](/zloma-scripts/zloma_hud-free-escrow/features.md)
* [API Reference](/zloma-scripts/zloma_hud-free-escrow/api-reference.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://zloma-scripts.gitbook.io/zloma-scripts/zloma_hud-free-escrow/zloma_hud.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
