Skip to main content

Introduction

Toggle Siren allows you to configure and customize siren sounds for emergency vehicles in FiveM. Below is the detailed configuration file for the product.

Configuration File​

View config.json
{
/* -- Verification -- */
/* You can find your license key on https://garmingo.com/dashboard */
"License": "Enter License Key"
/* -- Verification -- */

/* -- Audio Sources -- */
/* Guide: By default sounds are included in the "" audio namespace/bank. If you are using additional siren packs you have to enter its audio bank name below. */
/* Specifying audio bank of a siren sound: By default siren sounds are looked up in the default game namespace. If you use a sound from a different audio bank add "!" and then the namespace to the sound name. */
/* Example: Default Game: "SIRENS_AIRHORN" from a soundpack "SIRENS_AIRHORN!MySuperSoundPack" */
"CustomAudioBanks": [
/*"Example"*/
],
/* -- Audio Sources -- */

/* -- Airhorn -- */
"DefaultAirhorn": "SIRENS_AIRHORN",
"CustomAirhorns": {
"firetruk": "VEHICLES_HORNS_FIRETRUCK_WARNING"
},
/* -- Airhorn -- */

/* -- Siren Sounds -- */
"DefaultSounds": [ "VEHICLES_HORNS_SIREN_1", "VEHICLES_HORNS_SIREN_2", "VEHICLES_HORNS_POLICE_WARNING" ],
"CustomSounds": {
"firetruk": [
"RESIDENT_VEHICLES_SIREN_FIRETRUCK_WAIL_01",
"RESIDENT_VEHICLES_SIREN_FIRETRUCK_QUICK_01",
"VEHICLES_HORNS_FIRETRUCK_WARNING"
],
"ambulan": [
"RESIDENT_VEHICLES_SIREN_WAIL_01",
"RESIDENT_VEHICLES_SIREN_QUICK_01",
"VEHICLES_HORNS_AMBULANCE_WARNING"
],
"lguard": [
"RESIDENT_VEHICLES_SIREN_WAIL_01",
"RESIDENT_VEHICLES_SIREN_QUICK_01",
"VEHICLES_HORNS_AMBULANCE_WARNING"
]
}, /* The default siren sounds (must always be three: primary, secondary, warning) */
/* -- Siren Sounds -- */

/* -- Spam Prevention -- */
"QueueDelay": 150, /* Delay in ms */
"QueueLimit": 25, /* Actions in queue before reset */
/* -- Spam Prevention -- */
}

Verification​

  • License: A unique identifier for each transaction. This field is used for tracking and verification purposes. Learn more

Audio Sources​

  • CustomAudioBanks: By default, sounds are included in the default audio namespace/bank. If you are using additional siren packs, you need to enter their audio bank name here. To read more about custom sounds, refer to the Custom Sirens documentation.

Airhorn​

  • DefaultAirhorn: Default airhorn sound, e.g., "SIRENS_AIRHORN".
  • CustomAirhorns: Custom airhorn sounds mapped to specific vehicles.
    • Example:
      "CustomAirhorns": {
      "firetruk": "VEHICLES_HORNS_FIRETRUCK_WARNING"
      }

Siren Sounds​

  • DefaultSounds: The default siren sounds which must always include three sounds: primary, secondary, and warning.
    • Example:
      "DefaultSounds": [ "VEHICLES_HORNS_SIREN_1", "VEHICLES_HORNS_SIREN_2", "VEHICLES_HORNS_POLICE_WARNING" ]
  • CustomSounds: Custom siren sounds for specific vehicles, each mapped to three sounds: primary, secondary, and warning.
    • Example:
      "CustomSounds": {
      "firetruk": [
      "RESIDENT_VEHICLES_SIREN_FIRETRUCK_WAIL_01",
      "RESIDENT_VEHICLES_SIREN_FIRETRUCK_QUICK_01",
      "VEHICLES_HORNS_FIRETRUCK_WARNING"
      ],
      "ambulan": [
      "RESIDENT_VEHICLES_SIREN_WAIL_01",
      "RESIDENT_VEHICLES_SIREN_QUICK_01",
      "VEHICLES_HORNS_AMBULANCE_WARNING"
      ],
      "lguard": [
      "RESIDENT_VEHICLES_SIREN_WAIL_01",
      "RESIDENT_VEHICLES_SIREN_QUICK_01",
      "VEHICLES_HORNS_AMBULANCE_WARNING"
      ]
      }

Spam Prevention​

  • QueueDelay: Delay in milliseconds to prevent spamming.
  • QueueLimit: The limit of actions in the queue before it resets.