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

# Installation

Install and start GTA 6 HUD on your FiveM server.

{% stepper %}
{% step %}

#### Download and organize the files

* Go to [Cfx.re Portal](https://portal.cfx.re/).
* Authenticate with your login details.
* Open [Granted Assets](https://portal.cfx.re/assets/granted-assets).
* Download **Complete GTA 6 HUD System**.
* Drag and drop the **gta6-hud** folder into your server **resources** folder.

{% hint style="warning" %}
Keep the folder name **gta6-hud**. Renaming it will also change the resource name used by exports.
{% endhint %}
{% endstep %}

{% step %}

#### Select your framework

Open **config.lua** and set one supported value:

```lua
Config.Framework = 'standalone'
-- 'standalone' | 'esx' | 'qbcore' | 'qbox' | 'custom'
```

* **standalone:** no framework dependency. Currency values default to 0.
* **esx:** requires **es\_extended**.
* **qbcore:** requires **qb-core**.
* **qbox:** uses **qbx\_core**, with a qb-core compatibility fallback.
* **custom:** edit **bridge/custom.lua** to connect your own framework.
  {% endstep %}

{% step %}

#### Add the resource to server.cfg

Start the framework and inventory before the HUD:

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

```lua
ensure gta6-hud
```

{% endtab %}

{% tab title="ESX" %}

```lua
ensure es_extended
ensure gta6-hud
```

{% endtab %}

{% tab title="QBCore" %}

```lua
ensure qb-core
ensure qb-inventory
ensure gta6-hud
```

{% endtab %}

{% tab title="Qbox" %}

```lua
ensure qbx_core
ensure ox_inventory
ensure gta6-hud
```

{% endtab %}
{% endtabs %}

Only ensure **ox\_inventory** or **qb-inventory** when your server actually uses it.
{% endstep %}

{% step %}

#### Editable files

The following integration files remain editable when the resource is protected with FiveM Asset Escrow:

```lua
'config.lua',
'locales/*.lua',
'bridge/custom.lua'
```

{% endstep %}

{% step %}

#### Restart and verify

* Restart the server, or run **refresh** followed by **ensure gta6-hud**.
* Press **TAB** to open the weapon wheel.
* Press **Q** while the wheel is open to switch between weapons and accessories.
* Use **/hudmode** to switch between Focus and Essential modes.

All default keys can be changed in **Config.Keys**.
{% endstep %}
{% endstepper %}