Command Reference - QubedQ3/Q3-Bot GitHub Wiki

#How To Use Commands are prefixed by whichever string is set in the ServBot class field commandStart. (future might see this as configurable?) By default this is the '!' character.

The first word of he command is what identifies the command, if this is spelt wrong then an unrecognised command error will be returned. If the command name is correct but the following parts not then a message explaining the correct usage is returned.

Commands are shown in the format of command <arg1> [arg2] where command is the command itself, arg1 is a required argument and arg2 is an optional argument. There may be other requirements of the command and they will be detailed below.

#General Commands

listchannels - Lists all channels that this bot i currently connected to on this server.

roll [numdice] [sidesOfDice] - Rolls a dice! If just "roll" is used then two 6-sided dice will be rolled. If a number of dice is supplied then it will roll that many 6-sided dice.

twitch <username> - Queries Twitch to see if the user is live. If they are then their channel information is displayed.

hitbox <username> - Same as Twitch but for Hitbox!

beam <username> - Same as Twitch but for Beam!

commands - list all available commands to the user who asked.

customcommand - Any command that an admin has added by using the addcommand command can be used by anyone in a channel the bot is present in. #Admin Commands

addcommand <command> <response> - Adds a simple command to the bot that will simply print out the response when the "command" is used by others in the chat. This is useful for frequently asked questions, saving links or other uses. The command must be a single word however the response after that can contain spaces. Using this with a command that already has been saved will replace the old response. The old response will be shown to the user.

removecommand <command> - Will remove the custom command from the bot. The user who entered the command will recieve a message containing the old command.

join <#channel> [password] - Join the supplied channel in on the current server with optional supplied password. Channel must start with a #. Several channels can be joined at once by entering the name and optional password pairs. e.g. "!join #Foo #Bar" will join both the #Foo channel and #Bar channel.

join <server> [password] <#channel> [password] - Joins the given channel on the given server. If the bot is not currently connected to that server it will attempt to connect, however in that instance a password must be supplied. Multiple channels can be joined form one command similar to above.

leavechannel [channel] - Will make the bot leave either the current channel or the supplied channel. WARNING: This will make the bot forget everything about the channel and will not join unless told to with the join command.

leaveserver [server] - Will make the bot leave every channel then disconnect from the current server or supplied server. WARNING: This will make the bot forget EVERYTHING about the server and all channels. You have been warned!

shutdown - This will force the bot to shutdown, requiring the owner to restart it. It will save which servers and channels it was connected to before closing so that it will attempt to reconnect to them when started back up. (May make this bot owner only?)

#Polls/Draws COMING SOON