✓ PolyBot [TeamSpeak 3 Bot] [1.8 - 1.13.2] [Spigot/Bungee] [Proxy detection/Geofence] [Sourcecode!] 0.9.4.1

Native Minecraft Version:
1.13
Tested Minecraft Versions:

• 1.8
• 1.9
• 1.10
• 1.11
• 1.12
• 1.13

Donation Link:
http://paypal.me/bhk410
Now at the price of a kebab!
Link up your Spigot OR Bungee Server with your Teamspeak Server!
Java 8 required.
Sourcecode available upon request on GitLab.

• Works on your Bungee AND on your Spigot Server - the same! But only install it on EITHER of both!
• Link your Minecraft Account with a (single) Teamspeak Identity (only one is allowed) - Works with a "captcha" type of thing you need to message the bot with if connected with multiple accounts with the same IP
• Command to get an invitation link to your teamspeak server (via teamspeak.com)
  
• Have the Bot set a users description containing their Minecraft username and UUID
  
• Have the Bot set a users Icon representing the linked players skin face
• Define a support channel and notify your server team whenever a player needs support - in Teamspeak and in game!
• Synchronize your players permissions with certain Teamspeak server groups
• Have the bot move your inactive users to a declared AFK Channel; Once they are back, they will be moved to were they previously were!
  
• UNIQUE!: You can view the channel you are currently in from in game in the scoreboard! It can display who is talking, who is muted, recording and channel name!
• Store your link data in YML or MySQL!
• Convert your links from .yml to your database or from your database to a .yml file!
• See what features are enabled with /tsstatus! Also useful for finding various misconfigurations and potential error sources.
  
• More Features are planned for the future!

Commands for Minecraft:

• /ts Main command - without arguments, you will receive the TS invitation link specified in the config
• /link Link your Minecraft account with a Teamspeak identity, some actions require a link
• /unlink Unlink your Minecraft account from the linked Teamspeak identity
• /ts scoreboard or /ts sb Activate the in game Teamspeak overlay
• /ts cmd Open a dialogue on teamspeak between you and the bot so you can send teamspeak commands
• /ts status See a status overview over your bot. Includes potential misconfigurations. An error occuring when executing this commands indicates that your permissions are not properly set up.
• /tsreconnect Force attempts to reconnect to your teamspeak server.

Commands for Teamspeak:

• !help List all available commands as well as a description
• !channelid Get the channel ID for the channel you are currently in

• ts3bot.use To use the /ts3bot command (as well as /ts3 and /ts)
• ts3bot.link To use the /link command
• ts3bot.unlink To use the /unlink command
• ts3bot.scoreboard To use the in game overlay
• ts3bot.supportnotify To get notified whenever a user in teamspeak is in your Support Channel
• ts3bot.tsstatus To use the /tsstatus command
• ts3bot.tsreconnect To use the /tsreconnect command
• ts3bot.tsinit To use the /tsinit command

IMPORTANT: The Bot will work best if you use unlimited-floodrate, which is disabled by default. To enable this feature, you are required to either run your Teamspeak on the same (virtual) server so it can connect with localhost, or you have to add your Minecraft Server's IP to the "query_ip_whitelist.txt" of your Teamspeak 3 Server. Otherwise the TS3 will automatically ban the bot if this setting was enabled without this. I do not recommend to run this bot with unlmited-floodrate set to false, though it is possible.

Permissions required on teamspeak:




Steps required to first do on your teamspeak server:

