Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 5.99 KB

teamspeak-3.md

File metadata and controls

88 lines (58 loc) · 5.99 KB
description
The TeamSpeak 3 integration plugin requires that users must be logged into the CAD police, fire, EMS, or Dispatch page in order to access specific voice channels.

TeamSpeak 3

{% hint style="warning" %} This plugin utilizes API endpoints that require the plus version of Sonoran CAD or higher. For more information, view our pricing page. {% endhint %}

{% hint style="success" %} Looking for VPS, web, or dedicated hosting? Check out our official server hosting! {% endhint %}

Installation Guide

1. Download and Install the Framework

If you haven't already, be sure to install and configure the plugin framework first.

2. Download the Plugin and all Dependencies

  1. Click HERE to download the TS3 integration plugin .zip file.

3. Install the Plugin and all Dependencies

  1. Follow the standard plugin installation guide for the TeamSpeak3 plugin.

4. Configure your TeamSpeak Connection

Your TeamSpeak server credentials can either be set in the config or as convars in your server.cfg file. In the config_ts3integration.json file, you can modify the following settings:
ts3server_host TS3 Public Server IP
ts3server_port

Public connection port

Default is 9987
ts3server_qport

Sever Query Port

Default is 10011
ts3server_user

Typically, this will be your server admin username.

If you do not have one, you can create a new one.
ts3server_pass

Typically, this will be your server admin password.

If you do not have one, you can create a new one.
onduty_servergroup

Name of the server group that the plugin will grant users when they're on duty.

You will need to configure this server group with permissions to join specific channels, etc.
enforced_channels A list of channels that units will be kicked from if they log out of the CAD
logoutGraceTime

The amount of time between the user logging out of the CAD and being kicked from the TS3 enforced_channels.

This prevents brief internet disconnections from the CAD from continually kicking users out of their channel.

TS3 - Integration Config

5. Retrieve Your Individual TS3 ID

Every member from your community will need to retrieve their unique TS3 ID.
This is found in TS under Tools > Identities > Default > Unique ID

TS3 - Retrieve your unique ID

6. Add your TS3 ID as an API ID

Paste in this TS3 unique ID as a new API ID in the CAD.

{% hint style="warning" %} Every member of your community will need to add their unique ID to their CAD account in your community. {% endhint %}

API ID - Paste New ID

7. Utilize the TS3 Integration

Once configured, when the user joins the TS3 server they will be granted the onduty_servergroup once they sign into the police, fire, EMS, or dispatch page.

Signing out of or exiting the CAD will result in the user being kicked from any of the enforced_channels from the config.

TS3 - Server Group Granted

TS3 - Channel Kicked

Advanced Configuration

You may utilize convars in your server.cfg if you wish to store your TS3 connection info there instead. There is no default version of these convars preset. If you wish to use convars in your server.cfg instead of your config file please LEAVE ts3server_user BLANK in your config file. Convars are as follows:

Convar Name Config Equivelant
sonorants3_server_host ts3server_host
sonorants3_server_port ts3server_port
sonorants3_server_qport ts3server_qport
sonorants3_server_user ts3server_user
sonorants3_server_pass ts3server_pass

They can be set in your server.cfg following the format of set [convar] "value"