# Envi-HUD

***

## Prerequisites

{% hint style="info" %}

* A working FiveM Server
* Basic understanding of FiveM server setup and resource management
* An up-to-date version of [ox\_lib](https://github.com/CommunityOx/ox_lib)
* Followed the [First Steps](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/first-steps-read-first) guide
* Envi-Bridge (added to your CFX Portal automatically when HUD is purchased)
  * <mark style="color:orange;">Requires version 0.3.9 or higher</mark>
* The packaged `web/build/` folder from your download
* Inventory items matching `Config.Items`
  {% endhint %}

***

## [Tebex](https://envi-scripts.tebex.io/package/6632728)

***

## Features

ENVI-HUD is a highly optimized next-gen HUD system for your FiveM Server. The script offers optimal performance while instantly updating real-time info for player status, vehicle stats, and server details etc - all packed into a modern interface with over 150+ customisation options!

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2FhgJ2PhH8IeQrEtmBfuzc%2F2.png?alt=media&#x26;token=23c65f1d-cf13-466f-acfe-71c6b5d064bd" alt=""><figcaption></figcaption></figure>

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2FLKgmvlr0TJa30heQo72O%2F3.png?alt=media&#x26;token=871fcfe4-7bde-489a-b9f1-406597f27857" alt=""><figcaption></figcaption></figure>

### Customization

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2Fh5y60P4qfmQqtf5hrII5%2F4.png?alt=media&#x26;token=1c749f31-0992-48e8-87c2-e51ab797fe4d" alt=""><figcaption></figcaption></figure>

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2Fe7bCdwWxMaVbBxbEe59c%2F5.png?alt=media&#x26;token=70719aa4-9e8e-4f0c-b852-25903e6806c6" alt=""><figcaption></figcaption></figure>

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2FGtRN690mN1Zw4ySLGywA%2F6.png?alt=media&#x26;token=2b22681f-bb23-4364-b6bc-01c9054af21a" alt=""><figcaption></figcaption></figure>

### Player Status

* Health
* Armor
* Hunger
* Thirst
* Stress
* Stamina
* Voice Activity
* Voice Proximity

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2FntGVCgikLwJH1Hf4Nif1%2F11.png?alt=media&#x26;token=aceebb87-839c-4b61-a0e8-221379816619" alt=""><figcaption></figcaption></figure>

### Extra Vehicle Features

* MANY Speedometer Choices
* Choose Between MPH or km/h
* Advanced Harness System
* Cruise Control with Speed Adjustment
* Persistent Handbrakes
* Turn indicators and Hazard controls
* Engine RPM display
* Handbrake status

### Extra Player Features

* Built-In Stress System for ALL Frameworks
* Extra Ragdoll Feature (crash into walls/ objects when you jump into them, lol)

### Advanced Harness System

The HUD includes a comprehensive vehicle harness system with:

* 3 Different Harness Levels
* Choice of Interaction Types
* Item-Based Installation by Mechanics
* Vehicle Persistence - (Harnesses will be applied to your vehicle forever)
* Configurable Protection Levels

### Reimagined Stress System

The HUD includes an all new stress management system that works with any framework and has many different triggers and extra features

<figure><img src="https://816912809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHaTfLRA7uCNOQ4cIXQD2%2Fuploads%2FQignr3QEKQHfOjjttdFx%2F9.png?alt=media&#x26;token=19501c79-f024-4789-850f-decbc9383c61" alt=""><figcaption></figcaption></figure>

#### Job-Based Stress Multipliers

* Customize stress impact based on player jobs
* Set different multipliers for different professions
* Completely disable stress for specific jobs
* Perfect for roleplay servers

```lua
JobStressMultiplier = {
    ['police'] = 0.5,    -- Police officers handle stress better.. (Half Stress)
    ['ambulance'] = 0.7, -- Medical professionals are trained for stress
    ['unemployed'] = 1.2, -- Higher stress impact
    ['developer'] = 0.0,   -- We get enough stress already... (No Stress Plz)
}
```

#### Stress Triggers

* High-speed driving with configurable thresholds
* Combat actions (shooting, getting shot, melee fights)
* Vehicle crashes
* Configurable update intervals

#### Speed-Based Stress

* Multiple speed ranges with different stress impacts
* Additional stress multiplier when driving without seatbelt
* Vehicle class exceptions (bikes, boats, aircraft, etc.)

### Install

1. Follow [FIRST STEPS (READ FIRST)](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/first-steps-read-first).
2. Start `envi-bridge` before `envi-hud`.
3. Keep the packaged `web/build/` folder inside the resource.
4. If you are not using a global target resource, follow the manifest note and set target options to match your setup.
5. On production, set `Config.Debug = false` and `Config.TestMode = false`.
6. Do not run another progress bar resource with the same provide.

### Critical live-server notes

The three highest-risk settings are:

* `Config.Debug`
* `Config.TestMode`
* `Config.InitializeDelay`

If any of those are wrong on production, the HUD can feel broken even when the rest of the install is fine.

### Safe edit points

The main supported edit areas are:

* `shared/config.lua`
* `client/client_open.lua`
* `client/progressbar.lua`
* `server/server_open.lua`

### Register these items

Default harness items:

* `harness`
* `advanced_harness`
* `ultra_harness`
* `mech_toolkit`

See the full snippets on [Inventory Setup](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/inventory-setup).

### First-time admin setup

The first admin to join can place HUD elements, choose a theme, and save the default layout for new players.

If nobody saves a layout, the HUD falls back to the built-in default. That fallback cannot be edited.

See [First Time Setup](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/first-time-setup) for the full flow.

### Helpful links

* [Critical Live-Server Flags](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/critical-live-server-flags)
* [Database and Settings](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/database-and-settings)
* [Common Issues](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/common-issues)
* [Inventory Setup](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/inventory-setup)
* [Open Lua Customization](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/open-lua-customization)
* [Progress Bar Integration](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/progress-bar-integration)
* [Seatbelt and Harness](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/seatbelt-and-harness)
* [HUD Settings and Theming](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/hud-settings-and-theming)
* [Exports and Events](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/exports-and-events)
* [Commands](https://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-hud/commands)

***

## Preview

{% embed url="<https://www.youtube.com/watch?t=13s&v=AGy3hkzG9i0>" %}


---

# 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://envi-scripts-organization.gitbook.io/documentation/premium-scripts/envi-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.