Framework Installation

Sonoran CAD's plugin framework imports common API method wrappers and functionality. Installing our integration framework is easy! Learn more below.

ll Sonoran CAD integration plugins require the standard version of Sonoran CAD or higher. For more information, see our pricing page.

Looking for VPS, web, or dedicated hosting? Check out our official server hosting! Sonoran Servers customers receive free plugin installation and 30% off their monthly CAD subscription!

Installation Video

View our installation tutorial video for help on installing our framework.

Installation Guide

1. Download Release

Download the latest zip file from our Github.

2. Extract

If you already have pNotify or the wk_wars2x resource, remove them from your resources folder and use the Sonoran CAD plugin version.

3. Configure and Rename

Open sonorancad\config.CHANGEME.json, update the values, then save it as config.json. Default configuration is below:

{
    "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

Option Description

Option	Description
communityID	Your SonoranCAD Community ID.
apiKey	API Key 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 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 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.

communityID

Your SonoranCAD Community ID.

apiKey

API Key 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 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 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 Plugin guide.

4. Server Config

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]

ensure pNotify
ensure wk_wars2x
ensure sonorancad
ensure tablet

# permissions for auto-updater (REQUIRED)
add_ace resource.sonorancad command allow
add_ace resource.sonoran_updatehelper command allow

4.5. 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.

This feature does not work with arrays (like statusLabels). Any other configuration option can be set using the sonoran_<configSettingHere> format.

5. 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.

5A. 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.

Learn more about configuring multiple servers.

5B. 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.

6. Installing Plugins

Check out our Available Plugins to make the integration useful. For basic functionality, we recommend at least the locations, callcommands, and postals plugins. You can also view our standard plugin installation guide.

7. 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.

8. Steam API Key

If your framework has the primaryIdentifier set to steam in the configuration (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 http://steamcommunity.com/dev/apikey

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 plugins 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 plugins, and more.

Command Description

Command	Description
`sonoran help`	Display list of commands
`sonoran update`	Run core/framework updater
`sonoran pluginupdate`	Run plugin updater
`sonoran plugin <name>`	Display information about a plugin
`sonoran debugmode`	Toggle debug mode on/off
`sonoran info`	Dump version info and configuration data
`sonoran support`	Dump information for support staff

sonoran help

Display list of commands

sonoran update

Run core/framework updater

sonoran pluginupdate

Run plugin updater

sonoran plugin <name>

Display information about a plugin

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.

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]

2. Try updating your smartsigns plugin manually to the latest version. This is done by copying over the lua files from the latest release found here and overrideing the old files.

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.

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.

This is simply a WARNING, if the resource works AS EXPECTED, you can simply ignore the warning and continue

PreviousIn-Game Integration Plugins NextPlugin Installation

Last updated 9 days ago