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

# Configuration

***

#### <mark style="color:blue;">**HUD Script Configuration Guide**</mark>

This guide provides detailed instructions for configuring the **STG HUD Script** for FiveM. This script allows for seamless integration of a customizable HUD system, supporting various voice systems, frameworks, and keybind options.

***

#### <mark style="color:green;">**Main Configuration**</mark>

<mark style="color:green;">**Config.pma**</mark>

* **Description**: Specifies whether the script should use `pma-voice`. Set to `true` for PMA Voice and `false` for SaltyChat.
* **Example**:

  ```lua
  Config.pma = true -- true for PMA Voice, false for SaltyChat
  ```

<mark style="color:green;">**Config.Framework**</mark>

* **Description**: Determines the framework used by the script. Use `auto` for automatic detection, or specify `esx` or `qb`.
* **Example**:

  ```lua
  Config.Framework = "auto" -- Options: auto, esx, qb
  ```

<mark style="color:green;">**Config.groups**</mark>

* **Description**: A list of group names for certain functionalities (currently empty by default).
* **Example**:

  ```lua
  Config.groups = {
      '' -- Add group names here
  }
  ```

<mark style="color:green;">**Config.saltranges**</mark>

* **Description**: Defines the voice ranges if using SaltyChat. Must include exactly three values for range distances.
* **Example**:

  ```lua
  Config.saltranges = {
      [1] = 3.0, -- Whisper range
      [2] = 10.0, -- Normal range
      [3] = 25.0 -- Shouting range
  }
  ```

***

#### <mark style="color:green;">**Team Configuration**</mark>

<mark style="color:green;">**Config.teamgroups**</mark>

* **Description**: Specifies the team groups allowed to access certain features.
* **Example**:

  ```lua
  Config.teamgroups = {
      'superadmin',
      'admin',
      'moderator',
  }
  ```

<mark style="color:green;">**Config.blacklistedstrings**</mark>

* **Description**: A list of blacklisted strings that cannot be used in chat or other functionalities.
* **Example**:

  ```lua
  Config.blacklistedstrings = {
      'idiot' -- Add other prohibited strings here
  }
  ```

***

#### <mark style="color:green;">**Keybind Configuration**</mark>

<mark style="color:green;">**Config.keybinds**</mark>

* **Description**: Defines keybinds for specific functionalities. Each keybind has a name and an associated key.
* **Example**:

  ```lua
  Config.keybinds = {
      {
          name = 'BreadCrumbs',
          key = 'F1',
      },
      {
          name = 'Radio',
          key = 'F2',
      },
      {
          name = 'Phone',
          key = 'F3',
      }
  }
  ```

<mark style="color:green;">**Config.hudsettingscmd**</mark>

* **Description**: Sets the command used to open the HUD settings menu.
* **Example**:

  ```lua
  Config.hudsettingscmd = 'hud' -- Replace 'hud' with your preferred command
  ```

***