Skip to content

Configuration

Jump to bottom
Firedroide edited this page Apr 22, 2012 · 28 revisions

Configuration

Main section

main:
  TeamSpeakIp: 1.2.3.4

The IP of the TeamSpeak3 server.

  TeamSpeakPort: 9987

The port used by the TeamSpeak server.
Usually, this is 9987, else you can find out by what URL you're typing in when connecting to the server.

  QueryPort: 10011

The port BukkitSpeak communicates with the TeamSpeak Query.
By default this is 10011. If you don't know the Query port, first try the default one.
If that doesn't work, ask the server admin.

  QueryUsername: admin
  QueryPassword:'123456'

BukkitSpeak and the Server Query need a username and a password to establish a connection.

You can generate a username and a password on your own, but you need to have the permission on the TeamSpeak server. Otherwise, the admin of the TS server should be able to do that for you.

Open your TS3 client and connect to your server. Now go to Tools > Server Query Login and a window will pop up. You need to enter a name (it shouldn't contain any spaces though) and click enter. A password will be generated for you. The name you chose doesn't effect the name of BukkitSpeak in TeamSpeak, so you can chose whatever you want. After generating the password, just copy the name and the password into the config.

TeamSpeak section

teamspeak:
  BroadcastNickname: Minecraft

The name of BukkitSpeak when sending a messages in TeamSpeak.

e.g: BroadcastNickname = Minecraft

<12:34:56> "Minecraft": [Miner1234] Hi TS!

  ConsoleName: '&9Server'

When you send a command like ts chat, ts broadcast or ts pm, this will be the sender name.

e.g: ConsoleName = Console

<12:34:56> "Minecraft": [Console] I'm just testing this plugin!

  ChannelID: 0

Can only be an Integer. Specifies which channel BukkitSpeak should listen to. You can find out the channel ID by selecting the channel you want in your TeamSpeak Client. In the info section in the top right corner, there is the channel name. After the channel name, there is a number in brackets. That's your channel ID.

Channel with the ID 0 is always the server's default channel.

  ChannelPassword: ''

If your channel has a password, you need to set it here.
If the channel doesn't have a password, just leave it empty.

If you don't know the password or simply forgot to enter it here, BukkitSpeak won't be able to connect to the channel.

  ListenToServerEvents: true
  ListenToServerBroadcasts: true
  ListenToChannel: false
  ListenToChannelChat: false
  ListenToPrivateMessages: false

Can only be true or false. These values are used to enable or disable almost all of BukkitSpeak's functions:

  • ListenToServerEvents

    • Makes BukkitSpeak send messages when somebody joins or leaves the TeamSpeak server.

  • ListenToServerBroadcasts

    • Sends a message in Minecraft when somebody broadcasts a message in TeamSpeak
    • Enables the command /ts broadcast.

  • ListenToChannel

    • Sends messages when somebody joins or leaves the channel set by ChannelID.

  • ListenToChannelChat

    • Sends messages when somebody sent a chat message in the channel set by ChannelID
    • Enables the command /ts chat.

  • ListenToPrivateMessages

    • Allows you to send private messages to somebody on TeamSpeak by using /ts pm target
    • Sends you a message if there was a reply to your private message.
  AllowLinksInMessages: true

This value can be used to toggle whether users can have links in their messages or not.
If this is true, the links will also automatically be formatted so they're clickable.
If this is false, all links will just be removed.

  SendChatToTeamspeak: none

Can be either none, channel or server. If you set this value to anything except none, BukkitSpeak will convert all chat messages sent by players and send them in TeamSpeak.

Messages section

Here you can set how the BukkitSpeak messages should be displayed in Minecraft.
You can set colors by writing '&' and a hexadecimal character (0 - 9, a - f) afterwards.
You can also make your text bold (&l), underlined (&n) or italics (&o).
For further information about color codes, click "here":http://www.minecraftwiki.net/wiki/Color_codes#Color_Codes.

Events section

  events:
    Join: '&e%client_nickname% &ahas joined TeamSpeak'
    Quit: '&e%client_nickname% &ahas left TeamSpeak'
    ChannelEnter: '&e%client_nickname% &aentered the channel.'
    ChannelLeave: '&e%client_nickname% &aleft the channel.'
    ServerMsg: '[&cTS&f] &e%client_nickname%&a: %msg%'
    ChannelMsg: '&e%client_nickname%&f: %msg%'
    PrivateMsg: '&e%client_nickname% &a-> &eMe&f: %msg%'

Applicable keys:

%client_nickname% Who raised the event. Doesn't have any colors.

Clone this wiki locally