⚙️Configuration

Configuration guide of Complex Hud Script.

---

HUD Script Configuration Guide

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.

---

Main Configuration

Config.pma

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

• Example:

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

Config.Framework

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

• Example:

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

Config.groups

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

• Example:

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

Config.saltranges

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

• Example:

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

---

Team Configuration

Config.teamgroups

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

• Example:

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

Config.blacklistedstrings

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

• Example:

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

---

Keybind Configuration

Config.keybinds

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

• Example:

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

Config.hudsettingscmd

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

• Example:

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

---