Installing the FiveM In-Game Resource

Learn how to download and install the Sonoran Radio FiveM resource.

One-click Installation with RocketNode

RocketNode offers one-click Sonoran Radio installation for your FiveM server.

Purchase your FiveM Game Server!
Use code SONORAN to save big!

Install the FiveM Resource

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 Customize > Game Integration > FiveM > FiveM Installation. Expand the installation section and download the 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]

3. Update Your Server Config

In your server.cfg file, add the following:

exec @sonoranradio/sonoranradio.cfg

Do not start sonoranradio_updatehelper manually or use ensure [sonoranradio]. Use the exec line above to avoid server crashes.

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

Configuration Values

Configuration Options

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

Pro only. Allow nearby radio chatter and scanners.

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'] = 'BACKSLASH',
['power'] = '',['panic'] = '',['nextChannel'] = '',['prevChannel'] = '',['talkAnim'] = '',['nextGroup'] = '',['prevGroup'] = '',['volUp'] = '',['volDown'] = '',['toggleAutoCallouts'] = '',['toggleGeoSwitch'] = '',['toggleAi'] = '',
}

Default radio keybinds (these can be changed in GTA settings). Use the Input Parameter from the CFX Documentation.

enableVehicleRepeaters

true

Enable mobile vehicle and trailer repeaters. Configure compatible models and ranges through /radiomenu; players activate them with /radio repeater.

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.

acePermsForRadioGuests

false

Restricts the Login as Guest button to users with an ACE permission.

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

syncPlayerNameToRadio

false

Set the radio user's display name to match their in-game name.

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

heavySignalDegradeInWater

Config.heavySignalDegradeInWater = { -- Heavily degrade radio signal while the player is in water to mimic an IP67-rated handheld
enabled = true, -- Set to true to enable heavy signal degrade in water
pedInWaterDegredation = 0.6, -- Signal strength multiplier when the player is simply in water (e.g. 0.6 would reduce signal strength to 60% of normal)
pedUnderWaterDegredation = 0.3 -- Signal strength multiplier when the player is underwater (e.g. 0.3 would reduce signal strength to 30% of normal)
}

Heavily degrade radio signal while the player is in water to mimic an IP67-rated handheld

disableAnimation

false

Disable the radio talking animation for custom animation scripts.

pttAnimation

Config.pttAnimation = {
	dictionary = 'random@arrests',
	name = 'generic_radio_chatter'
}

Configure the animation dictionary and name used while transmitting on foot with the radio closed. This setting has no effect when disableAnimation is true.

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

defaultEscapeMode

keep

The default escape behavior for the in-game radio. Options: keep, hide, transmit_only.

autoCallouts

{
enabled = true, -- Whether or not this feature is enabled
speedUnit = 'mph', -- mph | kmh | none -- The unit of speed provided with the callout
withPostals = false, -- Whether to include postals with the automatic callouts
postalResource = 'nearest-postal',
}

When enabled, user radios will automatically transmit their heading, road, and speeds during a pursuit.

geoChannels

Config.geoChannels = {
enabled = true,
command = 'sonradgeoswitch', -- command to toggle geo-channel switching | e.g. /sonradgeoswitch
friendlyCommand = 'geoswitch', -- friendly subcommand of the /radio command to toggle geo-channel switching | e.g. / radio geoswitch
acePermission = '', -- ACE permission required to use disable geo-channel switching | Leave blank to allow all users
showNotifications = true -- Show notifications when geo-channel switching is enabled/disabled
}

When enabled, configure specific channels to transmit and scan when inside a geographical zone.

autoOnSceneStatus

Config.autoOnSceneStatus = {
enabled = true, -- Enable automatic ON_SCENE status when arriving at a waypoint created by SonoranRadio AI
distance = 30.0, -- Distance in meters from the waypoint to trigger ON_SCENE status
statusEnum = 4, -- Status enum for "ON_SCENE" -- See https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-status for more information
timeout = 300000 -- Time in milliseconds to timeout the auto ON_SCENE status after arriving at the waypoint
}

When the AI dispatcher GPS routes a user, automatically update their CAD status to en-route. Upon arrival, update their CAD status to on-scene.

radioJammers

Config.radioJammers = {
enabled = true, -- Enable or disable radio jammers
menuCommand = 'jammers', -- Subcommand to open the jammers menu | e.g. /sonoranradio jammers
toggleRange = 3.0, -- Distance in meters required to toggle a jammer on/off
permissionMode = 'none', -- ace, qbcore, esx or none
acePermission = 'sonoranradio.jammers', -- ACE permission required to use jammers
allowedJobs = { -- Jobs that can use jammers | Requires permission mode to be set to 'qbcore' or 'esx'
['hacker'] = {
grades = { -- Job grades that can use jammers
1,
2,
3
}
}
},
jammers = {
-- See file for full example
}
}

Configuration for in-game signal jammers.

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:

Using Sonoran Radio

PreviousDispatch AI for FiveM

NextIn-Game Radio

Last updated 4 days ago

Was this helpful?