Arguments

This section will explain the various bracket and argument types used for command arguments. Command arguments are anything that goes in the brackets <> and {} of a command.

Bracket Types

The bracket around an argument indicates whether the argument is required (must be included) or optional (can be included, but not required). There are three types of brackets that we use for Forkman:

  • <> - This argument is required, it must be included.

  • {} - This argument is optional, it can be included but not required.

  • () - This holds enum values for the argument, one option must be picked and specified.

Do not include the brackets (<>, {} and ()) when using a command.

Argument Types

TypeDescription

String

Used in most cases. A string can be any character or text.

Number

Any number without decimal.

URL

A valid domain link, must be prefixed by http:// or https:// and have a valid domain name.

Enum

Strings that match a certain key value provided in the () bracket right next to the argument name.

Emoji

Emoji as unicode (😄) or the Discord custom emojis (<a:emoji_name:emoji-id> for animated and <:emoji_name:emoji-id> for normal emojis) format.

Command

Any valid and existing command name of Forkman, e.g. help or -help, both works. Command names are not case sensitive.

Boolean

One of: yes/no or true/false.

User

A valid Discord user ID, mention or name.

Last updated