-
Notifications
You must be signed in to change notification settings - Fork 10
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: true
ListenToChannelChat: true
ListenToPrivateMessages: true
AllowLinksInMessages: true
# Can be either 'server', 'channel' or 'none'
SendChatToTeamspeak: none
# Can only be true or false
LogChatInConsole: true
# Default reason for bans and (channel) kicks
DefaultReason: '-'
# The priority of the chat listener.
ChatListenerPriority: MONITOR
# Debug Mode
# Use if the plugin doesn't work at all
# Or for posting error logs in the forum
Debug: false
teamspeak-commands:
# Please read the documentation before enabling TS commands!
Enabled: false
# The prefix to be used for TS commands. / is used by TeamSpeak itself unfortunately.
CommandPrefix: '!'
# Controls whether teamspeak commands are logged
LogTeamspeakCommands: true
# How many milliseconds should be waited before sending messages to the client on Teamspeak
# The buffer lets individual messages queue up and then sends them all as one message.
MessageBufferDelay: 50
main:
TeamSpeakIp: 1.2.3.4
### TeamSpeakPort
TeamSpeakPort: 9987
You can use virtual server IDs as well, but you need to make the ID negative so the plugin recognizes it as the ID and doesn't confuse it with the port number.
TeamSpeakPort: -550 # Using a virtual server ID
### QueryPort
QueryPort: 10011
### QueryUsername and QueryPassword
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. You don't need to log in with your SuperAdmin ServerQuery!
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: TeamspeakNickname: Minecraft
<12:34:56> "Minecraft": [Miner1234] Hi TS!
### ConsoleName
ConsoleName: '&9Server'
e.g: ConsoleName: Console
<12:34:56> "Minecraft": [Console] I'm just testing this plugin!
### ChannelID
ChannelID: 0
Channel with the ID 0 is always the server's default channel.
You can also set the ChannelID from in-game with the /tsa set command. There you don't even need to know the channel's ID, but only its name.
### ChannelPassword
ChannelPassword: ''
Note that when you use a ServerQuery that was created by a client who has access to all channels even without the password, BukkitSpeak won't need a password to enter those channels either.
If you don't know the password or simply forgot to enter it here, BukkitSpeak won't be able to connect to the channel.
### ListenTo...
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 commands /ts chat and /ts reply.
- 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 or /ts reply.
- Sends you a message if there was a reply to your private message.
- This will not publish your private TS3 messages, it only allows Minecraft users to send private messages to TS clients and lets them receive their responses.
### AllowLinksInMessages
AllowLinksInMessages: true
### SendChatToTeamspeak
SendChatToTeamspeak: none
none
, channel
or server
.
If you set it to channel
, all Minecraft messages will be sent to the channel BukkitSpeak is listening to (the one set by ChannelID). If it's set to server
, the messages will be broadcasted on the Teamspeak server.
### DefaultReason
DefaultReason: '-'
### LogChatInConsole
LogChatInConsole: true
### Chat Listener Priority
ChatListenerPriority: MONITOR
By default, with ChatListenerPriority set to MONITOR
BukkitSpeak will ignore all cancelled messages.
You can set it to another EventPriority so BukkitSpeak will listen to the event at another priority and thus "ignore" the changes made after that time.
Read more about event priorities on the Bukkit Wiki.
### Debug mode
# Debug Mode
# Use if the plugin doesn't work at all
# Or for posting error logs in the forum
Debug: false
Teamspeak commands let you execute commands on the Minecraft server remotely from TeamSpeak.
You can read a detailed manual on how TeamSpeak commands work and how they are set up here.
Enabled: false
Controls whether Teamspeak commands are enabled or not.
Creates a new file called permissions.yml when set to true.
# The prefix to be used for TS commands. / is used by TeamSpeak itself unfortunately.
CommandPrefix: '!'
Lets you choose a different prefix for TeamSpeak commands.
As the description already states, the /
character is already used by the TeamSpeak client itself.
You can also choose a prefix longer than 1 character, for exapmle CommandPrefix: '!?'
.
# Controls whether teamspeak commands are logged
LogTeamspeakCommands: true
When set to true, there will be a message in the console saying that client X executed command Y from Teamspeak.
There will also be a message if the client failed executing a command because of lacking permissions, a not whitelisted plugin or a blacklisted command.
# How many milliseconds should be waited before sending messages to the client on Teamspeak
# The buffer lets individual messages queue up and then sends them all as one message.
MessageBufferDelay: 50
This value controls after how many milliseconds the message buffer is sent to TeamSpeak.
The buffer will wait for that amount of time after a first response was received, then all of the messages get sent at once.
This buffer should help to reduce the amount of network bandwith consumed by BukkitSpeak and will also make the messages appear faster.
You can also set the delay to 0
to disable it, however this is not recommended.
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.
If you just leave a config set to ''
, the message won't be sent at all.
What messages are sent if something happens on the TeamSpeak server.
TeamspeakEvents:
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.
%client_country% - The client's guessed country.
%connection_client_ip% - The IP of the client.
%client_platform% - The client's OS. Just for fun :)
Defines how TeamSpeak messages are displayed in Minecraft.
TeamspeakMessages:
ServerMessage: '&4&l%msg%'
ChannelMessage: '&4&l[%player_displayname%&4] &r%msg%'
PrivateMessage: '&4&l[%player_displayname%&4] &r%msg%'
PokeMessage: '&l[%player_displayname%] &r%msg%'
KickMessage: '[%player_displayname%] kicked you from the server for %msg%.'
ChannelKickMessage: '[%player_displayname%] kicked you from the channel for %msg%.'
BanMessage: '[%player_displayname%] banned you from the server for %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.
This section defines what messages are sent to the TS3 server if a player joins, chats or quits.
The chat message is only required if SendChatToTeamspeak
is set to either channel
or server
. If someone sends a message to the TS server using /ts chat
, the layout from ChannelMessage
will be used.
MinecraftEvents:
ChatMessage: '&l%player_displayname%&r: %msg%'
LoginMessage: '&l%player_displayname%&r logged in.'
LogoutMessage: '&l%player_displayname%&r logged out.'
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 ChatMessage:
%msg% - The message, obviously.
How command messages look like in Minecraft.
MinecraftCommandMessages:
OnlineList: '&aCurrently online: &e%list%'
ChannelList: '&aCurrently in the channel: &e%list%'
Mute: '&aYou are now muted.'
Unmute: '&aYou aren''t muted anymore.'
ChannelChange: '&aYou are now talking in the TeamSpeak channel &6%channel%&a.'
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%'
Poke: '&e%player_displayname% &apoked &e%target%&f: %msg%'
Kick: '&e%player_displayname% &akicked &e%target% &afrom the server for &e%msg%&a.'
ChannelKick: '&e%player_displayname% &akicked &e%target% &afrom the channel for &e%msg%&a.'
Ban: '&e%player_displayname% &abanned &e%target% &afor &e%msg%&a.'
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% - The list of client names.Only Broadcast, Chat, Pm, Poke, Kick, ChannelKick and Ban:
%msg% - The message, or the kick / ban reason.Only Pm, Poke, Kick, ChannelKick and Ban:
%target% - The user on TeamSpeak who receives that private message or got poked, kicked or banned.