# HUD System

`HUD System` is a FiveM interface resource that provides a fully customizable on-screen HUD with status bars, vehicle information, watermark, minimap frame, crosshair, notifications, server alerts, help notifications, and voice activity indicators.

It is designed to give players a modern and immersive interface while still allowing full control over appearance, layout, variants, colors, and visibility. Every major HUD element can be adjusted in-game through a dedicated settings panel.

With support for preset saving, preset sharing, layout editing, minimap placement, and multiple visual variants, the system is flexible, modern, and suitable for advanced roleplay servers.

### Features

* Fully customizable HUD
* Status bars
* Vehicle speedometer
* Watermark with player and server data
* Minimap frame and waypoint distance
* Custom crosshair
* Notifications and server alerts
* Help notifications
* Voice range and talking indicator
* Layout editor
* Preset save, import, and share system
* Multiple visual variants for each HUD section

### How it works

Once the player is loaded, the HUD starts automatically and displays the configured elements such as status, watermark, minimap, and location.

When the player enters a vehicle, the vehicle HUD becomes visible and displays data such as speed, RPM, fuel, engine health, temperature, and gear information.

Players can open the HUD settings panel using `/hud`, where they can customize variants, colors, icons, thresholds, positions, minimap placement, and other display options.

### Included Pages

* Installation
* Configuration

### Requirements

Before using this resource, make sure all required dependencies are installed and started correctly.

### Notes

* HUD settings are saved locally per player
* Presets can be shared through the database
* Every major HUD section can be customized
* The HUD supports both gameplay and vehicle-specific displays
* Notifications, help text, and voice indicators are included


---

# Agent Instructions: 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://mskscripts.gitbook.io/mskscripts/scripts/hud-system.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.
