Skip to content
This repository has been archived by the owner on Sep 3, 2022. It is now read-only.
Lucas edited this page Nov 13, 2020 · 9 revisions

Starboard Wiki

Click here for a demonstration

Invite Starboard to your server

Join the support server

How to Read This Wiki:

Some things you should know before reading the docs:

  • Don't actually type <, >, [, ]
  • Words found inside of these symbols ([argument]] or <argument>) are called arguments.
  • Arguments inside square brackets ([argument]) are optional arguments. You can set them, but you don't have to.
  • Arguments inside <, > (<argument>) are required arguments. You must set these, and not doing so will cause an error
  • If you see multiple arguments inside of brackets ([channel_id|channel_name]), that means that you can set one or none of those arguments (never more than 1).
  • If you see multiple arguments inside of <, > (<seconds|hours>), that means you must set one of the arguments, no more, no less.
  • I added command aliases to make using the bot quicker. After each command, there is a description, example usage, as well as aliases.
    • commandName: Command description commandName <how> <to> <use> cn <h> <t> <u>

Here is an example command: Say you wanted to make the bot repeat the word "hello" 10 times. The command to do this is !repeat <word> [number_of_times=1]. You would type !repeat hello 10. Notice how one of the arguments is inside of the </>, while another is inside of the [/]? The ones inside the square brackets are optional arguments. They have a default value, so you don't always have to type it out. For example, typing !repeat hello would repeat the word 1 time, because the default value for number_of_times is 1. The other argument, inside of the </>, is a required argument. If you don't set it, it will raise an error.

Clone this wiki locally