Setup Guide for VatsimSync




READ:

This document is only for the TeamSpeak version of VatsimSync. To set it up on Discord click here to invite the Bot. Once it's in the server, make sure you have a role with the "Administrator" permission, and type ".setup", and follow it's questions.


Configuration File(s)

"config.properties":

Prevent using the '=' symbol in any of the fields. The bot uses Java Properties files, and = signifies the value of a property.

If a line begins with a rating (ie STUDENT1 or INSTRUCTOR3) you need to enter the Group ID of the group you want that rating to assign. (If the group name is "Student 1 (52)" the Group ID would be 52.)

"SERVER_QUERY_USERNAME": The username of the ServerQuery account you want the bot to use (usually "ServerAdmin" is the default if you have not modified it.)
"SERVER_QUERY_PASSWORD": The password of the ServerQuery account you want the bot to use.
"SERVER_QUERY_PORT": The ServerQuery port for your TeamSpeak server (usually 10011 unless changed).
"SERVER_QUERY_HOST": The IP Address (or hostname) of your TeamSpeak server.
"SERVER_VIRTUAL_SERVER_ID": The TeamSpeak Virtual Server ID (usually 1 unless you have multiple TeamSpeak servers).
"SERVER_BOT_NICKNAME": The nickname you want the bot to use. This is the name the messages would be received from.
"SERVER_DEFAULT_ROLE": The Group ID of the group you want assigned to Vatusa Controllers (put 0 to disable).
"ARTCC_ASSOC": (true/false) Enables or disables "Home ARTCC" assocations.
"ARTCC_SHORTNAME": THe shortname of your ARTCC (For example, ZME).

"vatusa.properties":

If you want to not assign a specific ARTCC a group, put the Group ID as "0". Otherwise specify the ID of the group you want assigned to each ARTCC. Both "ARTCC_ASSOC" and "ARTCC_SHORTNAME" must be enabled, and have a value set in the "config.properties" for this to work.


Should you have any questions regarding this file, send me an email @ admin@vatsimsync.com