Installing the In-Game Resource
Learn how to download and install the in-game resource.
Last updated
Learn how to download and install the in-game resource.
Last updated
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
Extract the .zip file into your resources directory. Place the sonoranradio and sonoranradio_updatehelper into a folder labeled [sonoranradio]
In your server.cfg file, add the following:
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]
Download the latest release of the FiveM resource
Extract the .zip file into your resources directory. Place the sonoranradio and sonoranradio_updatehelper into a folder labeled [sonoranradio]
Rename the config.CHANGEME.lua file to config.lua
In the config.lua file set comId to your community's ID
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.
In your server.cfg file, add the following:
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]
ACE permissions allow communities to restrict access to actions like using the radio, adding and removing towers, repairing towers, and more.
The Sonoran Radio in-game resource will automatically update with the latest features, fixes, and changes upon server restart!
Learn how to customize and use the dispatch and in-game portals:
| 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.
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.
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.
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 radio item in their inventory to be able to use the radio (QB & ESX frameworks).
acePermsForRadioUsers
false
Restrict the usage of the radio (/radiousers) with ACE permissions.
ACE Command: sonoranradio.radiousers
disableRadioOnDeath
true
Prevent users from talking on the radio while 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