1. Click on "Tools" in your toolbar, select "Identities" and create a new one with the bottom left button.
2. Connect to your TS3 Server with that new Identity and assign it the highest privileges it can have (depending on what you need, for example if you don't want it to set/remove server groups, that permission would not be necessary, however it should have b_client_ignore_antiflood to true, if you want a fast bot)
3. With the new identity, create a ServerQuery Login. Click on "Tools", then on "ServerQuery Login" and enter a username, you will get a password from your server in the next step. You need that password later!

Setup connection:

1. Drop the .jar-File into your plugins folder in either Bungee or Bukkit.
2. (Re)start your server
3. Open the config.yml created in your plugins/TS3Bot folder
4. Enter the IP address of your server in bot -> host
   You should enter an IP address rather than a hostname.
   
5. Enter the ServerQuery Login: put the username you chose after 'login-name' and the password you got after 'login-password'
6. By default, you want to keep the 'virtual-server' value at 1. If you are renting a teamspeak server, ask your host provider what the virtual-server ID of your server is. This value goes to 'virtual-server'.
7. You can choose a nickname for your bot. It won't be visible in the channel structure, but it's name can be read when the bot messages someone or changes someones servergroups.
8. Save the config.yml, and restart once again - the bot should now connect.

Setup MySQL database connection:

1. Open the bots config.yml in plugins/TS3Bot and edit the first line to "storage-method: mysql"
2. (Re)start your server
3. Open the newly created database.yml in plugins/TS3Bot, and enter your database connection - The bot will create a single table, you can set the name of the table to be created with the field 'table-name'.
4. (Re)start your server, the database should now connect
   
5. If you have existing linked accounts in a .yml file, you can easily export them to your database with a single command: /linkconvert mysql
6. If you want to import links from your database to a .yml file, use /linkconvert yml

Setup your link configuration:

1. Click on "Permissions" in your toolbar and select "Server Groups" for an overview - Create a group you want to have assigned to players who link their Minecraft account with teamspeak if you have none
2. Write down or remember the Server Groups "Group ID":
   
   
   The number in the brackets
   
3. Open the bots config.yml in plugins/TS3Bot and go to the 'link' section (line 20 by default) and edit 'servergroup-id' to fit the value of the servergroup you want to give to linked players
4. By default, the bot will (if permitted by it's server group) change the players face icon (with overlay). Set 'set-player-head-icon' to false to disable this feature.
5. By default, the bot will (if permitted by it's server group) change the players description to whatever is given in 'description.format'. You can user <player> for the player's in game name and <uuid> for the player's in game UUID.
6. When a player unlinks his account, you can specify if the bot should remove the player's "link group" (specified under point 3) and whether it should remove the player's icon.

Setup your /ts command invitation:

1. Customize the message sent by the bot under 'ts.invite.message'.
2. Enable or disable the tooltip you get when you hover over the message
3. Set whether you want the message to be a clickable link
4. Enter your server password in 'password' (you can leave it 'password' if you have no password)
5. 'click-link' specifies the link the user will be redirected to when he clicks the (clickable) message. This must always start with http:// or https://!
   <host> will be replaced with where the bot connects to
   <port> will be replaced with what port you set at 'ts.invite.port'
   <password> will be replaced with what password you set at 'ts.invite.password'

Setup your Support Channel:

1. In Teamspeak: Switch to the channel you would like to set as your support channel
2. In your toolbar, click on "Permissions" and select "Server Groups"
3. Create a group for your server staff that should get notified when a player needs support. Note down the server group ID:
   
   
   The number in the brackets
4. In Minecraft: Type /ts cmd (requires a link!!) to open a dialogue between you and the bot
5. In Teamspeak: In the private message dialogue, type !channelid, the bot will then tell you the channel ID of the channel you are currently in
6. In your config.yml in plugins/TS3Bot set 'supportchannel.channel-id' from -1 to whatever answer you got from the bot.
7. Set 'notify-group' to the group ID of the group that should be notified - users in that group will not trigger the support message
8. Set 'enabled' to true

Setup your AFK Channel:

1. In Teamspeak: Switch to the channel you would like to set as your afk channel
2. In Minecraft: type /ts cmd (requires a link!!) to open a dialogue between you and the bot
3. In Teamspeak: In the private message dialogue, type !channelid, the bot will then tell you the channel ID of the channel you are currently in
4. In your config.yml in plugins/TS3Bot set 'afkchannel.channel-id' from -1 to whatever answer you got from the bot.
5. Configure your desired AFK times (once a user's idle time is above the set value, he or she will be moved to the afk channel).
   afk-time-seconds: max. AFK time for users whose headphones aren't muted and who aren't flagged away
   afk-time-seconds-muted: max. AFK time for users whose headphones are muted and who aren't flagged away
   afk-time-seconds-away: max. AFK time for users who are flagged away
   
6. Set 'enabled' to true

Setup your Servergroup Synchronizer (Servergroup Updater):

1. Set 'enabled' to true
2. Adapt 'interval-seconds' to a value you feel comfortable with (every X seconds, the updating task will iterate over all players and update their groups)
3. Add as many permission nodes as you like. It's important that you follow the syntax:
   - 'permissionNode : serverGroupID'
   As given in the example nodes. Players who have that certain node will be added to that certain group, whilst players without that certain node will be removed from that group.

Setup the in game TS Overlay aka ChannelScoreboard:
This does send a lot of commands through the query. It's not recommended if the bot is not allowed to 'spam' commands. This is only recommended with unlimited-floodrate, but do not enable this except your Spigot/Bungee are running on the same server as your teamspeak, or only enable this when your Spigot/Bungee server is in your Teamspeak server's QueryIPWhitelist.txt file. You can use it, at a lower frequency though, which lets the overlay appear slow and unresponsive. You can, however disable the "who is talking" feature completely by setting active and normal to the same string value.
Warning: Using unlimited-floodrate when your server is not in the QueryIPWhitelist.txt file, it will get the bot banned very fast. If you do not host your teamspeak server yourself, ask your hoster if he could add the IP of your minecraft server to the query-ip-whitelist.txt.

1. Adapt the value of 'scoreboard-update-ticks' (line 3) to any value you feel comfortable with. Note that lower values will send a lot more commands, but the overlay will appear much more smooth. Any value of 20 and above is recommended without unlimited-floodrate.
   
2. Adapt the Symbols. Set 'active' equal to 'normal' if you do not use unlimited-floodrate.

Additional information:
If your created config.yml contains weird symbols, this is because special characters were used. Here you can see the original values:
prefix: '&3TS3Bot &7» &r'
In ts.scoreboard.symbols: This ⬤ 'BLACK LARGE CIRCLE' (U+2B24) was used.
Skin Icons are fetched with https://crafatar.com/