> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoscripts.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Revo HUD and set it up on your FiveM server.

## Requirements

> [!NOTE]
>
> Revo HUD is **drag and drop**: nothing to build, no npm and no SQL to import. It has **no required dependencies** and needs **no database**. It works with **ESX Legacy**, **QBCore**, **Qbox** or no framework at all, and detects which one you run automatically.

Everything below is optional. The HUD reads from whichever of these it finds running, so start them **before** `revo_hud`.

> **Optional resources the HUD can read from**
>
> | What | Supported resources |
> | - | - |
> | Inventory | `ox_inventory`, `qb-inventory` |
> | Hunger and thirst | `esx_status` (ESX), player metadata (QBCore), state bags (Qbox), or the `setStatus` export |
> | Fuel | `ox_fuel`, `LegacyFuel`, `cdn-fuel`, `ps-fuel`, `lj-fuel`, `okokGasStation`, `qs-fuelstations`, `lc_fuel`, or any script with a `GetFuel` export |
> | Voice | `pma-voice`, `SaltyChat`, `mumble-voip` |
> | Society money | `Renewed-Banking`, `qb-banking`, `qb-management`, `okokBanking`, `esx_addonaccount` (used by `esx_society`) |
> | Trains | Any train script (the HUD reads the train itself) |
> | Stress | QBCore's `hud:server:GainStress` and `RelieveStress` events |
> | Progress bar | `ox_lib`, used for the nitrous fitting bar when it is running |
>
> The vehicle panel's synced **Media player** needs **OneSync**, which is on by default on current servers.

> [!NOTE]
>
> If you run another HUD, stop it first so the two do not draw on top of each other. Revo HUD already hides GTA's own cash, vehicle name, area name and stock speedometer.

## Install

**1. Download Revo HUD**

Visit the [FiveM Keymaster](https://keymaster.fivem.net/) and download the latest version of **Revo HUD**. Save the script to your computer.

**2. Add to Resources**

Place the `revo_hud` folder inside your server's `resources` directory.

> [!WARNING]
>
> Keep the folder name exactly `revo_hud`. If it is renamed, the resource does not start, and the console tells you it was renamed.

**3. Configure server.cfg**

Start `revo_hud` **after** your framework and the scripts it reads from:

```bash theme={null}
ensure es_extended        # or qb-core / qbx_core
ensure ox_inventory       # if you use it
ensure pma-voice          # or saltychat
ensure revo_hud
```

**4. Let Your Staff Unlock the Editing Tools**

Add this ACE line to your `server.cfg` so your admins can always edit the HUD, even when you lock editing for players:

```bash theme={null}
add_ace group.admin revo_hud.admin allow
```

> [!NOTE]
>
> Staff with the `revo_hud.admin` ACE can also use `/revohudadmin` to switch a player's HUD on or off (see [Usage](/products/hud/usage#staff-commands)). The ACE name can be changed with `Config.Customization.adminAce`.

**5. Set Your Server Name and Logo**

Open `config.lua` and set your server name and logo in `Config.PlayerInfo`:

```lua theme={null}
serverName = 'SERVER NAME',      -- your server's name, shown in setup and on the Presets tab
logoType   = 'image',            -- or 'text' to use logoText instead
logoPath   = 'server-logo.png',  -- a file in revo_hud/html/dist/, or a full https:// link
logoText   = 'LOGO',             -- the text logo, and the fallback if the image is missing
```

The HUD ships with the Revo logo as a placeholder. To use your own, replace `revo_hud/html/dist/server-logo.png` with your logo (a transparent PNG, about 500 x 200) and keep the same name, or put it next to it and change `logoPath`.

**6. Choose How Cars Get Nitrous**

Nitrous is built in. By default a car needs a **nitrous kit** and bottles are swapped with a **bottle item**, so add the two items to your inventory.

If you do not want to use items, set `Config.Nitro.fitting = 'all'` to give every car nitrous with no items at all.

See [Nitrous](/products/hud/usage#nitrous) for the item definitions for ox\_inventory, QBCore and ESX.

**7. Start the Resource**

Restart your server, or run these commands in the server console:

```bash theme={null}
refresh
ensure revo_hud
```

## What Players See

Players see the HUD once their character is in the world. New players get a short four-step setup the first time they join, where they pick a look, an accent color, a round or square minimap and a status bar style. They can open it again any time with `/onboard`, and change everything later with `/hud`.

> [!NOTE]
>
> Each player's personal settings (colors, styles, layout) are saved on their own PC. Server-wide defaults come from `config.lua`.

## Optional Setup

These steps are optional and can be done any time:

> **[Nitrous Items](/products/hud/usage#add-the-items)**
>
> Add the nitrous kit and bottle items to your inventory.

> **[Customization](/products/hud/customization)**
>
> Set the default preset, add your own presets, languages and a postal or satellite minimap.

> **[Notifications](/products/hud/configuration#notifications)**
>
> Send ESX, QBCore or Qbox notifications to the HUD.

> **[Configuration](/products/hud/configuration)**
>
> Every option in `config.lua` explained.

## Verify the Installation

After the server starts, join and check:

1. The HUD appears once your character is loaded.
2. `/hud` opens the settings menu.
3. The server name and logo in the setup or the Presets tab are yours.
4. The status bars, minimap and speedometer appear when you get in a car.

> [!TIP]
>
> If something does not appear, set `Config.Debug = true` and read the F8 console. It prints which framework and fuel script the HUD found and why it is hidden. See [Troubleshooting](/products/hud/troubleshooting).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.