Prefix

The prefix is what tells the bot that your message is a command and not just any message. By default, the prefix is ! but as that is a common bot prefix, it has been made so you can set your own prefix per guild. Additionally, you will always be able to trigger the bot using a mention prefix: @RuneInfo#5879.

Usage

Usage is a template for how a command can be used. It is made up of Aliases and Arguments.

Aliases

An alias is exactly what it sounds like. It is multiple commands that produce the same result. Aliases are shown in the usage string wrapped in ( ) and seperated by |, like this: (github|version|about). This means in a guild where the prefix is ! that command can be triggered as !github, !version, or !about.

Arguments

Arguments are the additional pieces of information you provide, to get the information you are looking for. Arguments are seperated into 2 categories, required and optional. Required arguments are wrapped in < >. Optional arguments are wrapped in [ ]. Arguments follow the following format Name:Type{Min,Max}.

Example: <Points:int{1,50}> [Level:int{1,120}]

Note: Min & Max may be omited seperately, or completely when the argument has no min or max.

Argument Types

Arguments expect certain types of data, and are validated before the command is even run. For instance, if you provide a String (letters) where the bot is expecting a Number, that can be a problem if it isn't caught. Although, some arguments may accept multiple types like: <ItemID:int|ItemName:str>. That single argument can be an ItemID as an integer or an ItemName as a string.

The following types have been implimented in RuneInfo's framework:

 |   |   |   |   |   | 

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.