Getting the plugin to work

How to get it to work?!?

Step 1

Find out the IP and the 'normal' Port your TeamSpeak server uses. You should get something like 123.132.213.231:12345

Step 2

Now, everything before the colon, that's your IP, the number after it, that's the port.
You need to put the IP and the port into the configuration.
BukkitSpeak's configuration file is located at \plugins\BukkitSpeak\config.yml. You'll need to add the IP to main.TeamSpeakIp: and the port tomain.TeamSpeakPort:. In this case, the file would look like that:

main:
  TeamSpeakIp: 123.132.213.231
  TeamSpeakPort: 12345

Step 3

Now you need the TeamSpeak Query port. You can find that out by yourself if you are the owner of the TS server, the used Query port should be set somewhere in the configuration. Else, you need to ask the TS owner about that port.

Step 4

Generate a Query username and password, or let one be generated for you.

To do that, go to Settings > Server Query Login and just enter a name. A password will be generated for you. The name you chose doesn't effect the name of BukkitSpeak is shown in TeamSpeak, so you can chose whatever you want. After generating them, just copy the name and the password into the config.

Step 5

Test if BukkitSpeak works!
If there are any console errors, there will also be a message what could have gone wrong.

If you'd now like to change the way BukkitSpeak behaves, you'll need to change the settings in the teamspeak: part of your config file. This part of the configuration file is documented here.

And if you want to change how all these messages look, be sure to change the config settings in the messages part. You can use color codes and other placeholders for things like the player name, which you can look up here.