Radar
Step by step installation guide, common issues & solutions, troubleshooting guide, code snippets, common error codes, config previews, locales previews and changelogs; all in 1 easily accessible place
Buy Here
FiveM Forums Post
YouTube Showcase Video - video coming soon!
This resource can be purchased as part of a bundle for a discount here.

Translate

START HERE

1. Unzip the cd_radar.zip folder and place this folder in your servers resource folder.
2. Add the resource to your server start config: ensure cd_radar (it must be placed anywhere below your framework resource eg., es_extended, not above). The name of the folder must not be changed or the resource will not function correctly.
3. WARNING do not edit the encrypted files in any way.

INSTALLATION GUIDE

Step 1 - Install the SQL

You MUST import the SQL file to your database. This SQL file is located inside theREAD_ME_AFTER_PURCHASING folder, the file is named SQL_main.sql. Watch this video if you are unsure how to do this HeidiSQL / PHPMyAdmin.

Step 2 - Fxmanifest

You may need to make some changes to the fxmanifest.lua, depending on your framework and dependencies. We have made this easier for you by commenting on the lines which you may need to change.

Step 3 - Configure the resource

You MUST read all of the configurable options inside the config.lua and configure them to suit your server's needs. Please read the ”commented out help text” at the end of each line so you can understand what each config option does.
The most important sections are the options under the Framework and Important sections at the top of the config.lua. Everything else is optional.

OPTIONAL MODIFICATIONS

Vehicles Data

What is Vehicles Data used for?
ESX
QBCore
Standalone
Other
On ESX we will grab the vehicles display names from the "vehicles" database table as this is very common in esx servers.
Multiple "vehicles" database tables
We were made aware that some servers use multiple "vehicles" database tables for donator vehicles, emergency vehicles etc. So all you need to do is add the names of these database tables into the Config.VehiclesData.VehicleDatabase_TableNames in the config,lua.
On QBCore we will grab the vehicles display names from the qb-core/shared.lua/QBShared.Vehicles as this is very common in QBCore servers.
If Config.VehiclesData is disabled, the script will get the vehicles display names from the vehicles handling files vehicles.meta. Example: <gameName>Adder</gameName>.
If Config.VehiclesData is disabled, the script will get the vehicles display names from the vehicles handling files vehicles.meta. Example: <gameName>Adder</gameName>.

Adding BOLO's & Markers from other resources

