Framework Installation

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

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

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

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):

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.

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.

Troubleshooting

Server Crashes

1. Check to make sure sonoran_updatehelper or [sonorancad] is not being started in your server.cfg.

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.

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.