Getting Started

Acquire the Script

After purchasing the script through the Sonoran store you may download the script through the keymaster account that purchased the script. Upon downloading extract the file to a safe place.

Install Prerequisite

You must use the Sonoran Fork of WK_Wars2x found here.Minimum version required: v1.3.4-sonoran

If you are using the Sonoran CAD FiveM Integration, DO NOT install a second copy of WK_Wars2x, it is included and updated with the sonorancad resource.

WK_Wars2x Radar script is required for this resource to function fully. Please ensure you are using the Sonoran Fork of WK_Wars2x. This is included with the Sonoran CAD FiveM Integration by default. You can also download the latest release of the resource here.

Install the Script

Inside the script package you just extracted will be two folders. Copy both to a folder in your server’s resources folder called [sonoranscripts] note the [] in the name, without them it will not work.

Sonoran Software - Radar Detector - Folders

In the sonoran-radarddetector/config folder there will be a file called config.CHANGEME.lua you should rename that to be config.lua and configure the settings inside as you would like them to be configured based on the configuration documentation below.

QBCore Specific - Please follow Step 3 to ensure inventory items have correct photos!

Drag the radar_detector.png from /sonoran-radardetector/ into the following folder: /resources/[qb]/qb-inventory/html/images

ESX Specific Specific - Please follow Step 4 to ensure inventory items work!

a.) Import the ESX Installme.sql file into your ESX database If NOT using****** ox_inventory** ****continue to step 5 b.) Add the following code to the /ox_inventory/data/items.lua file
['sonoran_radar_detector'] = { label = 'Radar Detector/Jammer', weight = 1, stack = true, close = true, description = nil },
Finally, in your server.cfg add the following:

ensure sonoran-radardetector

add_ace resource.sonoran-radardetector command allow
add_ace resource.sonoran-radardetector_helper command allow

NEVER add ensure sonoran-radardetector_helper or ensure [sonoranscripts] to your server.cfg as this will lead to crashing under specific conditions.

Configuring the Script

Default config.lua

Config = {}

Config.debug_mode = false -- Enable debug mode
Config.configuration_version = 1.0
Config.auto_update = true -- Enable auto updates

Config.lang = {
    addNewRadarHelp = 'Open the menu to begin spawning a new radar detector model',
    vehNotCompatible = 'This vehicle is not compatible with the radar detector placement system!',
    vehAlrRadar = 'This vehicle already has a valid radar!',
    noItem = 'You do not have a radar detector in your inventory!',
    radarMenuHeader = 'Radar Detector',
    creditsPanel = 'Made by',
    spawningSubMenu = 'Radar Detector Spawning',
    attachingSubMenu = 'Attaching',
    deletionSubMenu = 'Are you sure?',
    radarRemoteSubMenu = 'Radar Remote Menu',
    radarRemoteMenuButton = "Radar Detector Remote",
    radarAttachMenuButton = 'Attach Radar Detector',
    deleteMenuButton = 'Delete Current Radar Detector',
    spawnMenuButton = 'Spawn Radar Detector',
    deletionConfirmationButton = 'Yes, I want to permanatly delete this radar detector',
    deletionCancelButton = 'No, I want to keep this radar detector',
    deletionCancelled = 'Radar detector deletion cancelled',
    noDetectorFound = 'No Radar Detector is in this vehicle!',
    toggleDetectionMode = 'Toggle Detection Mode',
    detectionModeEnabled = 'Radar Detection Mode ~g~enabled~w~!',
    detectionModeDisabled = 'Radar Detection Mode ~r~disabled~w~!',
    toggleJammingMode = 'Toggle Jamming Mode',
    jammingModeEnabled = 'Radar Jamming ~g~enabled~w~!',
    jammingModeDisabled = 'Radar Jamming ~r~disabled~w~!',
    toggleRadarPower = 'Toggle Radar Detector Power',
    detectorPoweringUp = 'Radar Detector is powering ~g~up~w~!',
    detectorPoweringDown = 'Radar Detector is powering ~r~down~w~!',
    modelComboBox = 'Model:',
    vehAlrRadarNoti = '~r~This vehicle already has a radar detector of this type',
    notInVeh = '~r~You must be in a vehicle!',
    objectName = 'Sonoran Laser/Radar Detector',
    vehicleBone = 'Radar - Vehicle Bone',
    radarNotInInv = '~r~You do not have a radar detector in your inventory!',
    object = "Object:",
    vehicleBoneComboBox = 'Vehicle Bone',
    attachButton = 'Attach',
    detachButton = 'Detach',
    confirmPlacementButton = 'Confirm Placement',
    cannotGoFaster = '~r~You cannot go any faster!',
    cannotGoSlower = '~r~You cannot go any slower!',
}

