FiveM Installation
Sonoran CAD's Integration Core imports common API method wrappers and functionality. Installing our integration framework is easy! Learn more below.
Last updated
Was this helpful?
Sonoran CAD's Integration Core imports common API method wrappers and functionality. Installing our integration framework is easy! Learn more below.
Last updated
Was this helpful?
Sonoran CAD integration submodules require the standard version of Sonoran CAD or higher. For more information, see our page.
We've partnered with Rocket Node to bring you one-click Sonoran CAD installation for FiveM — making it easier than ever to host your community and connect with Sonoran CAD.
Use code SONORANto save big!
Download a pre-configured version of the in-game integration resource from the panel. This download will already have your community ID and API Key in the config.lua file in addition to file renaming done for you.
Navigate to Admin -> Advanced -> In-Game Integration -> FiveM
Extract the .zip file into your resources directory. Place the [sonorancad] folder directly in the resources root directory.
In your server.cfg file, simply add the following line:
It is very important that the sonoran_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 [sonorancad] folder as that will also start the sonoran_updatehelper which might cause crashing if it is started manually. Example of not what to do ensure [sonorancad]
Modify the /configuration/config.jsonfile for any additional configuration values.
The Sonoran CAD FiveM resource contains an auto-updater that will override all non-configuration files when a new version of Sonoran CAD is released.
Some communities have custom files inside the [sonorancad] folder they don't wish to have overwritten, like custom plate reader images.
Simply add the direct path to the directory or individual files to the sonorancad/configuration/updaterIgnore.json file.
To disable this auto-update entirely set allowAutoUpdate to false in the config.json.
Extract the .zip file into your resources directory. Place the [sonorancad] folder directly in the resources root directory.
If you already have the wk_wars2x resource, please remove it from your resources folder and use the Sonoran version included with the framework download.
Open sonorancad\configuration\config.CHANGEME.json, update the values, then save it as config.json. Default configuration is below:
Add the following to your server.cfg (if you don't want pNotify or wraith, leave those out):
It is very important that the sonoran_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 [sonorancad] folder as that will also start the sonoran_updatehelper which might cause crashing if it is started manually. Example of not what to do ensure [sonorancad]
Once completed please move to the Additional Configuration section to complete your setup
Starting with framework version 2.6.2, you can override any configuration option in your config.json file by specifying a convar before the sonorancad resource starts.
This feature does not work with arrays (like statusLabels). Any other configuration option can be set using the sonoran_<configSettingHere> format.
In the CAD admin panel, navigate to: Advanced > In-Game Integration Expand the "Server Events and Integrated Live Map" section.
Enter your server's public IP address and your game server's port. By default, this is port 30120.
You may wish to also send push events to another external web server, like a Discord bot.
In the framework configuration file, simply set enablePushEventForwarding to true and pushEventForwardUrl to your web server address.
As of new installations, the configuration file has been renamed to prevent it being overwritten by updates. To use the radar for the first time, you must rename the file config.dist.lua within the wk_wars2x folder to config.lua.
Then, paste it into your server.cfg
Sonoran CAD's integration framework and submodules will automatically update with the latest features, fixes, and changes!
Or, run sonoran update to instantly check and apply any updates for the framework core.
The Sonoran CAD integration framework comes with several commands. These commands can be run in your server console to provide information, update submodules , and more.
sonoran help
Display list of commands
sonoran update
Run core/framework updater
sonoran debugmode
Toggle debug mode on/off
sonoran info
Dump version info and configuration data
sonoran support
Dump information for support staff
1. Check to make sure sonoran_updatehelper or [sonorancad] is not being started in your server.cfg.
It is very important that the sonoran_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 [sonorancad] folder as that will also start the sonoran_updatehelper which might cause crashing if it is started manually. Example of not what to do ensure [sonorancad]
1.) Check that the file in question is actually present in the specified file path. To find the correct path please read the example below:
In this example, you would navigate to the sonorancad resource, open the html folder and ensure the file config.js is present.
The Sonoran CAD FiveM resources has multiple "submodules" for every integration feature. in the /configuration folder.
The Sonoran CAD FiveM resources has multiple "submodules" for every integration feature. in the /configuration folder.
Download the
Your SonoranCAD .
from your In-Game Integration settings.
If using in Sonoran CAD, specify the ID here.
Should match what you have set in your CAD's settings.
URL to forward push events to. NOTE: DO NOT ENABLE IF YOU DO NOT KNOW WHAT YOU ARE DOING (Used for custom development only!)
By default, the framework will try and automatically correct your if it detects something different.
Set this to true to disable this functionality.
For information regarding the bodycam script config values, please see our
Set your game server port and IP address in the admin panel of Sonoran CAD. The map port can be left blank, unless you are also installing the .
Learn more about .
Check out our pre-bundled Submodule Configurationto make the integration useful. For basic functionality, we recommend at least the , , and submodules. You can also view our .
If your framework has the primaryIdentifier set to steam in the (used for your API ID type), you'll need to ensure a Steam API key is set in your server.cfg file.
You can register a new Steam API Key at
2. Try updating your smartsigns submodule manually to the latest version. This is done by copying over the lua files from the latest release found and overrideing the old files.
