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

# Installation

## Requirements

* A recent FiveM server (artifact with `lua54`).
* No mandatory dependency. `oxmysql` is needed **only** with `Config.DbSync = true` (layout synced to the database).
* Optional, auto-detected: `esx_status` (ESX hunger/thirst), `pma-voice` or `saltychat` (voice), `ox_fuel` / `LegacyFuel` / `cdn-fuel` (fuel).

## 1. Download

The script is delivered through **Cfx.re Asset Escrow**. After the purchase, log in to [portal.cfx.re](https://portal.cfx.re) with the Cfx.re account used for the purchase and open **Granted Assets**. Download `ghiaccio_hud` from there.

{% hint style="info" %}
Escrowed resources only run on servers whose license key belongs to the purchasing Cfx.re account.
{% endhint %}

## 2. Copy the resource

Copy `ghiaccio_hud` into `resources/`.

## 3. Stop any other HUD

Two HUDs overlap and double the cost. At start the resource warns in the console if `qb-hud`, `qbx_hud` or `esx_hud` are running.

{% hint style="warning" %}
If you start a category folder (for example `ensure [qb]`), removing the line is not enough: **move the other HUD folder out of `resources/`**.
{% endhint %}

## 4. server.cfg

Ensure the HUD **after** the framework (and after `oxmysql` if you use DbSync):

```cfg
ensure oxmysql            # only with Config.DbSync = true
ensure es_extended        # or qb-core / qbx_core
ensure ghiaccio_hud
add_ace group.admin ghiaccio_hud.admin allow    # optional: who may publish the server layout (in addition to Config.AdminGroups)
```

## 5. Framework setup

`Config.Framework = 'auto'` detects the framework in this order: **Qbox (`qbx_core`), QBCore (`qb-core`), ESX (`es_extended`)**, otherwise standalone. Qbox is checked first because it also provides `qb-core`. You can force it with `'esx'`, `'qbcore'`, `'qbox'` or `'standalone'`; if a forced framework does not exist the HUD falls back to standalone with a console warning.

{% tabs %}
{% tab title="ESX" %}

* Remove `esx_hud` and similar.
* Hunger/thirst come from `esx_status`: **without `esx_status` the hunger/thirst widgets stay hidden** (never fake values).
* Cash/bank come from the `money` / `bank` accounts.
* Stress uses the built-in one (`Config.Stress`).
  {% endtab %}

{% tab title="QBCore" %}

* Remove `ensure qb-hud`.
* Cash, hunger, thirst and stress come from the player metadata.
* `qb-smallresources` can stay: its seatbelt is detected as an external seatbelt.
  {% endtab %}

{% tab title="Qbox" %}

* Remove `qbx_hud`.
* Same structure as QBCore (data from `qbx_core`).
  {% endtab %}

{% tab title="Standalone" %}

* No framework: no cash and no hunger/thirst (those widgets are hidden).
* Health, armor, stamina, oxygen, weapon, vehicle, compass, clock and minimap work.
* `Config.Framework = 'standalone'` forces it.
  {% endtab %}
  {% endtabs %}

## 6. Start and check the console

Restart the server and read the console: it prints the chosen framework and the adapters (fuel, status, voice, seatbelt). Then open the editor in game with `/hud` (or **F7**).

## Optional: database sync

To make each player's layout follow them to another PC, set `Config.DbSync = true` in `config_server.lua` and start `oxmysql` **before** `ghiaccio_hud`. The database table is migrated automatically.

## Escrow: what you can edit

Encrypted: `client/`, `server/`, `shared/`. Plain and editable: `config.lua`, `config_server.lua`, `bridge/`, `adapters/`, `locales/`, `data/`, `LICENSES/`.

## Changing the logo

Replace `web/dist/logo.svg` with your logo, keeping the name `logo.svg` (or use another name and update `Config.Logo`). With `Config.Logo = ''` the `Config.ServerName` text is shown.


---

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ghiaccioscripts.gitbook.io/ghiaccioscripts-docs/hud/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
