sna-sync

This allows a player to interact with several SnailyCAD features in-game. This integration is actively worked on with new features being added frequently.

Available Commands

Command	Description
/sn-auth	Authenticate with your SnailyCAD instance using your Personal API Token. (CAD -> Account -> API Token)
/sn-whoami	See what user you're currently authenticated as.
/sn-active-unit	See your active unit's name & id.
/sn-set-status	Set the status of your active unit.
/sn-panic-button	Toggle the panic button state of your active unit.
/sn-attach	View active 911 calls and assign/unassign yourself to/from a 911 call.
/sn-attach <case-number>	Attach yourself to a 911 call with the provided case number.
/sn-traffic-stop <description>	Create a 911 call (traffic stop) with location and unit automatically attached.

Installation

1. Download the latest release from the releases tab. Make sure to only download the .zip files
2. Create a [sna] folder to orginize all your SnailyCAD integrations.
3. Extract the .zip file into the [sna] folder.
4. Add the following to your server.cfg file:

ensure sna-sync

Configuration

To configure this integration, simply add the following to your server.cfg file:

tip

If you already did this for a different SnailyCAD integration, you don't have to do it again.

warning

The following lines must be added to your server.cfg file before all SnailyCAD integrations.

setr snailycad_url "http://api.example.com/v1"
set snailycad_api_key "XXXXXX"
setr snailycad_use_postal "true"
set snailycad_player_leave_auto_off_duty "false"

Setting	Description	Required?	Default
snailycad_url	The URL to your SnailyCAD API. (Example: https://cad-api.mycommunity.com/v1)	Yes	-
snailycad_api_key	The global API key to your SnailyCAD API. (CAD -> CAD Settings -> API Token)	Yes	-
snailycad_use_postal	Whether or not to use the postal code when creating calls (Tow, Taxi, 911)	No	"false"
snailycad_player_leave_auto_off_duty	Whether to automatically set a unit off-duty when they leave the server.	No	"false"