# FiveM Installation {% hint style="warning" %} Sonoran CAD integration submodules require the **standard** version of Sonoran CAD or higher. For more information, see our [pricing ](https://docs.sonoransoftware.com/cad/pricing/faq)page. {% endhint %} ## A. One-Click Installation (RocketNode) 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. * [Purchase your FiveM Game Server!](https://sonoran.link/v2E9hKGm) * Use code `SONORAN`to save big! {% embed url="" %} The Sonoran CAD FiveM resources has multiple "submodules" for every integration feature. [These are easily enabled and configured](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/submodule-configuration) in the `/configuration` folder. {% content-ref url="fivem-installation/submodule-configuration" %} [submodule-configuration](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/submodule-configuration) {% endcontent-ref %} *** ## B. Pre-Configured Resource Installation {% embed url="" %} ### 1. Download the ZIP 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`

Sonoran CAD: FiveM Resource Download

### 2. Extract the ZIP File Extract the `.zip` file into your resources directory. Place the `[sonorancad]` folder directly in the resources root directory.

Sonoran CAD - Folder Structure

### 3. Update Your Server Config In your `server.cfg` file, simply add the following line: ``` exec @sonorancad/sonorancad.cfg ``` {% hint style="danger" %} 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]` {% endhint %}
Advanced - Remove Tablet, pNotify, etc. Adding the `exec @sonorancad/sonorancad.cfg` starts multiple resources bundled with the download. If you wish to not use one or more of the resources (or with a different name) you will need to: * Copy/paste the contents of `sonorancad.cfg` to your `server.cfg` * Remove the `exec @sonorancad/sonorancad.cfg` line from your `server.cfg` Do not update the contents of `sonorancad.cfg` as it will be overwritten on resource updates.
### 4. Configure the Resource Modify the `/configuration/config.json`file for any additional configuration values. ### 5. Configure the Submodules The Sonoran CAD FiveM resources has multiple "submodules" for every integration feature. [These are easily enabled and configured](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/submodule-configuration) in the `/configuration` folder. {% content-ref url="fivem-installation/available-plugins" %} [available-plugins](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins) {% endcontent-ref %} ### 6. Configure the Auto-Updater 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. #### Whitelist Specific Files 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. #### Disable Automatic Updates To disable this auto-update entirely set `allowAutoUpdate` to `false` in the `config.json`. *** ## Resource Installation (Manual) ### 1. Download the ZIP Download the[ latest zip file from our Github.](https://github.com/Sonoran-Software/SonoranCADFiveM/releases) ### 2. Extract the ZIP File Extract the `.zip` file into your resources directory. Place the `[sonorancad]` folder directly in the resources root directory. ![Extract the zip file into your resources directory. Keep the \[sonorancad\] folder intact.](https://232668649-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M4pGN81fb4R6zFhodcu%2F-M7UpwbfX3an2xYPaw0h%2F-M7VOU4zuEp09qVuk9OT%2F2.png?alt=media\&token=78b8adf3-ef33-42f7-b0b7-a49a3c92bf9d) {% hint style="warning" %} 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. {% endhint %} ### 3. Configure and Rename Open `sonorancad\configuration\config.CHANGEME.json`, update the values, then save it as `config.json`. Default configuration is below: ```javascript { "communityID": "", "apiKey": "", "mode": "production", "postTime": 5000, "serverId": "1", "primaryIdentifier": "steam", "apiSendEnabled": true, "debugMode": false, "updateBranch": "master", "statusLabels": ["UNAVAILABLE", "BUSY", "AVAILABLE", "ENROUTE", "ON_SCENE"], "allowAutoUpdate": true, "autoUpdateUrl": "https://raw.githubusercontent.com/Sonoran-Software/SonoranCADLuaIntegration/{branch}/sonorancad/version.json", "allowUpdateWithPlayers": false, "noUnitTimer": false, "forceSetApiId": false, "enablePushEventForwarding": false, "pushEventForwardUrl": "https://host", "disableOverride": false, "bodycamEnabled": true, "bodycamBeepFrequency": 300000, "bodycamScreenshotFrequency": 2000, "bodycamPlayBeeps": true, "bodycamOverlayEnabled": true, "bodycamOverlayLocation": "top-right", "bodycamCommandToggle": "bodycam", "bodycamCommandChangeFrequncy": "bodycamfreq" } ``` #### Configuration Details
Configuration Options | Option | Description | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | communityID | Your SonoranCAD [Community ID](https://docs.sonoransoftware.com/cad/tutorials/getting-started/finding-your-community-id-and-authentication-code). | | apiKey | [API Key](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials) from your In-Game Integration settings. | | postTime |

Update locations every x ms. Default 5000.
It is recommend to not set this lower than 5000 ms due to rate limiting.

| | serverId | If using [multiple servers](https://docs.sonoransoftware.com/cad/tutorials/customization/configuring-multiple-servers) in Sonoran CAD, specify the ID here. | | primaryIdentifier |

The identifier type your community uses in the CAD to enter their API IDs.
Valid values are: license, steam, or discord.

| | apiSendEnabled | When disabled, the integration will not send any API requests to SonoranCAD. | | debugMode |

When set to true, useful debugging information it outputted to the console.
Keep disabled in production due to console spam.
This can be toggled by entering sonoran debugmode in console.

| | updateBranch |

Use this branch when checking for updates.
Keep master unless you know what you're doing.

| | statusLabels | Should match what you have set in your CAD's [unit status code](https://docs.sonoransoftware.com/cad/tutorials/customization/unit-status-codes) settings. | | allowAutoUpdate | When enabled, the resource will update itself. When disabled, it will simply show an update notification every 2 hours. | | autoUpdateUrl | Where to check for updated versions. Don't touch this unless you have a reason. | | allowUpdateWithPlayers | When enabled, it will run the updates even with players on the server. The updater will stop/start all associated resources which could cause client crashes. When disabled, the resource "waits" until there are no players. | | noUnitTimer | When set to `true`, the CAD will not check every minute for a current unit list. Should only be enabled for troubleshooting issues with the unit cache. | | enableCanary | When enabled, allows the CAD to update to beta (aka canary) releases. | | enablePushEventForwarding |

Enables push event forwarding to the specific URL defined in the next option.

NOTE: DO NOT ENABLE IF YOU DO NOT KNOW WHAT YOU ARE DOING (Used for custom development only!)

| | pushEventForwardUrl |

Web server URL to forward push events to.

NOTE: DO NOT ENABLE IF YOU DO NOT KNOW WHAT YOU ARE DOING (Used for custom development only!)

| | forceSetApiId | When enabled, the tablet resource will show an alert message stating they must set their API ID. | | disableOverride |

By default, the framework will try and automatically correct your server's IP, port, and outgoing IP address if it detects something different.

Set this to true to disable this functionality.

|
For information regarding the bodycam script config values, please see our [Bodycam Submodule Guide.](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/bodycam) ### 4. Server Config Add the following to your `server.cfg` (if you don't want pNotify or wraith, leave those out): ``` exec @sonorancad/sonorancad.cfg ``` {% hint style="danger" %} 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]` {% endhint %}
Advanced - Remove Tablet, pNotify, etc. Adding the `exec @sonorancad/sonorancad.cfg` starts multiple resources bundled with the download. If you wish to not use one or more of the resources (or with a different name) you will need to: * Copy/paste the contents of `sonorancad.cfg` to your `server.cfg` * Remove the `exec @sonorancad/sonorancad.cfg` line from your `server.cfg` Do not update the contents of `sonorancad.cfg` as it will be overwritten on resource updates.
{% hint style="success" %} Once completed please move to the [#additional-configuration](#additional-configuration "mention") section to complete your setup {% endhint %} ## Additional Configuration ### 1. Convar Overrides 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. {% hint style="warning" %} This feature does not work with arrays (like statusLabels). Any other configuration option can be set using the `sonoran_` format. {% endhint %} ### 2. Configure Push Events 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`. #### 2A. Admin Panel Configuration 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 [integrated live map](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/live-map). ![Sonoran CAD - Game Port](https://232668649-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4pGN81fb4R6zFhodcu%2Fuploads%2Fgit-blob-ff1bf4aade4859055a3c148fddcda99d24d9156b%2FSonoran%20CAD%20-%20Game%20Port.png?alt=media) Learn more about [configuring multiple servers](https://docs.sonoransoftware.com/cad/tutorials/customization/configuring-multiple-servers). #### 2B. Forward Push Events to an External Server 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. ### 3. Activating Submodules Check out our pre-bundled [submodule-configuration](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/submodule-configuration "mention")to make the integration useful.\ For basic functionality, we recommend at least the [`locations`](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/broken-reference), [`callcommands`](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/broken-reference), and [`postals`](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/broken-reference) submodules.\ You can also view our [standard submodule activation guide](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/submodule-configuration). ### 4. Using the wk\_wars2x Radar 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`. ### 5. Steam API Key If your framework has the `primaryIdentifier` set to `steam` in the [configuration ](#3.-configure-and-rename)(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 Then, paste it into your `server.cfg` ``` # Steam Web API key # If you want to use Steam authentication (https://steamcommunity.com/dev/apikey) # -> replace "" with the key set steam_webApiKey "YOUR_KEY_HERE" ``` ## Updates 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. ## Commands 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. | Command | Description | | ------------------- | ---------------------------------------- | | `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 | ## Troubleshooting ### Server Crashes 1\. Check to make sure `sonoran_updatehelper` or `[sonorancad]` is not being started in your server.cfg. {% hint style="danger" %} 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]` {% endhint %} 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 [here](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation/available-plugins/smart-signs) and overrideing the old files. {% hint style="info" %} We have gotten isolated reports of servers crashing with the following error, this is assumed to be related to having lower end VPS hardware specs and txadmin rebooting the server because the update process is taking too long. {% endhint %} ![](https://232668649-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4pGN81fb4R6zFhodcu%2Fuploads%2FiYOoSwyOqWL2pFWBEr04%2Fimage.png?alt=media\&token=1a127f66-f003-4552-907d-40fc0851c8ee) ### Warning: Could not find file X 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: ``` Started resource sonorancad (3 warnings) ^3Warning: Could not find file `html/config.js` (defined in fxmanifest.lua:16^7 ``` In this example, you would navigate to the `sonorancad` **resource**, open the `html` **folder** and ensure the **file** `config.js` is present. {% hint style="info" %} This is simply a **WARNING**, if the resource works **AS EXPECTED**, you can simply ignore the warning and continue {% endhint %}