Configuration
Klick the config line you want to know more about!
(Or just scroll down and find what you're looking for)
main:
TeamSpeakIp: 1.2.3.4
TeamSpeakPort: 9987
QueryPort: 10011
QueryUsername: admin
QueryPassword: '123456'
teamspeak:
TeamspeakNickname: Minecraft
ConsoleName: '&9Server'
# Only required if you use the channel functions!
ChannelID: 0
ChannelPassword: ''
# Can only be true or false
ListenToServerEvents: true
ListenToServerBroadcasts: true
ListenToChannel: false
ListenToChannelChat: false
ListenToPrivateMessages: false
AllowLinksInMessages: true
# Can be either 'server', 'channel' or 'none'
SendChatToTeamspeak: none
# Default reason for bans and (channel) kicks
DefaultReason: '-'
main:
TeamSpeakIp: 1.2.3.4
TeamSpeakPort: 9987
QueryPort: 10011
QueryUsername: admin
QueryPassword:'123456'
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:
TeamspeakNickname: Minecraft
e.g: BroadcastNickname = Minecraft
<12:34:56> "Minecraft": [Miner1234] Hi TS!
ConsoleName: '&9Server'
e.g: ConsoleName = Console
<12:34:56> "Minecraft": [Console] I'm just testing this plugin!
ChannelID: 0
Channel with the ID 0 is always the server's default channel.
ChannelPassword: ''
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
-
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
.
- Sends messages when somebody joins or leaves the channel set by
-
ListenToChannelChat
- Sends messages when somebody sent a chat message in the channel set by
ChannelID
- Enables the command /ts chat.
- Sends messages when somebody sent a chat message in the channel set by
-
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
SendChatToTeamspeak: none
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.
DefaultReason: "-"
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.
What messages are sent if something happens on the TeamSpeak server.
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.
How command messages look like.
commands:
OnlineList: '&aCurrently online: &e%list%'
ChannelList: '&aCurrently in the channel: &e%list%'
Mute: '&aYou are now muted.'
Unmute: '&aYou aren''t muted anymore.'
Broadcast: '&e%player_displayname% &a-> &f[&cTS&f]&f: %msg%'
Chat: '&e%player_displayname% &a-> &eTS&f: %msg%'
Pm: '&eMe &a-> &e%target%&f: %msg%'
Applicable keys:
%player_displayname% - The player's name as it's displayed in Minecraft. May contain colors.
%player_name% - The raw player name, without any colors or nicknames or anything.Only OnlineList and ChannelList:
%list% - A list of names.Only Broadcast, Chat and Pm:
%msg% - The message :)Only Pm:
%target% - The user on TeamSpeak who receives that private message.
How messages look like in TeamSpeak.
teamspeak:
ServerMessage: '&4&l%msg%'
ChannelMessage: '&4&l[%player_displayname%&4] &r%msg%'
PrivateMessage: '&4&l[%player_displayname%&4] &r%msg%'
MinecraftMessage: '&l%player_displayname%&r: %msg%'
Applicable keys:
%player_displayname% - The player's name as it's displayed in Minecraft. May contain colors.
%player_name% - The raw player name, without any colors or nicknames or anything.
%msg% - The message, obviously.Only PrivateMessage:
%target% - The user on TeamSpeak who receives that private message.