# Rush Hud

A modern and customizable HUD system for FiveM servers with support for both QBCore and ESX frameworks.

## Features

* Modern and responsive UI design
* Vehicle HUD with speed, fuel, gear and RPM indicators
* Voice chat indicators
* Health, armor, hunger and thirst display
* Temperature integration with hate-temp
* Safe zone indicator
* Configurable radar display
* Support for both QBCore and ESX frameworks

## Dependencies

* Required Framework:
  * QBCore or ESX
* Optional Integrations:
  * hate-temp (for temperature display)
  * hate-needs (for additional needs display)

## Installation

1. Download the resource
2. Add to your resources folder
3. Add to server.cfg:

```
ensure hate-rhud
```

4. Configure `config.lua` to your needs

## Configuration

The main configuration file `config.lua` allows you to customize various aspects of the HUD:

### Framework Selection

```lua
Config.Framework = 'qb' -- 'qb' for QBCore | 'esx' for ESX
```

### Radar Settings

```lua
Config.RadarStatus = 3  -- 1: Always show radar | 2: Only in car | 3: Never show radar
Config.HandleRadar = false -- Enable/disable radar handling
```

### Display Settings

```lua
Config.ShowGunandStamina = true -- Toggle left part of HUD (ammo, stamina)
Config.SpeedUnit = 'kmh' -- 'kmh' or 'mph' for vehicle speed display
```

### Integration Settings

```lua
Config.UsingHateNeeds = false -- Enable hate-needs integration
Config.UsingHateTemp = true -- Enable hate-temp integration
```

### Safe Zone Configuration

```lua
Config.InSafeZone = function(ped)
    -- Add your safe zone logic here
    return false
end
```

## Exports

The resource provides the following client-side exports:

```lua
-- Toggle HUD visibility
exports['hate-rhud']:setHudVisible(state)
```

## Support

For support, join our Discord server or create an issue on GitHub.

## Security Notice

This script is protected by FiveM's escrow system. The client and server-side code is encrypted and cannot be modified.


---

# 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://hate-development.gitbook.io/hate-development-docs/rush-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.