Bot Command Formatting Guide ¶

When you read through this wiki, you will see many examples of commands you may need/want to enter.
These follow a fairly simple syntax but if you're not aware of it you may end up entering in stuff that the bot has no idea on how to handle.

This quick guide will help you understand how we document commands.

Data You Need To Input ¶

Following standard computing terminology, we will document commands that need information from you with a descriptive insert into the command example. These are referred to in standard terminology as arguments.

These will be encased in special bracket characters such as [ ] < >
When you see these characters, you don't actually want to enter them into the command. Instead, you will need to replace that whole segment including the brackets with a response.

Brackets that are written as [ ] are optional you do not need to fill these out for the command to execute correctly.

However brackets written as < > are absolutely required. The command will not execute unless these are met.

For example,
The command for a ticket embed is documented as follows:
!tickets embed [colour] [channel] <title> <description>
and if you were to enter that you would need to fill out the arguments with something like this.
!tickets embed 012356235234 Hello Hello and Welcome
In the example we have ignored the colour option as it's optional, and filled out the channel title and description.

Some commands like this one determine the next argument by spaces, and if you need to add a space (Say to the title) you just enclose that argument in double quotes.
!tickets embed 012356235234 "Hello There!" Hello and Welcome
This can be inconsistent though, so on our documentation we will explicitly tell you when you need to use double quotes.