Commands: Documentation Reference

Syntax

The following syntax is used throughout the documentation:

<...>

A parameter you specify.
Example:

!quote <ID>

becomes

!quote 1

[...]

Optional: Only provide what's contained in the brackets if you want.
Example:

!play ready [<reason>]

becomes (if not provided)

!play ready

or (if provided)

!play ready I can't wait to bomb some Dodongos!

"..."

Quoted string: Quotation marks are required around this string parameter; used when an optional string parameter precedes another string parameter.
Example:

!vote ["<poll reference>"] <choice>

becomes (if not provided)

!vote 2

or (if provided)

!vote "Splaturday" Splatoon 2

...+

One or more: Provide what precedes the plus sign one or more times.
Example:

!play select <team player count>+

becomes

!play select 2 3

which selects a team of 2 players and a team of 3 players.

{m..n}...

Between m and n items: Provide what follows the braces between m and n times.
Example:

!identity aka {2..5}<service:name>

becomes

!identity aka Twitch:SwirlyEyedLink Switch:SELink

which associates the identity for the Twitch account SwirlyEyedLink with SELink on the Switch.

Parameter Conventions

The following parameter conventions are used throughout the documentation:

<service:name>

Specifies an identity via a service and display name pair. (For some commands, service is optional, defaulting to the service the command was issued on.)
Example:

!identity create <service:name>

becomes

!identity create Switch:Squidding

<timespan>

Specifies a length of time by providing a value for one or more units. Valid units are:

h

Hours

m

Minutes

s

Seconds

Examples:

!reminder 3m You forgot to check for friend requests again.

!reminder 1h30m Let's raid somebody!