Why do I need this?
From client to server
From server to server
Template
1
TriggerServerEvent('cd_radar:RadarDatabase_ADD', {
2
plate = CHANGE_ME, --The vehicles plate.
3
model = CHANGE_ME, --The vehicles display name.
4
colour = CHANGE_ME, --The vehicles colour.
5
reason = CHANGE_ME, --The reason (the reason must already be defined in the config_ui.js's "reasonList" table).
6
type = CHANGE_ME, --Choose between "bolo" or "marker".
7
name = nil, --OPTIONAL: The characters name (if left empty cd_radar will get the players name for you),
8
notes = nil, --OPTIONAL: Notes left by the officer who issued the bolo/marker.
9
date = nil, --OPTIONAL: The time this bolo/marker was issued.
10
})
Copied!
Example
1
TriggerServerEvent('cd_radar:RadarDatabase_ADD', {
2
plate = 'CODESIGN', --The vehicles plate.
3
model = 'Adder', --The vehicles display name.
4
colour = 'Blue', --The vehicles colour.
5
reason = 'Drugs', --The reason (the reason must already be defined in the config_ui.js's "reasonList" table).
6
type = 'bolo', --Choose between "bolo" or "marker".
7
name = nil, --OPTIONAL: The characters name (if left nil, cd_radar will get the players name for you),
8
notes = 'Pablo Escobar wannabe', --OPTIONAL: Notes left by the officer who issued the bolo/marker.
9
date = '2022-06-23 19:10', --OPTIONAL: The time this bolo/marker was issued.
10
})
Copied!
Template
1
TriggerEvent('cd_radar:RadarDatabase_ADD', {
2
plate = CHANGE_ME, --The vehicles plate.
3
model = CHANGE_ME, --The vehicles display name.
4
colour = CHANGE_ME, --The vehicles colour.
5
reason = CHANGE_ME, --The reason (the reason must already be defined in the config_ui.js's "reasonList" table).
6
type = CHANGE_ME, --Choose between "bolo" or "marker".
7
name = nil, --OPTIONAL: The characters name (if left empty cd_radar will get the players name for you),
8
notes = nil, --OPTIONAL: Notes left by the officer who issued the bolo/marker.
9
date = nil, --OPTIONAL: The time this bolo/marker was issued.
10
})
Copied!
Example
1
TriggerEvent('cd_radar:RadarDatabase_ADD', {
2
plate = 'CODESIGN', --The vehicles plate.
3
model = 'Adder', --The vehicles display name.
4
colour = 'Blue', --The vehicles colour.
5
reason = 'Drugs', --The reason (the reason must already be defined in the config_ui.js's "reasonList" table).
6
type = 'bolo', --Choose between "bolo" or "marker".
7
name = nil, --OPTIONAL: The characters name (if left nil, cd_radar will get the players name for you),
8
notes = 'Pablo Escobar wannabe', --OPTIONAL: Notes left by the officer who issued the bolo/marker.
9
date = '2022-06-23 19:10', --OPTIONAL: The time this bolo/marker was issued.
10
})
Copied!
From the server side to server side, cd_radar can not get a characters name as source will not be defined.

INFORMATION

Default Key Binds

Please Read Here for more information regarding key-mapping.
Key
Description
J
Interact with the radar’s UI.
O
Toggle the radar lock.

Chat commands

All of these chat commands can be renamed and disabled/enabled in the config/code.
Command
Description
/radarsettings
Interact with the radar’s UI.
/radarlock
Toggle the radar lock.
/radartoggle
Toggle the radar UI visibility.

Events

These events are completely optional, you can use them if needed.

Server Side Events

Event
Description
TriggerServerEvent('cd_radar:RadarDatabase_ADD')
Add a new bolo/marker.
TriggerServerEvent('cd_radar:RadarDatabase_REMOVE')
Remove a bolo/marker.

Client Side Events

Event
Description
TriggerEvent('cd_radar:ToggleRadarLock')
Toggle the radar lock.
TriggerEvent('cd_radar:ToggleRadar')
Toggle the radar UI visibility.
TriggerEvent('cd_radar:ShowRadar')
Show the radar UI visibility.
TriggerEvent('cd_radar:HideRadar')
Hide the radar UI visibility.

SCRIPT NOT WORKING?

Common Issues

🔔 Folder Name Make sure the name of the folder is cd_radar.

Common Error Codes

Server
Client
468454 - #Step 1 has not been completed correctly, you have not added the vehicles database table.
3364 - When triggering the cd_radar:RadarDatabase_REMOVE server event to remove bolos/markers, you need to send a table, but you are not.
8800 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, you need to send a table, but you are not.
8801 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the plate variable is not a string or is nil.
8802 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the model variable is not a string or is nil.
8803 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the colour variable is not a string or is nil.
8804 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the reason variable is not a string or is nil.
8805 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the type variable is not a string or is nil.
8806 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the marker variable is not defined in the config_ui.js's reasonList table.
8807 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the plate variable is either more than 8 characters or is an empty string.
8808 - When triggering the cd_radar:RadarDatabase_ADD server event to add bolos/markers, the type variable can only be either bolo or marker, but you are sending something different.

Troubleshooting

1. Check if the script has authorized correctly. Enable Config.Debug in the config.lua and check the server console to make sure there are no errors saying You lack the required entitlement? and check for 2 client-sided prints saying Loaded Successfully!.
2. Check for obvious error prints in the server console and the client F8 console. If you don't see any obvious errors make sure to restart the script while the server is live and check again.
3. Change the key in the config.lua to one that you know works, as one of your other resources, may be disabling that specific key. Or read more information about #Keymapping.
4. If none of the above worked, have a second read through the installation guide above, you may have missed something - you are only human.
If all else fails, contact the Codesign Team in the Codesign Discord.

CHANGELOG

Files Changed: Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update.
  • All Files - This means you should delete your old cd_radar folder, download and add in the latest version, reconfigure the configs folder and restart your server.
  • Specific Files - This means you can simply copy and paste the SPECIFIC new files over the old ones and restart the server.
Update Type: On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work.
  • Mandatory - This means you MUST update to this new version or the old versions will no longer work.
  • Optional - This means its completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old.
v1.0.0

18/06/2022

Files Changed:
  • All files
  • Specific Files
Update Type:
  • Mandatory
  • Optional
Changelog:
STATUS
  • Development Stage: COMPLETE
  • Alpha Test Stage: IN PROGRESS
  • Beta Test Stage: NOT STARTED