Installing the In-Game Resource

Learn how to download and install the in-game resource.

Pre-Configured Resource Installation (Recommended)

1. Download the ZIP

Download a pre-configured version of the in-game resource from the panel. This download will already have your community ID and API key in the config.lua file.

Navigate to Customization > FiveM Integration > Download Resource

2. Extract the ZIP File

Extract the .zip file into your resources directory. Place the sonoranradio and sonoranradio_updatehelper into a folder labeled [sonoranradio]

Sonoran Radio - Folder Structure

3. Update Your Server Config

In your server.cfg file, add the following:

# Start the sonoranradio resource
ensure sonoranradio

# Permissions for auto-updater (REQUIRED)
add_ace resource.sonoranradio command allow
add_ace resource.sonoranradio_updatehelper command allow

It is very important that the sonoranradio_updatehelper resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.

DO NOT start the whole [sonoranradio] folder as that will also start the sonoranradio_updatehelper which might cause crashing if started manually.

Example of what NOT to do: ensure [sonoranradio]

Start this resource AFTER your preferred framework and any additional framework core resources such as inventory resources

---

Resource Installation (Manual)

1. Download the ZIP

Download the latest release of the FiveM resource

2. Extract the ZIP File

Extract the .zip file into your resources directory. Place the sonoranradio and sonoranradio_updatehelper into a folder labeled [sonoranradio]

Sonoran Radio Folder Structure

3. Configure Community Information

1. Rename the config.CHANGEME.lua file to config.lua

2. In the config.lua file set comId to your community's ID

3. in the config.lua file set apiKey to your community's API key

The community ID and API key can be found in the Administration tab.

Sonoran Radio - Community ID & API Key

4. Update Your Server Config

In your server.cfg file, add the following:

# Start the sonoranradio resource
ensure sonoranradio

# Permissions for auto-updater (REQUIRED)
add_ace resource.sonoranradio command allow
add_ace resource.sonoranradio_updatehelper command allow

It is very important that the sonoranradio_updatehelper resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.

DO NOT start the whole [sonoranradio] folder as that will also start the sonoranradio_updatehelper which might cause crashing if started manually.

Example of what NOT to do: ensure [sonoranradio]

---

Configuration Values

Parameter	Default	Description
comId	EMPTY	The Sonoran Radio Community ID
apiKey	EMPTY	The Sonoran Radio Community API Key
debug	false	Display tower ranges on the map and other console prints. This can be toggled live with the debug mode command.
allowUpdateWithPlayers	true	Allow the auto-updater to run while players are still in the server.
enableCanary	false	Allow the auto-updater to pull development branches for early testing.
allowAutoUpdate	true	Allow the auto-updater to run.
chatter	true	Allow civilians to hear radio chatter when one is nearby
talkSync	true	Talk in-game whenever you talk on the radio If using BD Animations, you will also need to disable their TalkSync feature in the settings.ini file.
emergencyCallCommand	911	Command suffix to start or stop an emergency call (i.e. '911' == /radio 911)
luxartResourceName	lvc	Resource name for Luxart Vehicle Control, used for the siren volume integration.
keybinds	Config.keybinds = { ['toggle'] = '', ['ptt'] = '\\', ['power'] = '', ['panic'] = '', ['nextChannel'] = '', ['prevChannel'] = '', ['talkAnim'] = '' }	Default radio keybinds (these can be changed in GTA settings)
towerRepairTimer	20	Time (in seconds) that it takes a player to repair a destructed tower.
rackRepairTimer	15	Time (in seconds) that it takes a player to repair a destructed server rack.
antennaRepairTimer	15	Time (in seconds) that it takes a player to repair a destructed cellular antenna.
acePermSync	false	Sync ACE permissions to auto-approve and grant radio permissions from in-game.
acePermsForServerRepair	false	Restrict the ability to repair damaged radio repeaters with ACE permissions. ACE Command: sonoranradio.repair
acePermsForTowerRepair	false	Restrict the ability to repair damaged radio repeaters with ACE permissions. ACE Command: sonoranradio.repair
acePermsForAntennaRepair	false	Restrict the ability to repair damaged radio repeaters with ACE permissions. ACE Command: sonoranradio.repair
acePermsForRadio	false	Restrict the usage of the radio (/radio) with ACE permissions. ACE Command: sonoranradio.use
enforceRadioItem	false	Require the user to have a item in their inventory to be able to use the radio or radio scanner. View supported frameworks and inventories.
acePermsForRadioUsers	false	Restrict the usage of the radio (/radiousers) with ACE permissions. ACE Command: sonoranradio.radiousers
disableRadioOnDeath	true	Disables radio when dead.
restoreRadioStateWhenAlive	true	Restore the radio's power state (on/off) when you are revived or respawn.
deathDetectionMethod	auto	What method to use for death detection. auto, manual, or qbcore
disableAnimation	false	Disable the radio talking animation for custom animation scripts.
noPhysicalCellRepeaters	false	Hide the in-game cellular antenna repeaters
noPhysicalRacks	false	Hide the in-game server rack repeaters
noPhysicalTowers	false	Hide the in-game tower repeaters

---

ACE Permissions (Command Restrictions)

ACE permissions allow communities to restrict access to actions like using the radio, adding and removing towers, repairing towers, and more.

Configuring ACE Permissions

---

Updates

The Sonoran Radio in-game resource will automatically update with the latest features, fixes, and changes upon server restart!

---

Next Steps

Learn how to customize and use the dispatch and in-game portals:

Usage