Skip to content
This repository has been archived by the owner on Dec 14, 2024. It is now read-only.

Understanding the Help command

Alexandre Cavalheiro edited this page Jan 27, 2018 · 1 revision

Before you start using the help command

You need to understand how we format the command usages, because if you do not understand them, using the commands can be really, confusing.


For this instance, let's get the hug and osubeatmap commands, try using k!help hug and then k!help osubeatmap to see each individual command's info, you should see something like this.

  • The aliases are the other ways you can invoke this command, in this instance, you can do k!hwug wizard and it will work the same way as doing k!hug wizard.

  • The usage is how you are supposed to use this command, basically a tutorial.

  • The examples are well, examples of the command's usage so you do not lose yourself.

  • The permission level is what level of permission you need to execute that command.

  • The enabled is to tell you if a command is currently enabled, or disabled (Probably on maintenance).


Ok, so back to the topic of how usage works... You will see 3 different things that will define how the command works, and these are:

  1. [] - This means that this option is not strictly required, the command will execute even if you do not use them.
    • Obs: Some cases like the dance command have a different reaction if you use without providing a user
  2. <> - This is strictly required, if you do not put what it wants you to put, the command will "fail".
  3. ... - If you see these triple dots it means that option can be extended, for example the hug usage, it is kanna hug <...User>, meaning you can do k!hug wizard and k!hug kanna wizard and it will work just as expected.

Let's see if you understood correctly

Let's get the blush command, it's usage is kanna blush [...User], User is optional, meaning you can do k!blush, but multiple Users can be provided as it has the ..., so you can do k!blush wizard kanna and it will work.


Now that you understand how usage works

Do k!help help to see the help command info, read this guide once again if you still have any questions and enjoy the bot!