---
description: Check the instructions below.
---

# Configuration

### Configuration

Open the `Config.lua` file to customize the script settings. Below are the configurable options:

#### General Settings

| Setting            | Description                           | Default Value |
| ------------------ | ------------------------------------- | ------------- |
| `Framework`        | Set the framework (`esx` or `qb`).    | `qb`          |
| `Locale`           | Language for the HUD system.          | `en`          |
| `UseCruiseControl` | Enable/disable cruise control.        | `true`        |
| `UseSeatBelt`      | Enable/disable seatbelt system.       | `true`        |
| `UseNitro`         | Enable/disable nitro system.          | `true`        |
| `UseStress`        | Enable/disable stress system.         | `true`        |
| `UseMenuKey`       | Enable/disable the menu shortcut key. | `true`        |
| `MoneyAsItem`      | Treat money as an in-game item.       | `false`       |
| `UseInGameTimer`   | Display in-game time on the HUD.      | `true`        |

***

#### Item Settings

| Setting     | Description                                      | Default Value |
| ----------- | ------------------------------------------------ | ------------- |
| `MoneyItem` | Name of the item for money (`MoneyAsItem=true`). | `"cash"`      |
| `NitroItem` | Name of the item for nitro (`UseNitro=true`).    | `"nitrous"`   |

***

#### Key Bindings

| Action            | Key | Default Command |
| ----------------- | --- | --------------- |
| Cruise Control    | `N` | `N/A`           |
| Seat Belt         | `K` | `N/A`           |
| Nitro Activation  | `X` | `N/A`           |
| HUD Menu Shortcut | `O` | `"hud"`         |

***

#### Vehicle Settings

| Setting                      | Description                                           | Default Value |
| ---------------------------- | ----------------------------------------------------- | ------------- |
| `MinSpeedToThrowFromVehicle` | Minimum speed (km/h) at which players fall from cars. | `100`         |
| `NitroForce`                 | Nitro boost strength.                                 | `50.0`        |
| `RemoveNitroOnMilliseconds`  | Nitro consumption rate (milliseconds).                | `0.2`         |

***

#### Stress System

| Setting                   | Description                                 | Default Value |
| ------------------------- | ------------------------------------------- | ------------- |
| `StressNotify`            | Enable notifications for stress increases.  | `true`        |
| `MinStressToBlur`         | Stress level threshold for screen blurring. | `50`          |
| `WhitelistedWeaponStress` | Weapons that do not cause stress.           | (See config)  |

**Stress Triggers**

* **Increase Stress**
  * `on_shoot`: Stress increase when shooting.
    * Range: `1–2`, Chance: `20%`
  * `on_fastdrive`: Stress increase when driving fast.
    * Range: `1–3`, Speed: `110 km/h`, Chance: `50%`
* **Decrease Stress**
  * Actions: Eating, drinking, swimming, running.
    * Range: `5–10`

***

#### Notifications

| Setting  | Description                          |
| -------- | ------------------------------------ |
| `Notify` | Displays custom messages to players. |

**Example Usage:**

```lua
luaCopy codeTriggerEvent("gfx_hud:sendNotify", "Message text", "fas fa-user", "red", 5000)
```

* **Message:** Text to display.
* **Icon:** FontAwesome icon. [Find icons here](https://fontawesome.com/search?o=r\&m=free).
* **Color:** Options are `"red"`, `"green"`, `"yellow"`.
* **Duration:** Time in milliseconds.

***

### Usage Examples

#### Toggle HUD

```lua
TriggerEvent("gfx_hud:toggle", true)
```

#### Add Stress

```lua
TriggerEvent("gfx_hud:stress:add", 50)
```

#### Remove Stress

```lua
TriggerEvent("gfx_hud:stress:decrease", 50)
```

#### Toggle Seat Belt

```lua
TriggerEvent("gfx_hud:client:toggleSeatBelt", true)
```
