-
Notifications
You must be signed in to change notification settings - Fork 10
Command Reference
Index
- Help Command
- List Command
- Mute Command
- Broadcast Command
- Chat Command
- PM Command
- Reply Command
- Poke Command
- Info Command
- Admin Help Command
- Ban Command
- Kick Command
- Channel Kick Command
- Set Command
- Status Command
- Reload Command
Introduction
Parameters in parentheses (()) are optional whereas parameters in angle brackets (< >) are required.
User commands
Help Command
Shows the BukkitSpeak command help. Only shows those commands the user has permissions for.
/ts
/ts help
bukkitspeak.commands.help
List Command
Shows a list of clients who are currently on TeamSpeak.
You can change the message by editing messages.MinecraftCommandMessages.ClientList in the locale file.
If you add channel after the command, it will only show those clients who are in the channel BukkitSpeak is listening to.
/ts list (channel)
bukkitspeak.commands.list
messages.MinecraftCommandMessages.OnlineList
Mute Command
This command mutes or unmutes BukkitSpeak for you so you won't receive any messages.
This command does not mute people on TeamSpeak, nor will it mute other players.
/ts mute
bukkitspeak.commands.mute
messages.MinecraftCommandMessages.Mute
messages.MinecraftCommandMessages.Unmute
Broadcast Command
This command broadcasts a message on TeamSpeak that can be seen by everybody.
It appears in the leftmost tab of your TeamSpeak client, which is used for server messages and notifications.
/ts broadcast <message>
bukkitspeak.commands.broadcast
messages.MinecraftCommandMessages.Broadcast
(Controls how the broadcast is shown in Minecraft)
messages.TeamspeakMessages.ServerMessage
(Formats the message on Teamspeak)
Chat Command
The Chat command sends a channel message to TeamSpeak.
/ts chat <message>
bukkitspeak.commands.chat
messages.MinecraftCommandMessages.Chat
(Controls how the chat message is shown in Minecraft)
messages.TeamspeakMessages.ChannelMessage
(Formats the message on Teamspeak)
PM Command
This command sends a private message to only one client on TeamSpeak. You don't have to write the client's whole name, it's enough if you write the first few letters, so the plugin knows, which user you want to PM.
You can also use the TAB key on your keyboard to auto-complete the name or switch through a list of people who match your input.
/ts pm <target> <message>
bukkitspeak.commands.pm
messages.MinecraftCommandMessages.Pm
(Format for the message shown to the sender in Minecraft)
messages.TeamspeakMessages.PrivateMessage
(Format for the PM that gets sent to the client on Teamspeak)
Reply Command
This command is essentially equal to the PM Command, with the exception that this command will send your PM to the client that has last sent you a PM from TeamSpeak.
/ts reply <message> or shorter
/ts r <message>
bukkitspeak.commands.reply
messages.MinecraftCommandMessages.Pm
(Format for the message shown to the sender in Minecraft)
messages.TeamspeakMessages.PrivateMessage
(Format for the PM that gets sent to the client on Teamspeak)
Poke Command
This command pokes a client on TeamSpeak. This will open up a message box in the TeamSpeak client of the receiver.
You should consider not giving the permission for this command to everyone as the message boxes can be quite annoying if you are on TeamSpeak.
As in the PM command, you won't have to write the whole name of the client you want to poke. It's enough to write the first few chars. You can also auto-complete the name with the TAB key.
The message size for poke messages on TeamSpeak is limited to 100 characters, so you shouldn't waste the space for fancy colors.
(They take up quite a lot of space, as they're BB-Codes. E.g. [color=#ffff00][/color] -> 23 characters.
/ts poke <target> <message>
bukkitspeak.commands.poke
messages.MinecraftCommandMessages.Poke
(Controls how the broadcast is shown in Minecraft)
messages.TeamspeakMessages.PrivateMessage
(Formats the message on Teamspeak)
Info Command
This shows some general information about the TeamSpeak server.
As of now, it only shows the IP and how many people are online at the moment, but there will be more in the future.
If you have any suggestions about what this command should show, just contact me.
/ts info
bukkitspeak.commands.info
Admin commands
Every command prefixed with /tsa can also be accessed via /ts admin.
Example: /tsa kick SpamBot is equal to /ts admin kick SpamBot.
This command shows the admin command help.
Only shows those commands which the user has permissions for.
/tsa
/tsa help
/tsa adminhelp
bukkitspeak.commands.adminhelp
This command bans a client from your TS server, so he will not be able to rejoin your server afterwards, even if he changes his IP.
You can auto-complete the name of the client by hitting the TAB key.
You can also add a ban message, but that's optional. If you don't add a reason, DefaultReason from the config file will be used.
However it's quite difficult to remove bans afterwards so you should only ban spambots or similar.
To do so, you'll have to go through the ban list of your TS server and remove the UID and the IP ban.
As the nickname of the banned client is often not shown in the ban list, the time stamps of the bans and the one of the ban message in the server log can be extremely useful to figure out which ban to delete.
/tsa ban <target> (reason)
bukkitspeak.commands.ban
messages.MinecraftCommandMessages.Ban
(The message sent on the Minecraft server)
messages.TeamspeakMessages.BanMessage
(Message sent to the banned client and reason used in the logs)
This command will kick a client out off the server. He will be able to reconnect as soon as he wants. You can also use TAB to auto-complete the name of the client in this command.
If you don't add a message to the command, DefaultReason from the config will be used instead.
/tsa kick <target> (message)
bukkitspeak.commands.kick
messages.MinecraftCommandMessages.Kick
(The message sent on the Minecraft server)
messages.TeamspeakMessages.KickMessage
(Format for the message sent to the kicked client)
This command will kick a client out off the channel and move him back to the default channel of your TS server. Of course this command will not work if the client is already in the default channel.
The client will also receive a message notifying him that he was kicked.
If you don't add a message to the command, DefaultReason from the config will be used instead.
Furthermore you can also use TAB in this command to auto-complete the name of the client or to cycle through a list of clients that match your inupt.
/tsa channelkick <target> (message)
bukkitspeak.commands.channelkick
messages.MinecraftCommandMessages.ChannelKick
(The message sent on the Minecraft server)
messages.TeamspeakMessages.ServerMessage
(Format for the message sent to the kicked client)
This command lets you edit certain properties, which in fact resemble the teamspeak section of the config file. This way you can edit parts of the config without actually having to edit the file and reload the plugin.
For example, you can use this command to switch the channel BukkitSpeak is currently in by typing the command /tsa set channel Lobby.
The Channel property can actually be set to the name of a channel - which of course can be auto-completed with the TAB key - or its channel ID. This is different to the config file, where you can only put the channel's ID, but not its name.
/tsa set
Shows you all properties you can set.
/tsa set <property>
Shows you the description and the current value of this property.
It also shows you what values you can set the property to.
/tsa set <property> <value>
Sets the property to a certain value and changes the value in your config file.
bukkitspeak.commands.set
messages.MinecraftCommandMessages.ChannelChange
The message sent to everyone when the property Channel is edited.
This command will show you which BukkitSpeak version you are running, when the TeamSpeak listener has been started and also if it's running at the moment.
If there's been an error and the listener doesn't work anymore, it will also show you when it stopped working.
/tsa status
bukkitspeak.commands.status
This command reloads BukkitSpeak and the Server Query.
Thus the config.yml, locale.yml and permissions.yml will be reread and any changes you made to this file will be applied.
Furthermore this will try to reconnect BukkitSpeak to the TeamSpeak server, so you can also use this command if you've just been disconnected.
But please, don't try to use this command if you edited BukkitSpeak.jar, it will cause errors! If you've just updated BukkitSpeak, you need to do a complete server reload / restart. *Sorry*
/tsa reload
bukkitspeak.commands.reload