Config.commands = {
    radarDetectorMenu = 'detectormenu',
    restricted = false -- should the detector menu be restricted?
}

Config.permissionMode = "ace" -- Available Options: ace, framework, custom

-- Ace Permissions Section --
Config.acePerms = {
    aceObjectUseMenu = "sonoran.radardetector", -- Select the ace for placing new ATM's and using admin repair
}

-- Framework Related Settings --
Config.framework = {
    frameworkType = "qb-core", -- This setting controls which framework is in use options are esx or qb-core
    inventoryType = "normal", -- Which inventory you would like to use normal, quasar, ox_inventory (OX Will only work for ESX Legacy as of now)
    civilianJobNames = {"unemployed"}, -- An array of job names that should be allowed to use the radar menu
    useCivilianJobListAsBlacklist = false, -- This will treat the civilian job list as a blacklist rather than a whitelist
}

-- Configuration For Custom Permissions Handling --
Config.custom = {
    checkPermsServerSide = true, -- If true the permission event will be sent out to the server side resource, this is recommended
    permissionCheck = function(_, type) -- This function will always be called server side.
        if type == 0 then -- Check permission to use the menu
            return true or false -- Return true if they have admin, return false if they don't
        end
    end
}

Config.general = {
    playRandomSounds = true, -- Should random sounds be played when the radar is powered on?
    randomSounds = {"x_band", "k_band", "ka_band", "laser", "gps_connected"}, -- An array of sounds that should be played randomly when the radar is powered on
    randomSoundInterval = 5, -- How often in minutes should a random sound be played if a radar is on?
    detectDistance = 250.0, -- How far away should the player be able to detect a radar?
    notificationType = "native", -- Available options: native, pNotify, okokNotify
}

Config.blacklistedCars = {
        "FIRETRUK",
        "LGUARD",
        "PBUS",
        "POLMAV",
        "POLICET",
        "PRANGER",
        "PREDATOR",
        "RIOT",
        "RIOT2",
        "AMBULAN"
}

Configuration Breakdown

Config Option	Option Description	Default Value	Type
`debug_mode`	Enable enhanced logging - typically for diagnosing issues	`false`	Boolean
`configuration_version`	The version your config file is currently set to. DO NOT EDIT	`1.0`	Int
`auto_update`	Enabled auto updates with our Sonoran Updater	`true`	Boolean
`lang`	Here you will find our easy translations, simply edit if you would like to update the language used in the script	English	String
`radarDetectorMenu`	Command to open the radar detector menu	`detectormenu`	String
`restricted`	Specifies if the detector menu should be restricted	`false`	Boolean
`permissionMode`	Permission mode for the radar detector	`ace`	String
`aceObjectUseMenu`	Select the ace premission allowed to use the radar detector menu	`sonoran.radardetector`	String
`frameworkType`	This setting controls which framework is in use options are esx or qb-core	`qb-core`	String
`inventoryType`	Which inventory you would like to use normal, quasar, ox_inventory (OX Will only work for ESX Legacy as of now)	`normal`	String
`civilianJobNames`	An array of job names that should be allowed to use the radar menu	`{"unemployed"}`	Table
`useCivilianJobListAsBlacklist`	This will treat the civilian job list as a blacklist rather than a whitelist	`false`	Boolean
`playRandomSounds`	Should random sounds be played when the radar is powered on?	`true`	Boolean
`randomSounds`	An array of sounds that should be played randomly when the radar is powered on	`{"x_band", "k_band", "ka_band", "laser", "gps_connected"}`	Table
`randomSoundInterval`	How often in minutes should a random sound be played if a radar is on?	`5`	Number
`detectDistance`	How far away should the player be able to detect a radar?	`250.0`	Number
`notificationType`	Available options: native, pNotify, okokNotify	`native`	String
`blacklistedCars`	Vehicles that are not allowed to have a radar detector put in them	`Table`	Table

Commands

Command Name	Command Description	Required Permission
`/detectormenu`	This command will open the radar detector/jammer menu and allow you to configure and spawn your radar detector/jammer	Everyone or as configured

Usage

Place a detector

Sit in a compatible vehicle and bring it to a complete stop. Close any tablet or other open interface.
Run /detectormenu to open the detector menu. Your server may use a different command if configured.
Select Spawn Radar Detector, then select Spawn Radar Detector in the submenu to open the mouse placement editor.
Use Move and Rotate to position the detector inside the vehicle.
Select Apply to this vehicle to install the detector at the chosen position.

In framework mode, you need a Radar Detector/Jammer item in your inventory. The item is used when the installation is accepted. Selecting Cancel before applying leaves the item in your inventory.

Move

Select Move, then left-click and drag a colored arrow to move along one axis. Drag a colored square to move along two axes at once.

Screenshot placeholder — Move controls: In-game cabin view with the detector selected, Move active, colored arrows and squares visible, and the toolbar and Apply to this vehicle button in frame.

Rotate

Select Rotate, then left-click and drag a colored ring to turn the detector around that axis. The outer gray ring rotates it around your viewing direction.

Screenshot placeholder — Rotate rings: In-game cabin view with the detector selected, Rotate active, colored rotation rings and the outer gray ring visible, and the toolbar and Apply to this vehicle button in frame.

Placement controls

Control	What it does
Local axes / World axes	Switch between axes aligned with the detector and axes aligned with the game world.
Snap: off	Enable movement in 1 cm steps and rotation in 5° steps. Select it again to turn snapping off.
Right mouse drag	Look around from the cabin camera. Enable Orbit detector to rotate the camera around the detector instead.
Middle mouse drag	Lean the camera slightly to adjust your view.
Mouse wheel	Zoom the view in or out.
Look at detector	Aim the camera at the detector from your current viewpoint.
Cabin view	Restore the starting camera view.
Reset	Restore the detector’s position and rotation from when you opened the editor.
Cancel	Close the editor and discard the placement changes.

Keep the vehicle stationary while placing the detector. Placement cancels if the vehicle moves or you leave it.

Reposition a detector

Run /detectormenu in the stopped vehicle, select Attach Radar Detector, then Position radar detector with mouse. Use the same Move and Rotate controls, then select Apply to this vehicle to keep the new placement. Cancel keeps the previous placement.

Use the detector and jammer

After applying the placement, reopen /detectormenu and select Radar Remote Menu. Use Toggle Radar Detector Power to turn it on, then use Toggle Detection Mode and Toggle Jamming Mode as needed.

Placement troubleshooting

If the editor will not open, stop the vehicle, close other interfaces, and check that the vehicle is compatible and you have menu access. In framework mode, also check that you have the detector item.
If you lose sight of the detector, select Look at detector or Cabin view.
If repositioning reports that you do not control the detector, retry once you have control of it.

Start here

General

Other

Acquire the Script

Install Prerequisite

Install the Script

Configuring the Script

Configuration Breakdown

Commands

Usage

Place a detector

Move

Rotate

Placement controls

Reposition a detector

Use the detector and jammer

Placement troubleshooting

​Acquire the Script

​Install Prerequisite

​Install the Script

​Configuring the Script

​Configuration Breakdown

​Commands

​Usage

​Place a detector

​Move

​Rotate

​Placement controls

​Reposition a detector

​Use the detector and jammer

​Placement troubleshooting

Acquire the Script

Install Prerequisite

Install the Script

Configuring the Script

Configuration Breakdown

Commands

Usage

Place a detector

Move

Rotate

Placement controls

Reposition a detector

Use the detector and jammer

Placement troubleshooting