DOCUMENTATION

CONTENTS πŸ‘…

Background

To read about the latest improvements to the bot, you can view the changelog here.

Functions

  • The difference between functions and commands, as documented here, is that functions run in response to some event (such as a user joining a server), whereas commands run when they are explicitly called by a user.
  • While functions and commands are separate, they can interact. For example, the Event Trigger Response under Meta-Commands can cause a command to run when a channel is created.
  • The behavior of each function is documented with the assumption that the function is enabled. Some functions (such as the Reaction Monitor under Nexus) cannot be disabled, but most can.

Using Commands

  • Syntax is written in the format [prefix][command name] [argument 1] [argument 2]...
  • All commands must begin with a prefix, which is > by default, but can be changed for a particular server.
  • Do not include [brackets] in your arguments.
  • Arguments marked with an *asterisk are optional under some conditions. All other arguments are always required.
  • If a command takes multiple arguments, any argument before the last that includes spaces must be surrounded in quotes. For example: >add_role "Some User" A Cool Role
  • When flags are permitted in an argument, they can be included anywhere in the argument, and do not appear in the command's output. They modify the behavior of the command.
  • When substitution variables are permitted in an argument, they are replaced with some value when you use the command, so you should place them where you want the particular value to appear.

Administration

Functions

  • Forward Private Messages: when a private message is sent or received by the bot, sends a copy of that message to the designated "private message forwarding" special channel, with a timestamp and the name of the sender or recipient. This is only available to servers with custom bots, which require Deluxe subscriptions. This function also responds with the bot's join link when a user sends the bot a private message containing a server invite, in case the user is trying to invite the bot.
  • Incoming: when a member arrives or returns, requests a password from them in private messages, gives them new roles, restores their previous roles, and greets them in a channel. If the server has a password, the member will not be able to see any channels in the server, and will have five attempts to enter the correct password before being kicked.
  • Outgoing: when a member departs or is banned, sends a notification to a channel that includes the member's nickname, username, ID, roles, and join time and date.

Commands

Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

Below are the ranges for the [value] argument for each possible [attribute]. Some attributes or values require special features that are not available to all servers.
AttributeValue
"name"Any text of 100 characters or less that is not already the server's name.
"icon"Any direct link to a hosted image with the file extension .png, .jpg, or .gif.
"afk_channel"The name or ID of any voice channel on the server.
"afk_timeout"1, 5, 15, 30, or 60 (minutes).
"verification" or "verification_level""None," "low," "medium," "high" or "table_flip," or "extreme" or "double_table_flip."
"default_notifications," "notifications," "default_notification," or "notification""All messages" or "only mentions."
"explicit_content_filter," "explicit_content," "content_filter," or "content""Disabled," "no role," or "all members."
"system_channel"The name, #mention, or ID of any text channel on the server.
"vanity," "vanity_code," or "vanity_url"Any text (special feature).
"description"Any text (special feature).
"banner"Any direct link to a hosted image with the file extension .png, .jpg, or .gif (special feature).
"splash" or "invite_splash"Any direct link to a hosted image with the file extension .png, .jpg, or .gif (special feature).
"rules" or "rules_channel"The name, #mention, or ID of any text channel on the server (special feature).
"updates," "public_updates," or "public_updates_channel"The name, #mention, or ID of any text channel on the server (special feature).

Arguments

ArgumentPermitted Inputs
[attribute]See Usage.
[value]Permitted inputs for this argument depend on [attribute]. See Usage.

Examples

CommandResult
>server_edit system_channel generalThe server's system channel, where built-in welcome and Nitro boost messages are sent, will be #general.
>server_edit verification_level mediumThe server's verification level will be Medium.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[channel]The name, #mention, or ID of a channel on the server.
[name]
  • If [channel] is a voice channel or category, any text of 100 characters or less
  • If [channel] is a text channel, any text of 100 characters or less that contains only letters, numbers, underscores, and hyphens

Examples

CommandResult
>rename_channel info informationThe #info channel will be renamed to #information.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[role]The name, @mention, or ID of any role on the server that is below the bot's highest role and is not the @everyone role.
[name]Any text of 100 characters or less.

Examples

CommandResult
>rename_role Mod ModeratorThe Mod role will be renamed to Moderator.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

A new channel will be created on the server. This new channel will have the given name, no invites, no webhooks, and no messages, but will otherwise be identical to the original. It will be in the same category as the original, if applicable.

Arguments

ArgumentPermitted Inputs
[channel]The name, #mention, or ID of a channel on the server.
[name]
  • If [channel] is a voice channel, any text of 100 characters or less
  • If [channel] is a text channel, any text of 100 characters or less that contains only letters, numbers, underscores, and hyphens

Examples

CommandResult
>clone_channel info announcementsA channel named #announcements will be created with the same topic, permissions, slowmode and NSFW status, and category as #info.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

A new role will be created on the server. This role will have the given name, it will have no permissions, it will be unhoisted, and it will not be mentionable. It will be placed at the bottom of the role hierarchy.

Arguments

ArgumentPermitted Inputs
[color]
  • Any hexadecimal color code, which does not need to begin with #
  • "000000," "default," or "none" for the default Discord gray
[role name]Any text of 100 characters or less

Examples

CommandResult
>create_role #00137c Verified MemberA role named "Verified Member" with the color #00137c will be created.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[delay]
  • "none" to disable slowmode
  • Any integer between 1 and 21600, representing the number of seconds that a member must wait after sending a message before sending another one
[*channel]
  • Leave blank or "here" for the current channel
  • The name, #mention, or ID of a channel on the server

Examples

CommandResult
>slowmode 10 generalSlowmode will be enabled in #general with a delay of ten seconds.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate nameslock, unlock, and unhide
Premium subscription requiredNo

Effect

The channel's permissions will be changed so that it can only be viewed by members with the Administrator permission or server ownership, along with members who could previously see the channel and have at least one Moderator or Administrator role. If the command is used a second time on the same channel, the old permissions will be restored.

Arguments

ArgumentPermitted Inputs
[*channel]
  • Leave blank or "here" for the current channel
  • The name, #mention, or ID of any channel or category on the server

Examples

CommandResult
>hide generalIf it is currently visible, the #general channel will be made invisible to anyone without a designated moderator or administrator role. If this command was already used to hide #general, the channel's old permissions will be restored, unhiding it.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

The given announcement channel will be followed in the given receiving channel.

Arguments

ArgumentPermitted Inputs
[announcement channel]The #mention or ID of any announcement channel in a server the bot can see.
[*receiving channel]
  • Leave blank or "here" for the current channel
  • The name, #mention, or ID of a channel on the current server

Examples

CommandResult
>follow 894331829824409642 consoleThe support server's changelog channel, which has the ID 894331829824409642, will be followed in #console.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

If the [message link] argument is left blank, the command must be used in an announcement channel with existing messages.

Effect

The command will self-delete if it is used in an announcement channel.

Arguments

ArgumentPermitted Inputs
[*message link]
  • Leave blank to publish the most recent message in the channel
  • The link to any message on the server
  • The ID of any message in the current channel

Examples

CommandResult
>publish https://discord.com/channels/455185166030209024/685639303279280158/766905316876877825The message at the given jump link will be published.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

While humans can only create one invite per channel, bots are not limited in this way, so this command is useful if multiple invites are needed for a single channel.

Arguments

ArgumentPermitted Inputs
[*channel]
  • Leave blank or "here" for the current channel
  • The name, #mention, or ID of a channel on the server

Examples

CommandResult
>create_invite generalA permanent invite to #general will be created and posted in the channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

The key/value pairs are saved to the member's database entry, and can be referenced in commands via aliases, using the format %%USER_ID:key%%, or used with the >conditional or >mass_conditional commands.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server.
[operation]
  • "set" to set a value, which may or may not be defined already
  • "add" to add or subtract an integer value from a defined integer value
  • "append" to append a value to the end of a defined list
  • "remove" to remove a value from anywhere in a defined list
[key]Any text that is not "username," "nickname," "before," or "after," and does not contain spaces, newlines, or any of the symbols .$@%.
[value]
  • If [operation] is "set," any text, any integer (positive or negative), or "[]" to define an empty list
  • If [operation] is "add," any integer (positive or negative)
  • If [operation] is "append," any text
  • If [operation] is "remove," [value] can be "first" to remove the first entry in the list, "last" to remove the last entry, or any text to remove a specific value

Examples

CommandResult
>edit_user_data August set flag_colors []Set August's flag colors to an empty list.
>edit_user_data August append flag_colors blackAdd black to August's flag colors.
>edit_user_data August append flag_colors whiteAdd white to August's flag colors.
>edit_user_data August remove flag_colors firstRemove black from August's flag colors.
>edit_user_data August set color_count 2Set August's color count to 2.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesaddroles, add_role, and addrole
Premium subscription requiredNo

Usage

For public roles, the >request command should be used instead.

Effect

If the Respect Hierarchy setting is enabled, only roles below the author's top role can be added.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member on the server.
[roles]A list of roles, separated by double commas. Each role item can be the name, @mention, or ID of any role on the server that is below the bot's highest role, does not already belong to the member, and is not the @everyone role.

Examples

CommandResult
>add_role August Guest SpeakerThe Guest Speaker role will be added to August.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesremoveroles, remove_role, and removerole
Premium subscription requiredNo

Usage

For public roles, the >request command should be used instead.

Effect

If the Respect Hierarchy setting is enabled, only roles below the author's top role can be removed.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member on the server.
[roles]A list of roles, separated by double commas. Each role item can be the name, @mention, or ID of any role on the server that is below the bot's highest role, does not already belong to the member, and is not the @everyone role.

Examples

CommandResult
>remove_role August Guest SpeakerThe Guest Speaker role will be removed from August.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesstriproles
Premium subscription requiredNo

Effect

Only roles below the bot's highest role can be removed with this command. If the Respect Hierarchy setting is enabled, only roles below the author's top role can be removed.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member on the server.

Examples

CommandResult
>strip_roles AugustAll of August's roles will be removed.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesnick
Premium subscription requiredNo

Effect

If the Respect Hierarchy setting is enabled in Bot Settings, the command will have no effect on members whose top role is not below the author's top role.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member on the server whose highest role is below the bot's highest role.
[nickname]
  • Any text under 32 characters that is not already the member's nickname
  • "none" to clear the member's nickname.

Examples

CommandResult
>nickname August That guy who does the thingAugust's nickname will be changed to "That guy who does the thing."
>nickname August noneAugust's nickname will be removed.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

All accounts that have any of the specified roles on the server, or no roles if none are specified, and have not logged into Discord in the number of days given by [days] will be kicked from the server.

Arguments

ArgumentPermitted Inputs
[days]A positive integer.
[*roles]
  • Leave blank for no roles
  • A list of roles, separated by double commas

Examples

CommandResult
>prune 7All members with no roles who have not been online in the last week will be kicked.
>prune 1 Approved,, MembersAll members with the Approved role or the Members role who have not been online in the last day will be kicked.


[Permalink]


Analytics

Functions

None.

Commands

Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Effect

This command takes the "actually online" number from a server invite. If the server has no invites, the bot will attempt to create a new invite, then delete it after extracting the online member count. The output includes the number of members the server has, the number that appear to be online (including do-not-disturb and idle), the percentage of the total members who appear to be online, the number that are actually online, and the percentage of the total members who are actually online.

The Main Edition of the bot is unable to provide reliable online/offline statuses.

[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredDeluxe bots only

Usage

This command has a one-hour cooldown period.

Effect

Each line includes a ranking ordinal, username and discriminator, user ID, post count, and a count of the user's known deleted messages. Messages deleted before the bot began recording do not factor into this data. Bot accounts are indicated with [BOT]. The usernames listed are the ones that the users had at the time of their most recent messages on the server.

[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Usage

The roles provided to [roles] should be separated by AND/OR/NOT operators, which define the filter. All roles listed before the NOT operator will be included, and all roles listed after the NOT operator will be excluded. The NOT operator may be omitted if you want to include all the roles in the list. No more than one NOT operator should be used. Any group of roles separated by the AND operator will be required by the filter, unless it is listed to the right of a NOT operator, in which case it will be prohibited. Any one role in a group of roles separated by the OR operator will be required by the filter, unless it is listed to the right of a NOT operator, in which case it will be prohibited. Any number of AND/OR operators can be used, in any combination.

Arguments

ArgumentPermitted Inputs
[roles]A list of roles, separated by AND/OR/NOT operators. Each role item can be a name, @mention, or ID.

Examples

CommandResult
>filter_roles Admin OR Mod NOT Supporter AND MemberA list of all the members of the server that have either the Admin or Mod role but not both the Supporter and Member roles will be generated and posted in the channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate nameslist_ids
Premium subscription requiredNo

Effect

Two lists are produced, one with the IDs of all objects of the selected type on the server and one with both IDs and names, will be posted in the channel. This command does not show the names or IDs of channels the command author cannot see.

Arguments

ArgumentPermitted Inputs
[ID type]
  • "member" or "members" to generate a list of members and their IDs
  • "role" or "roles" to generate a list of roles and their IDs
  • "channel" or "channels" to generate a list of channels and categories and their IDs

Examples

CommandResult
>show_ids roleA list of all the roles on the server will be posted, from lowest (@everyone) to highest, with names and IDs.


[Permalink]


Backups

Functions

  • Edit Logger: when any message is edited on the server, logs the event to the designated "Message edited" log channel, along with the message ID and information identifying the author and a link to the original message. If the message is in the bot's cache, its original contents will be included in this log.
  • Delete Logger: when any message is deleted on the server, logs the event to the designated "Message deleted" log channel, along with the message ID and information identifying the author. If the message is in the bot's cache, its original contents will be included in this log.
  • Bulk Delete Logger: when messages are bulk-deleted on the server, such as with the delete command, logs the event to the designated "Messages bulk-deleted" log channel, along with the IDs of the messages.
  • Event Loggers: when a channel or role is created, deleted, or updated; the server is updated; emojis are updated; a member arrives, departs, or is updated; or a user is banned or unbanned, logs the event to the appropriate designated log channel, along with information about the change. Each log entry contains a "search code," which a user can plug into Discord's search bar to find other occurrences of the event. The user can include object IDs in the search to view only the events that involved those objects (such as a member, a role, a channel, or some combination of those things).

Commands

Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The emojis will be packaged, then a link will be sent to you via private message. From this link, you can download a folder containing the images. This link will be accessible for one hour, then its contents will be deleted.

[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

Only one backup can be saved at a time. If the server has been backed up previously, a prompt will open, allowing you to confirm that you want to overwrite the existing backup.

Effect

This backup includes settings, graphics, roles, channels, permissions, nicknames, emojis, bans, and the bot's configuration for the server. It does not include invites, which generally cannot be duplicated, or messages.

[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

This command requires that the bot's highest role is the highest role on the server hierarchy, and that the bot is the only member with that role, for the duration of the restoration process. A prompt will open, allowing you to confirm that you want to revert all changes made since the last backup.

Arguments

ArgumentPermitted Inputs
[*aspect]
  • Leave blank to restore all aspects of the server
  • "roles," "members," "categories," "text_channels," "voice_channels," "stage_channels," "server_settings," "bot_settings," "bans," or "emojis" to restore just that aspect of the server

Examples

CommandResult
>restore bansThe server's ban list will be restored to its last backed-up state.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

The minimum interval is one day. These backups are the same as those performed by the >backup command.

Arguments

ArgumentPermitted Inputs
[time]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".

Examples

CommandResult
>schedule_backup 1wThe server will be backed up once a week at the same time, with the first backup taking place one week from now.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

You must have been the owner of the original server or had at least one Administrator role there at the time of the last backup, in addition to being an administrator of the new server. A server cannot be duplicated over itself. This command requires that the bot's highest role is the highest role in the new server, and that the bot is the only member with that role, for the duration of the duplication process. A prompt will open, allowing you to confirm that you want to erase all of the new server's settings and replace them with those of the original server.

Effect

Existing text channels on the new server will not be deletedβ€”rather, they will be moved to a category named Saved Channels.

Arguments

ArgumentPermitted Inputs
[old server ID]The ID of any server that has been backed up, regardless of whether the bot is still there.

Examples

CommandResult
>duplicate_server 455185166030209024The current server will become an exact copy of the support server (which has the ID 455185166030209024).


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredYes

Effect

The log files will be packaged, then a link will be sent to you via private message. From this link, you can download a folder containing text logs of the arrival, departure, ban, role add/remove/create/delete/update, channel create/delete/update, voice channel presence, reaction, and server settings update events that have taken place since the bot began recording. This link will be accessible for one hour, then its contents will be deleted.

Arguments

ArgumentPermitted Inputs
[event category]
  • "all" to retrieve all event logs
  • "roles" for role creation/deletion/changes
  • "channels" for channel creation/deletion/changes
  • "members" for nickname changes and role additions/removals
  • "emojis" for emoji creation/deletion/changes
  • "voice" for voice channel activity
  • "server" for changes to server settings and ownership
  • "ADRB" for arrivals/departures/returns/bans

Examples

CommandResult
>retrieve_event_logs allYou will receive a link to download a folder containing text files with all the event logs that the bot has ever recorded from the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredDeluxe bots only

Usage

This command has a one-hour cooldown period on a per-server/per-channel basis. This means that after logs are requested from one particular channel, they cannot be requested from that channel for another hour. After logs are requested from the entire server, they cannot be requested from the entire server or any one channel for another hour.

Effect

The log file(s) will be generated from the database copies of the server's messages, with one file for each channel. Each log file will include every message in the channel, starting with the first, along with full edit and deletion history for each one. Messages deleted before the bot began recording will not be included, nor will the original contents of messages edited before the bot began recording be included in edit histories. Each message will include a timestamp, information identifying its author, and a link to the original message. The file(s) will be packaged and compressed, then a link will be sent to you via private message. From this link, you can download a folder containing the text logs of the channel or channels you requested. This link will be accessible for one hour, then its contents will be deleted.

Arguments

ArgumentPermitted Inputs
[channel]
  • The name, #mention, or ID of any text channel on the server that you can see
  • "all" to return all channels on the server, including channels deleted since the bot began recording. This option requires that you have the Administrator permission.

Examples

CommandResult
>retrieve_channel_logs generalYou will receive a link to download a text file containing message logs from the #general channel on the server.
>retrieve_channel_logs allYou will receive a link to download a folder containing text files with message logs from all channels on the server that the bot has ever recorded.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredDeluxe bots only

Usage

This command has a twelve-hour cooldown period on a per-channel basis. For example, if a particular original channel is regenerated, it cannot be regenerated again for twelve hours, starting from the time the regeneration finished. A different channel can be regenerated before that time.

Arguments

ArgumentPermitted Inputs
[channel ID]The ID of a channel on the server that has been logged.

Examples

CommandResult
>regenerate_channel 542711012986716170The channel by that ID will be regenerated with its former name and all its logged messages.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

A prompt will open, asking you to confirm this operation. This command can be used with any server that you own, or that you owned when the bot was last present there, even if the server no longer exists. If you were the owner of a server and have lost access to the owner account, please file a >ticket.

Effect

This command has no effect on event logs that the bot recorded to a channel on the server, if that feature is enabled. Only offline text files will be deleted.

Arguments

ArgumentPermitted Inputs
[*server ID]
  • Leave blank for the ID of the current server
  • The ID of any server that you own, or that you owned when the bot was last present there
This argument is required in private messages.

Examples

CommandResult
>erase_event_logs 455185166030209024All files containing events logged from the support server (which has the ID 455185166030209024) will be deleted.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

A prompt will open, asking you to confirm this operation. This command can be used with any server that you own, or that you owned when the bot was last present there, even if the server no longer exists. If you were the owner of a server and have lost access to the owner account, please file a >ticket.

Effect

This command has no effect on event logs that the bot recorded to a channel on the server, if that feature is enabled. If message logging is enabled, the bot will automatically regenerate the channel logs. However, all edit and deletion history before this point will be lost, along with all messages from deleted channels.

Arguments

ArgumentPermitted Inputs
[*server ID]
  • Leave blank for the ID of the current server
  • The ID of any server that you own, or that you owned when the bot was last present there
This argument is required in private messages.

Examples

CommandResult
>erase_channel_logs 455185166030209024The database containing messages logged from the support server (which has the ID 455185166030209024) will be deleted.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

A prompt will open, asking you to confirm this operation. This command can be used with any server that you own, or that you owned when the bot was last present there, even if the server no longer exists. If you were the owner of a server and have lost access to the owner account, please file a >ticket.

Effect

This command has no effect on logged messages or events. Restoring or duplicating the server will not be possible until another backup is saved.

Arguments

ArgumentPermitted Inputs
[*server ID]
  • Leave blank for the ID of the current server
  • The ID of any server that you own, or that you owned when the bot was last present there
This argument is required in private messages.

Examples

CommandResult
>erase_backup 455185166030209024The backup copy of the support server (which has the ID 455185166030209024) will be deleted.


[Permalink]


General

Functions

  • Send Keyword Alerts: when a message is sent in any server channel, checks to see if that message matches any keywords defined by a user who can see that channel, and if so, sends that user a private alert with a link to the message.

Commands

Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

Flags

%case_sensitive requires the message text to match the case of the keyword. Without it, the text "abc" will match the keyword "B". %message_equals requires the message text to match the keyword exactly. Without it, the text "Bleep bloop!!" matches the keyword "Bleep bloop". %message_contains requires the message text to contain the keyword. If neither %message_equals nor %message_in are included, this flag is implied, even if it is not included. %is_word requires the message text to contain a word that exactly matches the keyword. This flag cannot be used with a keyword that contains spaces, or with the %message_equals or %message_in flags. Without it, the text "cat in the hat" will match the keyword "at". %in requires the message text to exist within the keyword.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to create a new keyword
  • "edit" to modify the flags of an existing keyword
  • "remove" or "delete" to remove a keyword
  • "list" to show all your keywords
[*keyword]Any text between 3 and 1950 characters. When [operation] is "add," "edit," or "remove," this argument is required.

Examples

CommandResult
>keyword_alert add mooseWhenever a non-bot user sends a message containing the word "moose" in a channel you can see, the bot will send you a private message with a link to the message in question.
>keyword_alert add %message_in This is an example of a complete sentence.If someone sends a message that contains the phrase "complete sentence" and nothing more, the bot will send you a private message with a link to the message in question.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server.
[key]Any key that has been associated with the given member using the >edit_user_data command.

Examples

CommandResult
>view_data August favorite_colorAugust's favorite color will be posted in the channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

This command shows the server's icon, when the server was created, how many members the server has, how many appear to be online, who owns the server, how many roles and channels the server has, and the server ID. The color of the embed is the most frequent color in the server's icon.

[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

When this command is used in private messages or finds a user who is not a member of the server, it will return their ID, avatar, username and discriminator, account creation time, badges, and About link if any. If the command finds a member on a server, it returns the same information, as well as the member's roles, the time they arrived in the server and where they fall in the arrival order, their online status, their activity or custom status, and their nickname (if any). The color of the embed is the member's color on the server. Possible badges include Bot and Verified Bot for bots; Server Owner and Server Booster for server members; and Bug Hunter (level 1), Bug Hunter (level 2), Early Verified Developer, Early Supporter, HypeSquad Events/Bravery/Brilliance/Balance, Discord Partner, and Discord Staff for non-bot users.

Arguments

ArgumentPermitted Inputs
[*user]
  • Leave blank for the author
  • In private messages, any user ID
  • On a server, the nickname, username, @mention, or ID of a member of the server, or any user ID

Examples

CommandResult
>profile AugustWhen used on a server you share with August, an embed containing details about that account and its presence on the server will be posted.
>profile 213088304537534464When used in private messages or a server you do not share with August (who has the ID 213088304537534464), an embed containing basic information about that account will be posted.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesremind, reminder, and remind_me
Premium subscription requiredNo

Effect

This command will inform you of the exact time when the reminder will be sent, and how to view your queued reminders.

Arguments

ArgumentPermitted Inputs
[time]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
[text]Any text.

Examples

CommandResult
>remindme 9h Wake up!You will receive a private message in nine hours reminding you to wake up.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate nameschoice
Premium subscription requiredNo

Usage

Respond with a random selection from the provided options.

Arguments

ArgumentPermitted Inputs
[options]A list of options, separated by double commas. Each option can be any text.

Examples

CommandResult
>choose Me, myself, and I,,This, that, and the other,,The good, the bad, and the ugly"The good, the bad, and the ugly" (or either of the other two options, with equal probability) will be posted in the channel.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The range is inclusiveβ€”for example, >rng 1 2 may return 1 or 2. There may be some loss of precision at extremely high values.

Arguments

ArgumentPermitted Inputs
[lower bound]Any positive integer less than 1E308.
[upper bound]Any positive integer greater than [lower bound] and less than 1E308.

Examples

CommandResult
>rng 10 100"42" (or any other integer between 10 and 100, with equal probability) will be posted in the channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

The list of roles available for self-request is set by the server administrator. The @everyone role, the bot's highest role, and any roles above it cannot be added or removed with this command.

Effect

If you request an available role that you do not have, you will receive it. If you have it already, it will be removed from you. If you request a role that is part of a mutually-exclusive group and you do not have it already, you will receive it and lose all other roles in that group, if you had any.

Arguments

ArgumentPermitted Inputs
[role]The name, ID, or @mention of a role on the server. Role names are case-insensitive.

Examples

CommandResult
>request Archive AccessIf you did not have the Archive Access role, you will receive it. Otherwise, it will be removed from you.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

IDs can typically be obtained by enabling Developer Mode in your user settings (under Appearance), then right-clicking on the object in question and selecting Copy ID. The ID of a custom emoji can be obtained by sending a message with a backslash before the emoji, such as \:moose:.

Arguments

ArgumentPermitted Inputs
[snowflake]The ID of any user account, role, channel or category, server, message, attachment, or emoji.

Examples

CommandResult
>timestamp 691029306171719700"2020-03-21 21:03:45.295000 UTC," the time the message was created, will be posted in the channel.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

You cannot multiply or divide a single roll more than once, or multiply and divide a single roll at the same time. You can multiply or divide a roll by an integer, but not the reverse. For example, >roll 3d6 * 2 * 3, >roll 3d6 * 2 / 3, or >roll 2 * 3d6 would be considered invalid syntax, but >roll 3d6 * 2 + 1d8 * 3 would be valid. You cannot roll zero dice or a die with zero sides.

Effect

Fractional results are rounded down to the nearest integer. Fractional multipliers are shown rounded to two decimal places, but maximum precision is used internally. Blank rolls, such as the one in the middle of >roll 1 + + 1, are ignored. All positive results are listed first, followed by all negative results, regardless of input order.

Arguments

ArgumentPermitted Inputs
[dice]The dice roll you want the bot to simulate, in the format NdS, where N is the number of dice and S is the number of sides each die should have. You can roll different types of dice at once by separating your rolls with + or -. You can also add (+), subtract (-), multiply (\*), and divide (/) with integers.

Examples

CommandResult
>roll 3d6The bot will roll three six-sided dice and post the individual dice and their sum in the channel.
>roll 1d8+2d6-5The sum of the rolls of one eight-sided die, two six-sided dice, and -5 will be posted in the channel.
>roll 12d10 * 2 + 8d4 / 2The sum of the rolls of twelve ten-sided dice, doubled, and eight four-sided dice, halved, will be posted in the channel.


[Permalink]


Message Utility

Functions

None.

Commands

Details

Available in private messagesYes
Permissions tierPower User and above
Alternate namessend and dm
Premium subscription requiredNo

Usage

Attached files can be no larger than the standard 8MB limit. @everyone, @here, and role mentions can be included in [text], but if you do not have permission to use those mentions in the destination channel, the mentions will be deactivated.

Flags

%tts causes the first 200 characters of the text to be read out loud. %del causes the command to be deleted immediately after the output is posted, if the command was used on a server. %pin causes the output to be pinned. %mimic causes the bot to use your name and avatar when it posts the message, if the command was used on a server.

Substitution Variables

$u β‡’ your @mention $m β‡’ the recipient's @mention, if the command was used to send a private message, or the channel's #mention otherwise $s β‡’ the server's name, if the command was used on a server $c β‡’ the server's member count, if the command was used on a server $d β‡’ the current date

Effect

If a file is attached to the command, the file will be re-uploaded with the command's output. If this command is used to send a private message to someone other than yourself, the message will include a line at the bottom informing the recipient of who used the command and on which server.

Arguments

ArgumentPermitted Inputs
[destination]
  • "here" for the current channel, which could be a private message channel
  • If used on a server, the name, #mention, or ID of any text channel on the server where you have permission to send messages
  • If used on a server, the nickname, username, @mention, or ID of any non-bot member of the server
[*text]Any text, including flags and substitution variables. This argument is required unless a file is attached, in which case it is optional.

Examples

CommandResult
>post here Hello, $s! %del %mimicWhen used on the World Expo server, the text "Hello, World Expo!" will be posted in the current channel, and the command itself will be deleted. The bot's message will appear to have been sent by you.
>post August Check your inbox. %pinThe text "Check your inbox. (This message was sent by YourName#1234 from the server World Expo.)" will be sent to August via private message and pinned there.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to pin the message
  • "remove" to unpin the message
[message link]
  • "above" for the most recent message in the current channel
  • The link to any message on the server
  • The ID of any message in the current channel

Examples

CommandResult
>pin add https://discord.com/channels/455185166030209024/672544958359797790/691029306171719700The message will be pinned.
>pin remove aboveThe most recent message in the channel will be unpinned, assuming it was pinned in the first place.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Usage

The text must be less than 2000 characters after substituting any variables.

Substitution Variables

$u β‡’ your @mention $s β‡’ the server's name $c β‡’ the server's member count $d β‡’ the current date

Effect

The old content of the message will be posted in response to the command, unless [message link] is "above."

Arguments

ArgumentPermitted Inputs
[message link]
  • "above" for the most recent message in the current channel
  • The link to any message on the server that was posted by the bot
  • The ID of any message in the current channel that was posted by the bot
[text]Any text, including substitution variables.

Examples

CommandResult
>edit https://discord.com/channels/455185166030209024/672544958359797790/691029306171719700 You saw nothing.The message will be edited to say "You saw nothing." and the old content will be posted in the current channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesadd_reaction and add_reactions
Premium subscription requiredNo

Usage

You must have permission to react to messages in the channel where the message is located.

Arguments

ArgumentPermitted Inputs
[message link]
  • "above" for the most recent message in the current channel
  • The link to any message on the server
  • The ID of any message in the current channel
[emojis]Any list of emojis, separated by spaces or double commas. Each item can be a Unicode emoji or custom emoji that is installed on a server the bot is in.

Examples

CommandResult
>react https://discord.com/channels/455185166030209024/672544958359797790/691029306171719700 ❌If you have permission to react to the message, the bot will react to it with the ❌ emoji.
>react above πŸ‡¦ πŸ‡§ πŸ‡¨The bot will react to the most recent message in the channel with the emojis πŸ‡¦, πŸ‡§, and πŸ‡¨.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Usage

Flags

%del causes the command to be deleted immediately after the output is posted. %pin causes the output to be pinned. %mimic causes the bot to use your name and avatar when it posts the message.

Substitution Variables

$u β‡’ your @mention $s β‡’ the server's name $c β‡’ the server's member count $d β‡’ the current date

Arguments

ArgumentPermitted Inputs
[channel]
  • "here" for the current channel
  • The name, #mention, or ID of any text channel on the server where you have permission to send messages
[color]
  • Any hexadecimal color code, which does not need to begin with #
  • "000000," "default," or "none" for the default Discord gray
[url]
  • Any valid URL that points to a public webpage, starting with "http://" or "https://" (no FTP, etc)
  • "none" for no URL
[image]
  • Any direct link to a hosted image with the file extension .png, .jpg, or .gif
  • "none" for no image
[thumbnail]
  • Any direct link to a hosted image with the file extension .png, .jpg, or .gif
  • "none" for no thumbnail
[title]
  • Any text of 256 characters or less.
  • "none" for no title
[text]Any text.

Examples

CommandResult
>quick_embed info 77A0FF https://www.moosebot.info none https://example.com/image1.png "Server Roles" Observers, Members, StaffAn embed with the sidebar colored #77A0FF, the title "Server Roles" with a link to https://www.moosebot.info, a thumbnail from https://example.com/image1.png, no bottom image, and the description "Observers, Members, Staff" will be posted in the #info channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesNone
Premium subscription requiredNo

Usage

A series of prompts will open, allowing you to enter the title of the embed, any number of fields, and footer text. The title can contain up to 256 characters, each field can contain up to 1024 characters, and the entire embed can contain no more than 6000 characters, not including outside text. Any of these titles and fields can include a number of flags and substitution variables.

Flags

%del causes the command to be deleted immediately after the output is posted. %pin causes the output to be pinned. %mimic causes the bot to use your name and avatar when it posts the message.

Substitution Variables

$u β‡’ your @mention $s β‡’ the server's name $c β‡’ the server's member count $d β‡’ the current date

@everyone, @here, and role mentions can be included in [outside text], but if you do not have permission to use those mentions in the destination channel, the mentions will be deactivated.

Arguments

ArgumentPermitted Inputs
[channel]
  • "here" for the current channel
  • The name, #mention, or ID of any text channel on the server where you have permission to send messages
[color]
  • Any hexadecimal color code, which does not need to begin with #
  • "000000," "default," or "none" for the default Discord gray
[url]
  • Any valid URL that points to a public webpage, starting with "http://" or "https://" (no FTP, etc)
  • "none" for no URL
[image]
  • Any direct link to a hosted image with the file extension .png, .jpg, or .gif
  • "none" for no image
[thumbnail]
  • Any direct link to a hosted image with the file extension .png, .jpg, or .gif
  • "none" for no thumbnail
[footer icon]
  • Any direct link to a hosted image with the file extension .png, .jpg, or .gif
  • "none" for no footer icon
[outside text]Any text.

Examples

CommandResult
>embed info 77A0FF https://www.moosebot.info none https://example.com/image1.png https://example.com/image2.png Refer to the below for server information.A prompt will open, allowing you to enter the title, description, footer, and fields of the embed. The text "Refer to the below for server information." will be posted in the #info channel, and an embed with the given inputs will be attached.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namesquick_survey
Premium subscription requiredNo

Effect

All non-bot members will be eligible to vote in the poll. An embed containing the options will be posted in the destination channel, and members will be able to vote using reactions. At the end of the duration, the votes will be tallied and posted in a new message in the same channel.

Arguments

ArgumentPermitted Inputs
[channel]
  • "here" for the current channel
  • The name, #mention, or ID of any text channel on the server where you have permission to send messages
[multi select]
  • "yes" to allow voters to select multiple options
  • "no" to limit voters to a single option
[duration]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
[options]A list of poll options, separated by double commas. There can be a minimum of two and a maximum of twenty options, and each can have no more than 1024 characters.

Examples

CommandResult
>quick_poll surveys yes 3d Blue,,Green,,Red,,Yellow,,Orange,,PurpleAn embed containing the six options will be posted in the #surveys channel, and all members who can see the channel will be able to vote using reactions. Voters will be able to select multiple options. After three days, the results will be counted and posted in a separate message.


[Permalink]


Details

Available in private messagesNo
Permissions tierPower User and above
Alternate namessurvey
Premium subscription requiredNo

Usage

A series of prompts will open, allowing you to enter a title, description, and anywhere from two to twenty voting options. The title can contain up to 256 characters, each option can contain up to 1024 characters, and the entire poll can contain no more than 6000 characters.

Effect

At the start of the voting period, a list of non-bot members who have at least one eligible role will be saved. An embed containing the options will be posted in the destination channel, and members will be able to vote using reactions. At the end of the voting period, the votes submitted by members on the eligibility list will be tallied. All votes from ineligible members will be discarded, and if [multi-select] was "no" and any member selects more than one option, all their votes will be discarded. The results will be posted in a new message in the same channel.

Arguments

ArgumentPermitted Inputs
[channel]
  • "here" for the current channel
  • The name, #mention, or ID of any text channel on the server where you have permission to send messages
[poll type]
  • "server" for public voting on the server
  • "dm" for secret ballots via private message
[multi select]
  • "yes" to allow voters to select multiple options
  • "no" to limit voters to a single option
[duration]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
[eligible roles]A list of roles, separated by double commas. Each role item can be the name, @mention, or ID of a role on the server.

Examples

CommandResult
>poll surveys server no 3d Registered Voters,,Server StaffA prompt will open, allowing you to enter the title, description, and options of the poll. An embed containing the options will be posted in the #surveys channel, and all members who have either the Registered Voters or Server Staff roles will be able to vote using reactions. Voters will not be able to select multiple options. After three days, the results will be counted and posted in a separate message.
>poll surveys dm yes 3d everyoneA prompt will open, allowing you to enter the title, description, and options of the poll. An embed containing the options will be sent to all members of the server via private message, and each recipient will be able to vote privately using reactions. Voters will be able to select multiple options. After three days, the results will be counted and posted in the #surveys channel.


[Permalink]


Meta-Commands

Functions

  • Text Trigger Response: when a message is sent on the server, checks to see if that message contains any trigger phrases defined on the server, and if so, runs the response command for that trigger phrase. This is only available to servers with Premium subscriptions.
  • Reaction Trigger Response: when a reaction is added or removed to or from a message on the server, checks to see if that emoji-message pair match a reaction trigger defined on the server, and if so, runs the response command for that trigger. This is only available to servers with Premium subscriptions.
  • Event Trigger Response: when a member arrives or departs, a user is banned or unbanned, or a role or channel is created or deleted, runs the response command for that event, if any has been defined on the server. This is only available to servers with Premium subscriptions.

Commands

Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredYes

Arguments

ArgumentPermitted Inputs
[commands]A list of commands, separated by double commas or double semicolons. Each command item can be any command (except >combine and >iterate), including aliases, with arguments if required, and does not need to include a prefix.

Examples

CommandResult
>combine server,,post bot_commands Can you read this?,,remindme 5m Check back laterAn embed containing information about the server will be posted in the current channel, the text "Can you read this?" will be posted in the #bot_commands channel, and a reminder will be sent via private message in five minutes.
>combine add_roles SomeMember Role A,,Role B;;post here Success!The roles "Role A" and "Role B" will be added to SomeMember. Then, "Success!" will be posted in the current channel.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredYes

Arguments

ArgumentPermitted Inputs
[mode]
  • "simple" to iterate over rows of inputs, but not columns, so that the command given in [command] runs once for each group of inputs
  • "matrix" to iterate over rows and columns of inputs, so that the command runs once for every possible combination of inputs to each argument
  • "#x" to repeat the command # times with no change in arguments
[command]Any compatible command, including aliases, with no arguments. This command can include a prefix, but it does not need to. If the command's name is one that contains spaces (such as >nexus cluster), it must be surrounded by "quotes."
[input array]Contains each list of inputs that will be provided to each of the command's arguments. Arguments in [input array] should be separated by double semicolons, and the individual inputs contained by each argument in [input array] should be separated by double commas.
  • If [mode] is "simple," for each argument in [input array] the number of inputs must be equal to each other or 1. If you provide to an argument a number of inputs that is not equal to 1 or the number of inputs provided to the other arguments, >iterate will not work.
  • If [mode] is "matrix," each argument in [input array] can have any number of inputs.
  • If [mode] is "#x," [input array] should only contain one argument.

Examples

CommandResult
>iterate simple quick_mention channel_1,, channel_2,, channel_3;; Role_1;; Some example text,, Different example text,, Now with even more example textThis will ping Role_1 and post "Some example text" in #channel_1, ping Role_1 and post "Different example text" in #channel_2, and ping Role_1 and post "Now with even more example text" in #channel_3.
>iterate matrix quick_mention channel_1,, channel_2,, channel_3;; Role_1;; Some example text,, Different example textThis will ping Role_1 and post "Some example text" in #channel_1, #channel_2, and #channel_3; and ping Role_1 and post "Different example text" in #channel_1, #channel_2, and #channel_3.
>iterate 3x quick_mention channel_1 Role_1 Some example textThis will ping Role_1 and post "Some example text" in #channel_1, three times.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredYes

Usage

This command does nothing on its own. It should be used in conjunction with the >combine command to insert a delay between commands.

Arguments

ArgumentPermitted Inputs
[time]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".

Examples

CommandResult
>combine post here Start!,, wait 5m,, post here Stop.The bot will post "Start!" in the current channel, then post "Stop." five minutes later.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesif
Premium subscription requiredYes

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server.
[key]
  • "roles," "nickname," "username," "joined," or "created"
  • A data key, as set by the >edit_user_data command
[relation]
  • If [key] is "roles," this can be "has" or "not"
  • "nickname" or "username": "equals," "contains," or "in"
  • "joined" or "created": "before" or "after"
  • Data key: "equals," "contains," or "in"
[value]
  • If [key] is "roles," this can be the names, @mentions, or IDs of any roles on the server, separated by double commas. If [relation] is "has" or "not," the member must have all or none of the listed roles, respectively.
  • "nickname": Any text, or "none" to match a member with no nickname.
  • "username": Any text.
  • "joined" or "created": A numeric (Unix) timestamp.
  • Data key: Any text, integer, or list of items. [value] can also be "none" to match a null data key or "[]" to match an empty list.
If the value or list of values contains spaces, it must be surrounded by "quotes."
[command]Any command, including aliases, with arguments if desired. The command does not need to include a command prefix. The command must contain either or both of the substitution variables %member_id and %member_name, which are replaced with the ID and username of the given member, respectively.

Examples

CommandResult
>conditional August roles "Verified,, Member" post here %member_name is a verified member.The bot will post "August is a verified member" in the current channel if August has the Verified role and the Member role.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesany
Premium subscription requiredYes

Usage

This command can be combined with >conditional to apply multiple conditions.

Arguments

ArgumentPermitted Inputs
[key]
  • "roles," "nickname," "username," "joined," or "created"
  • A data key, as set by the >edit_user_data command
[relation]
  • If [key] is "roles," this can be "has" or "not"
  • "nickname" or "username": "equals," "contains," or "in"
  • "joined" or "created": "before" or "after"
  • Data key: "equals," "contains," or "in"
[value]
  • If [key] is "roles," this can be the names, @mentions, or IDs of any roles on the server, separated by double commas. If [relation] is "has" or "not," the member must have all or none of the listed roles, respectively.
  • "nickname": Any text, or "none" to match a member with no nickname.
  • "username": Any text.
  • "joined" or "created": A numeric (Unix) timestamp.
  • Data key: Any text, integer, or list of items. [value] can also be "none" to match a null data key or "[]" to match an empty list.
If the value or list of values contains spaces, it must be surrounded by "quotes."
[command]Any command, including aliases, with arguments if desired. The command does not need to include a command prefix. The command must contain either or both of the substitution variables %member_id and %member_name, which are replaced with the ID and username of the given member, respectively.

Examples

CommandResult
>mass_conditional roles "Verified,, Member" post here <@%member_id> is a verified member.The bot will ping every member in the server who has the Verified role and the Member role.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredYes

Usage

You cannot schedule a command to run after midnight in UTC on January 1, 10000.

Effect

Permissions requirements for the command always apply to the member who scheduled the command at the time when the command is supposed to run, regardless of what the member's permissions were at the time of scheduling. For example, if you are a moderator and schedule a command that requires a moderator role, and lose your moderator status before the scheduled time, the command will not run.

Arguments

ArgumentPermitted Inputs
[repeat]
  • "repeat" or "yes" to schedule a repeating command
  • "no-repeat," "norepeat," "no_repeat," or "no" to schedule a command to run once
[time]A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
  • For a repeating command, this argument is the interval on which the command will repeat, and has a minimum of one hour.
  • For a one-time command, this argument is the amount of time that will pass before it runs, and has no minimum.
[command]Any command, including aliases, with arguments if required. This command can include a prefix, but does not need to.

Examples

CommandResult
>schedule repeat 2.5o post here Hello, it's me again.The text "Hello, it's me again." will be posted in the current channel in 2.5 months, and again every 2.5 months after that.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredYes

Usage

You cannot schedule a command to run after midnight in UTC on January 1, 10000. The command interprets times in UTC by default. If you want to schedule a command using your local time, set your timezone (and DST, if applicable) using >set_timezone.

Effect

Permissions requirements for the command always apply to the member who scheduled the command at the time when the command is supposed to run, regardless of what the member's permissions were at the time of scheduling. For example, if you are a moderator and schedule a command that requires a moderator role, and lose your moderator status before the scheduled time, the command will not run.

Arguments

ArgumentPermitted Inputs
[date]Any date before the year 10000, written in day-month-year order.
[time]Any time, formatted as hh:mm:ss on a 24-hour scale (no AM or PM). This time should be written in UTC, or in your local timezone if you have set one using >set_timezone.
[command]Any command, including aliases, with arguments if required. This command can include a prefix, but does not need to.

Examples

CommandResult
>schedule_absolute 31-03-2020 13:45:00 post announcements The time has come!The text "The time has come!" will be posted in the #announcements channel on March 31st, 2020 at 1:45 PM.
>schedule_absolute "1 Jun 19" 4:59:59 post announcements The time has come!The text "The time has come!" will be posted in the #announcements channel on June 1st, 2019 at 4:59:59 AM.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

A list of your scheduled commands and reminders will be sent to you via private message. Each entry will include the command or reminder, the time when it is scheduled to run, whether it will repeat, and the repeat interval, if applicable. Instructions for removing an entry from the queue are included. Commands scheduled via aliases with the %hide_schedule flag are not displayed.

[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Effect

A list of the commands and backups scheduled to run on the server will be sent to you via private message. Each entry will include the command or backup, the time when it is scheduled to run, whether it will repeat, and the repeat interval, if applicable. Instructions for removing an entry from the queue are included.

[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[task ID]
  • The ID of any of your scheduled commands or reminders, as seen with the >view_scheduled command
  • The ID of any command or backup scheduled to run on a server where you are an administrator, as seen with the >view_server_scheduled command

Examples

CommandResult
>remove_scheduled 628693464413896734The scheduled task with the ID 628693464413896734 will be removed from the queue.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

Aliases are an extremely powerful tool for creating custom commands. Not only can you package a long command with lots of arguments into a short alias, you can also include flags and substitution variables to make these commands more dynamic.

Flags

%suppress hides non-essential output from the command, such as "Done."
%delete instantly deletes the message containing the alias.
%admin limits the alias to members in the Administrator permissions tier, overriding the base command's normal permissions requirement. Permissions flags like this one cannot be combined with each other.
%mod limits the alias to Moderators and above.
%power limits the alias to Power Users and above.
%standard allows any member to use the alias.
%nospace causes the whitespace between the alias and any arguments provided to be removed. This flag is incompatible with %noargs.
%noargs causes any arguments provided to the alias to be ignored. This flag is incompatible with %nospace.
%url causes any spaces in arguments provided to the alias to be replaced with the URL-friendly space character %20. This is typically used in aliases that post a link that is modified by user arguments, because an ordinary space would break the link. This flag can only be used in combination with the %nospace flag or the %argX substitution variables.
%hide_schedule prevents the scheduled command from appearing in the user's list of scheduled commands, as seen with >view_scheduled. This flag only has an effect on aliases of >schedule and >schedule_absolute. It is useful if a server's administrators want to set up an alias or trigger that causes standard users to schedule a task, and do not want those users to be able to cancel that task.
%toggle_mod_logs toggles the bot's Moderation Logging setting, just for that alias instead of server-wide. This flag only has an effect on aliases of >mute, >kick, and >ban. For example, if the setting is enabled and this flag is used with an alias of >mute, the bot skips the prompt for a reason, and simply mutes the target member. This is especially useful for creating triggers.
%toggle_hierarchy toggles the bot's Respect Hierarchy setting, just for that alias instead of server-wide. For example, if the setting is enabled and the flag is used with an alias of >remove_role, the bot will remove the given role even if it is above the command author's highest role.
%toggle_permissions toggles the bot's Respect Permissions setting, just for that alias instead of server-wide. For example, if the setting is enabled and the flag is used with an alias of >post, the bot will post a message in the given channel even if the command author does not have permission to send messages there.
If the %admin, %mod, %power, %standard, %suppress, %hide_schedule, %toggle_mod_logs, %toggle_hierarchy, or %toggle_permissions flags are used in an alias of >combine, or of any command that calls other commands, the flags will apply to those other commands as well. For example, >alias add test1 combine post here Testing,,react above ⏫ %standard would create an alias usable by any member, even though all three commands are normally limited to Power Users.

Substitution Variables

%author_id β‡’ the ID of the user who called the alias
%author_name β‡’ the name of the user who called the alias
%channel_id β‡’ the ID of the channel where the alias was called
%channel_name β‡’ the name of the channel where the alias was called
%server_id β‡’ the ID of the server where the alias was called
%server_name β‡’ the name of the server where the alias was called
%message_id β‡’ the ID of the message containing the alias
%last_message_id β‡’ the ID of the last message in the current channel
%date β‡’ the current date, formatted like "Monday, October 07, 2019"
%time β‡’ the current date and time, formatted like "07 Oct 2019 14:34:09"
%member_count β‡’ the server's member count
%prefix β‡’ the bot's command prefix on the server
%%USER_ID:key%% β‡’ the value from one of a member's saved key/value pairs on the server, as set with >set_data and viewed with >view_data. USER_ID should be replaced with the ID of a member of the server, and key should be replaced with one of their saved keys. If the ID does not belong to a server member, the substitution will not take place, and if the given key is not one of the member's saved keys, the phrase "(not found)" will be substituted.
%argX, where X is any integer greater than zero, is replaced with the argument provided to the alias in position X. This allows you to reposition arguments and use them multiple times in a single command. When using these variables, arguments cannot contain spaces except for the last argument, which can have any number of words.
Many commands allow you to use object IDs instead of names in arguments. Unlike names, IDs never change and never contain spaces. If you need to mention a user, role, or channel, you can use the strings <@USER_ID>, <@&ROLE_ID>, or <#CHANNEL_ID> respectively, replacing the middle text with the actual ID.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to create a new alias
  • "edit" to modify the response of an existing alias
  • "remove" or "delete" to remove an alias
  • "list" to show all the aliases existing on the server
[*alias]Any text that does not contain spaces or line breaks and does not match the name of an existing command. When [operation] is "add," "edit," or "remove," this argument is required.
[*full command]Any command you have the permissions to use, with arguments if desired, but not another alias. This command can include a prefix, but it does not need to. If [operation] is "add" or "edit," the [full command] argument is required.

Examples

CommandResult
>alias add image post here https://duckduckgo.com/?ia=images&iax=images&q= %standard %url %nospaceAll members of the server will be able to use the >image alias to post links to DuckDuckGo image searches. For example, >image United States will return images of the United States.
>alias add favorite_color post here <@%arg1>'s favorite color is %%%arg1:favorite_color%%. %suppress %deleteAny Power User and above (because that is the permissions tier for >post) will be able to use the >favorite_color [user ID] alias to post any member's favorite color, as long as they have one saved in their user data. If a Standard User tries to use the alias, the permission warning will be suppressed. Either way, the command will be instantly deleted.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

When [operation] is "add" or "edit," a prompt will open, allowing you to enter the command that runs in response to the trigger phrase. This command can be an alias and can include arguments, and can include a prefix, but does not need to. It can also include a number of flags.

Another prompt will open, allowing you to specify a channel where the trigger should be available. You can provide the name, #mention, or ID of any text channel on the server, or "all" if you want the trigger to be available in every channel.

Permissions requirements for the response command apply to the member who posted the trigger phrase, not the member who created the trigger.

Flags

%case_sensitive requires the message text to match the case of the trigger phrase. Without it, the text "abc" will match the trigger "B".
%message_equals requires the message text to match the trigger phrase exactly. Without it, the text "Bleep bloop!!" matches the trigger phrase "Bleep bloop".
%message_contains requires the message text to contain the trigger phrase. If neither %message_equals nor %message_in are included, this flag is implied, even if it is not included.
%is_word requires the message text to contain a word that exactly matches the trigger phrase. This flag cannot be used with a trigger phrase that contains spaces, or with the %message_equals or %message_in flags. Without it, the text "cat in the hat" will match the trigger word "at".
%message_in requires the message text to exist within the trigger phrase.

Effect

Permissions requirements for the response command apply to the member who posted the trigger phrase, not the member who created the trigger.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to create a new trigger
  • "edit" to modify the response of an existing trigger
  • "remove" or "delete" to remove a trigger
  • "list" to show all the triggers existing on the server
[*channel]
  • The name, #mention, or ID of a text channel on the server where the trigger should be available
  • "all" to make the trigger available in all channels
When [operation] is "add," "edit," or "remove," this argument is required.
[*trigger]
  • Any text between 3 and 1950 characters
  • "any" to match any message
When [operation] is "add," "edit," or "remove," this argument is required.

Examples

CommandResult
>text_trigger add #access_requests Please give me access %equalsA prompt will open, allowing you to enter the command that will run in response to this trigger. If you set the command to >request Server Access, the Server Access role will be given to a member when they say the exact phrase "Please give me access" in the #access_requests channel.
>text_trigger remove all bleep bloopIf there is a server-wide trigger (all channels) for the phrase "bleep bloop," it will be removed.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

The bot will not validate the message ID to make sure it points to an existing message. Permissions requirements for the response command apply to the member who added the reaction, not the member who created the trigger.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to create a new trigger
  • "edit" to modify the response of an existing trigger
  • "remove" or "delete" to remove a trigger
  • "list" to show all the triggers existing on the server
[*message ID]The ID of any message on the server. When [operation] is "add," "edit," or "remove," this argument is required.
[*emoji]Any emoji, custom or Unicode. When [operation] is "add," "edit," or "remove," this argument is required.
[*command]Any command, including aliases, with arguments if desired. This command can include a prefix, but does not need to. When [operation] is "add" or "edit," this argument is required.

Examples

CommandResult
>reaction_trigger add 691055570828132463 πŸ‘‹ post general Hi there!When a member reacts with the πŸ‘‹ emoji to the message with the ID 691055570828132463, the text "Hi there!" will be posted in the #general channel.
>reaction_trigger remove 691055570828132463 πŸ‘‹When a member reacts with the πŸ‘‹ emoji to the message with the ID 691055570828132463, no response will be triggered.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

The bot will not validate the message ID to make sure it points to an existing message. Permissions requirements for the response command apply to the member whose reaction is being removed, not the member who created the trigger.

Effect

The response to a reaction removal trigger will execute when the given reaction is removed from the given message, regardless of who removes it.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to create a new trigger
  • "edit" to modify the response of an existing trigger
  • "remove" or "delete" to remove a trigger
  • "list" to show all the triggers existing on the server
[*message ID]The ID of any message on the server. When [operation] is "add," "edit," or "remove," this argument is required.
[*emoji]Any emoji, custom or Unicode. When [operation] is "add," "edit," or "remove," this argument is required.
[*command]Any command, including aliases, with arguments if desired. This command can include a prefix, but does not need to. When [operation] is "add" or "edit," this argument is required.

Examples

CommandResult
>reaction_removal_trigger add 947077703125860352 πŸ“’ remove_alerts_roleAssume remove_alerts_role is an alias for >remove_role %author_id Alerts %standard %suppress. When a πŸ“’ reaction is removed from the message with the ID 947077703125860352, the role Alerts will be removed from the member who had added the reaction.
>reaction_removal_trigger remove 947077703125860352 πŸ“’When a πŸ“’ reaction is removed from the message with the ID 947077703125860352, no response will be triggered.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredYes

Usage

Permissions requirements for the response command always apply to the member who created the event trigger, regardless of any members involved in the event.

Substitution Variables

%name β‡’ the name of the object involved (for example, in the response command for a "member_join" event, %name will be replaced with the member's name) %id β‡’ the object's ID %server β‡’ the server's name %member_ct β‡’ the number of members on the server %role_ct β‡’ the number of roles on the server %channel_ct β‡’ the number of channels on the server %time β‡’ the current date and time %created β‡’ the date and time of the object's creation %avatar β‡’ the URL of the user's avatar in PNG format, for use only with the "member_join," "member_leave," "user_ban," and "user_unban" events

Arguments

ArgumentPermitted Inputs
[event name]
  • The name of any available server event, including "member_join," "member_leave," "user_ban," "user_unban," "role_create," "role_delete," "channel_create," and "channel_delete"
  • "list" to show all the events available for use with this command, including those without responses registered
[*command]Any command, including aliases, with arguments if desired. This command can include a prefix, but does not need to. It can also include a number of substitution variables, which are replaced with some value when the event occurs and the response command is called. If [event name] is not "list," the [command] argument is required.

Examples

CommandResult
>event_trigger member_join post general Welcome to %server, %name! Congratulations on being member #%member_ct!When a member (named August) arrives in the server (named World Expo, with 100 members), the text "Welcome to World Expo, August! Congratulations on being member #101!" will be posted in the #general channel.
>event_trigger channel_create noneWhen a channel is created on the server, no response will be triggered.


[Permalink]


Moderation

Functions

  • Mute Check: when a departed member returns to the server, checks to see if that member has an outstanding mute on the server, and if so, denies the Send Messages or Speak permission in each channel of the server to that member.
  • Mute New Channel: when a channel is created on the server, denies the Send Messages or Speak permission in that channel to each member who is muted on the server, if any.

Commands

Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

The moderator who issued the case cannot rule on the appeal, and if you are yourself a moderator, you cannot rule on the appeal. You can only appeal a case once. You cannot appeal a case issued by a server where the bot is no longer present, or by a server that has disabled this command, even if you are using it in private messages or on another server.

Effect

An embed containing this reason, your name, the case ID, the action taken against you, and the moderator who issued the case will be posted in the server's staff channel. If no staff channel is available, the appeal will be sent to the server owner via private message, and if they are not accepting private messages from the bot, the delivery will fail. This message will include control buttons that allow server staff to accept the appeal (removing the case from your record) or deny it. In either case, you will be notified of the result via private messate. If the appeal is accepted and you were muted or banned as part of the case, you will be unmuted or unbanned, respectively. If the appeal is not accepted or denied within thirty minutes, it will time out, although server staff can still edit your cases with the >casefile command and notify you manually.

Arguments

ArgumentPermitted Inputs
[case ID]The ID of any moderation case against you, as provided in the notification sent to you via private message when the case was created.
[reason]Any text.

Examples

CommandResult
>appeal 1584860908 It was a mistake.The text "It was a mistake." will be sent to the staff channel of the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The message containing the command will be deleted instantly. A message containing the [description] argument will be sent to the staff channel of the server, along with your name and the name of the channel where you sent the report. If the server has no staff channel, it will be sent to the server owner via private message.

Arguments

ArgumentPermitted Inputs
[description]Any text.

Examples

CommandResult
>report August was spamming pings.The text "August was spamming pings." will be sent to the staff channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

If [target] is a user, that user will not be able to use the bot's commands anywhere on the server, and their Nexus messages will not be transmitted to or from your server. If it is a channel on the server, members will not be able to use commands in that channel. If it is a role on the server, members with that role will not be able to use commands on the server. If it is the ID of the server, members will not be able to use commands there at all. If it is the ID of another server, Nexus messages originating there will not appear on your server, and the other server will not be able to send Nexus invites to your server. Members of your server with the Administrator permission are immune to these restrictions on command usage. If [time] is included, the blacklist entry will be removed automatically once the given time has passed.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to add a target to the server's blacklist
  • "remove" to remove a target from the server's blacklist
  • "list" to list all the targets on the server's blacklist
[*target]
  • The name, @mention, or ID of any member of the server
  • The ID of any user not on the server
  • The name, @mention, or ID of any role on the server
  • The name, #mention, or ID of any text channel on the server
  • The ID of any server
If [operation] is "add" or "remove," this argument is required.
[*time]This argument determines how long the target will be blacklisted.
  • Leave blank for an indefinite blacklisting.
  • A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
If [operation] is "remove" or "list," this argument should be left blank.

Examples

CommandResult
>blacklist add August 1dAugust will not be able to use commands on the server for the next day.
>blacklist add #generalAny member (without the Administrator permission) will not be able to use commands in the #general channel.
>blacklist add 455185166030209024The support server (which has the ID 455185166030209024) will not be able to send the server Nexus invites or messages.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

When the whitelist contains any entries, all members are prevented from using the bot's commands on the server unless they meet at least one of the whitelisted criteria. In other words, any whitelisted member can use commands anywhere on the server, any member can use commands in a whitelisted channel, and any member who has at least one whitelisted role can use commands anywhere on the server. Members of the server with the Administrator permission are immune to these restrictions on command usage.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to add a target to the server's whitelist
  • "remove" to remove a target from the server's whitelist
  • "list" to list all the targets on the server's whitelist
[*target]
  • The name, @mention, or ID of any member of the server
  • The name, @mention, or ID of any role on the server
  • The name, #mention, or ID of any text channel on the server
If [operation] is "add" or "remove," this argument is required.

Examples

CommandResult
>whitelist add AugustOnly August will be able to use commands on the server. (See next example.)
>whitelist add #generalMembers will only be able to use commands in the #general channel, except for August, who was whitelisted in the previous example and can use commands anywhere on the server. (See next example.)
>whitelist add @VisitorMembers will only be able to use commands if they have the Visitor role, are in #general, or are August.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namespurge and clear
Premium subscription requiredNo

Usage

[number] determines the number of messages to be deleted in the given channel, starting with the most recent. If the given channel is the channel where the >delete command is used, [number] is automatically increased by one to include the command itself. [number] can also be a message ID, to delete a single message.

Effect

If [criteria] is included, only the last [number] messages matching the criteria will be deleted. Deleting messages older than two weeks is a very slow operation, due to Discord limitations.

Arguments

ArgumentPermitted Inputs
[channel]
  • "here" for the current channel
  • The name, #mention, or ID of any text channel on the server
[number]
  • Any positive integer
  • The ID of a message in the given channel
[*criteria]Can contain the flag %skip to skip over the command message itself; %text to delete text-only messages; %file to delete only messages with attachments or embeds; and the nickname, username, @mention, or ID of any member of the server, or the @mention or ID of any Discord user, to delete only messages sent by that user.

Examples

CommandResult
>delete here 100 August %fileThe last 100 messages in the current channel that were sent by August and contain attachments will be deleted.
>delete general 5The last 5 messages in the #general channel will be deleted.
>delete here 766902053221433345The message in the current channel with the ID 766902053221433345 will be deleted.
>delete here 10 %skipThe last 10 messages in the current channel, not including the command message, will be deleted.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredYes

Usage

Message backups must be enabled in Deluxe Settings. A cooldown period follows every use of this command. The duration is 1 hour * messages deleted / 1000. For example, if the command is used to delete 500 messages, it cannot be used again for another half hour.

Effect

The bot makes a list of all messages on the server that match the criteria, then starts deleting them in order from newest to oldest. No more than 1000 messages will be deleted under any circumstances. If the [keyword] argument is included, messages containing the keyword text, which is case-sensitive, will be deleted.

Arguments

ArgumentPermitted Inputs
[number]
  • "all" to delete as many messages as possible
  • An integer (1000 or less) to specify the maximum number of messages to delete
[channel]
  • "all" for all channels on the server
  • "here" for the current channel
  • The name, #mention, or ID of any channel on the server
[author]
  • "any" for any author
  • The nickname, username, @mention, or ID of any user, whether or not they are currently a member
[*keyword]
  • Leave blank to match any message contents
  • Any text

Examples

CommandResult
>keyword_delete 100 all anyThe last 100 messages posted to the server will be deleted.
>keyword_delete all all August mooseEvery message on the server in which August said "moose" will be deleted.
>keyword_delete 50 #general any discord.gg/The last 50 messages in #general containing invite links will be deleted.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesvom
Premium subscription requiredNo

Usage

A prompt will open, allowing you to enter the text to be sent. Alternatively, you can put this text at the end of the [member] argument.

Effect

The message will be sent to the member, with another copy posted as an embed in the server's staff channel, or in the current channel if no staff channel is available. The member will not know who sent the messageβ€”only the name of the server, and that it was sent by a moderator.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any non-bot member of the server.

Examples

CommandResult
>voice_of_mod AugustA prompt will open, allowing you to enter some text. August will receive a private message that contains this text.
>voice_of_mod @August#4079 This is an informal warning.August will receive a private message that says "This is an informal warning."


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Usage

A prompt will open, allowing you to enter the reason for the warning. Alternatively, you can put the reason at the end of the [member] argument.

Effect

The warning will be recorded in the member's casefile, and the member will be privately notified with the reason and instructions for appeal. An embed containing all information about the case will be posted in the server's staff channel, or in the current channel if no staff channel is available.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any non-bot member of the server.

Examples

CommandResult
>warn AugustA prompt will open, allowing you to enter a reason for the warning. August will receive a private message that contains this reason.
>warn @August#4079 Spamming in #general.August will receive a private message that contains a warning for "Spamming in #general."


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesinstamute
Premium subscription requiredNo

Usage

The syntax for this command is unusually forgiving. In addition to the standard syntax, >mute [member] and >mute [member] [time] are also acceptable.

If the Moderation Logging setting is enabled in >settings, a prompt will open, allowing you to enter the reason for the mute. Alternatively, you can put the reason at the end of the [member] argument.

Effect

The member will be muted in all channels on the server via permissions overrides. If a new channel is created while the mute is ongoing, the member will be muted in this channel automatically. If the member leaves the server and returns, the mute will be restored, although it may take a few seconds in servers with a high number of channels. If the [time] argument is not "0," the mute will be removed automatically once the given time has passed. If the Moderation Logging setting is enabled, the mute will be recorded in the member's casefile, the member will be privately notified with the reason and instructions for appeal, and the first 512 characters of the reason will be recorded in the Audit Log. An embed containing all information about the case will be posted in the server's staff channel, or in the current channel if no staff channel is available.

Arguments

ArgumentPermitted Inputs
[time]This argument determines how long the target will be muted.
  • "0" for an indefinite mute
  • A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
[member]The nickname, username, @mention, or ID of any member of the server who is not already muted. Note that bots can be muted, but cannot receive the warning if one is included. Members with the Administrator permission can receive the warning, but cannot be muted.

Examples

CommandResult
>mute 2d AugustIf Moderation Logging is enabled, a prompt will open, allowing you to enter a reason for the mute. August will receive a private message that contains this reason. Then, August will not be able to post on the server or speak in voice channels for two days.
>mute augustIf Moderation Logging is enabled, a prompt will open, allowing you to enter a reason for the mute. August will receive a private message that contains this reason. Then, August will not be able to post on the server or speak in voice channels until the mute is removed.
>mute 2d @August#4079 Spamming in #general.If Moderation Logging is enabled, August will receive a private message that contains a notification of the mute and a warning for "Spamming in #general." Then, August will not be able to post on the server or speak in voice channels for two days.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

This command ends an ongoing mute created by the >mute command. If the Respect Hierarchy setting is enabled in Bot Settings, the command will have no effect on members whose top role is not below the author's top role.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server who is currently muted.

Examples

CommandResult
>unmute AugustIf August was muted with the >mute command, the account will be unmuted.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

This command has no effect on members with the Administrator permission. The member will be muted in the current channel via permissions overrides. If the Respect Hierarchy setting is enabled in Bot Settings, the command will have no effect on members whose top role is not below the author's top role.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server, other than the bot.

Examples

CommandResult
>channel_mute AugustAugust will not be able to post in the current channel.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

This command ends an ongoing mute created by the >channel_mute command. If the Respect Hierarchy setting is enabled in Bot Settings, the command will have no effect on members whose top role is not below the author's top role.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server, other than the bot.

Examples

CommandResult
>channel_unmute AugustIf August was muted in the current channel with the >channel_unmute command, the account will be unmuted there.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesinstakick
Premium subscription requiredNo

Usage

If the Moderation Logging setting is enabled in >settings, a prompt will open, allowing you to enter the reason for the kick. Alternatively, you can put the reason at the end of the [member] argument.

Effect

The member will be kicked from the server. If the Moderation Logging setting is enabled, the kick will be recorded in the member's casefile, the member will be privately notified with the reason and instructions for appeal, and the first 512 characters of the reason will be recorded in the Audit Log. An embed containing all information about the case will be posted in the server's staff channel, or in the current channel if no staff channel is available.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server except the owner. Note that bots can be kicked, but cannot receive the warning if one is included.

Examples

CommandResult
>kick AugustIf Moderation Logging is enabled, a prompt will open, allowing you to enter a reason for the kick. August will receive a private message that contains this reason. Then, August will be kicked from the server.
>kick @August#4079 Spamming in #general.If Moderation Logging is enabled, August will receive a private message that contains a notification of the kick and a warning for "Spamming in #general." Then, August will be kicked from the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesinstaban
Premium subscription requiredNo

Usage

If the Moderation Logging setting is enabled in >settings and the user is currently on the server, a prompt will open, allowing you to enter the reason for the ban. Alternatively, you can put the reason at the end of the [user] argument.

Effect

The user will be banned from the server. No messages will be deleted. If the Moderation Logging setting is enabled and the user was a member of the server, the ban will be recorded in the member's casefile, the member will be privately notified with the reason and instructions for appeal, and the first 512 characters of the reason will be recorded in the Audit Log. An embed containing all information about the case will be posted in the server's staff channel, or in the current channel if no staff channel is available.

Arguments

ArgumentPermitted Inputs
[user]
  • The nickname, username, @mention, or ID of any member of the server except the owner
  • The ID of any user not on the server
Note that bots can be banned, but cannot receive the warning if one is included.

Examples

CommandResult
>ban AugustIf Moderation Logging is enabled, a prompt will open, allowing you to enter a reason for the ban. August will receive a private message that contains this reason. Then, August will be banned from the server.
>ban @August#4079 Spamming in #general.If Moderation Logging is enabled, August will receive a private message that contains a notification of the ban and a warning for "Spamming in #general." Then, August will be banned from the server.
>ban 414881613806043136August2 (who has the ID 414881613806043136 and is not present on the server) will be banned from the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[user]The name or ID of any user on the server's ban list.

Examples

CommandResult
>unban 213088304537534464August (who has the ID 213088304537534464) will be unbanned from the server.
>unban augustAugust will be unbanned from the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Usage

You can view your own cases, but not edit or delete them.

Effect

A navigable menu containing all the cases where moderation action was taken against the user on the server will be posted in the channel, allowing you to view, edit, and delete those cases using reactions.

Arguments

ArgumentPermitted Inputs
[user]
  • The nickname, username, @mention, or ID of any member of the server
  • The ID of any user who is no longer on the server but has had moderation cases issued against them there

Examples

CommandResult
>casefile AugustA menu containing August's casefile from the current server will be posted, allowing you to view, edit, and delete those cases.


[Permalink]


Details

Available in private messagesNo
Permissions tierModerator and above
Alternate namesNone
Premium subscription requiredNo

Effect

A list of all of the usernames the member has had while the bot shared a server with them, as well as all the nicknames they had on the current server in that time, will be posted in the channel.

Arguments

ArgumentPermitted Inputs
[member]The nickname, username, @mention, or ID of any member of the server.

Examples

CommandResult
>list_names AugustAll of August's known usernames, and all of August's known nicknames on this server, will be posted in the channel.


[Permalink]


Moose

Functions

None.

Commands

Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

By default, your timezone is UTC+0 and DST is disabled. Changing these settings will permit you to input your local time to commands that take dates and times as arguments, such as >schedule_absolute. This has no effect on the timestamps the bot displays to you, which are always shown in your local time.

Arguments

ArgumentPermitted Inputs
[timezone]
  • A UTC offset, which must include a + or - sign followed by an integer
  • "dst" to enable or disable Daylight Savings Time

Examples

CommandResult
>set_timezone -5Your timezone will be set to UTC-5, or US Eastern Standard Time. When you use commands such as >schedule_absolute, the bot will interpret your date and time input as being in that timezone.
>set_timezone +0Your timezone will be set to UTC+0, or Greenwich Mean Time.
>set_timezone dstDaylight Savings Time will be enabled for you.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesbug
Premium subscription requiredNo

Usage

Please be clear and precise when reporting problems. Avoid saying things like "the bot broke." The best tickets have three pieces of information: what should have happened, what did happen, and the IDs (not names) of any users, roles, or channels involved.

For reporting security vulnerabilities, use the developer@moosebot.info email address, not this command.

Effect

The command posts the description in a ticket channel on the support server, along with your name and the channel and server of origin. Typically, a developer will respond in that channel via the bot. To send a message back, use >ticket again.

Arguments

ArgumentPermitted Inputs
[description]Any text that clearly describes the problem you are experiencing.

Examples

CommandResult
>ticket I tried to retrieve event logs, and the bot said it was working on it, but stopped typing and never sent the link.The ticket will be sent to a channel on the support server, where it will be reviewed as soon as possible.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesabout, info, invite, donate, and uptime
Premium subscription requiredNo

Effect

The output shows when this bot instance was created (not necessarily when the first instance was created); the username and discriminator of the bot's creator; the link to invite the bot's Main Edition to a server; an invite link for the support server; the bot's uptime over one day, one week, and three months; the time and length of the last period of downtime; the current and all-time numbers of unique accounts and servers that have used the bot; specifications for the host server; a donation link; and the bot's user ID.

[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The command provides two numbers: the time it takes for information to pass from the bot to Discord and back over WebSocket, and the time it takes over HTTP. This is unrelated to the speed of the user's connection. The command also provides a link to https://discordstatus.com/.

[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The command accounts for all factors that determine whether you can use a particular command at all, including aliases with permission overrides. It does not account for limitations within commands, such as the fact that >post cannot be used to send a message to a channel where you do not have permission to send a message manually. If you are not authorized to use the command, the output will explain why, just as it would if you had tried the command itself.

Arguments

ArgumentPermitted Inputs
[command]Any command, including alternate names and aliases, without arguments. This command can include a prefix, but does not need to. Any arguments you include will be ignored.

Examples

CommandResult
>can_i_run banYou will be informed of whether you can use the >ban command in the current channel at the current time, and if not, why.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

If any member of the given permissions tier (Standard User, Power User, Moderator, Administrator) could run the given command, the given command runs. Otherwise, the output informs you of which permissions tier is needed to run the command. Either way, it will fail if you are not authorized to run the command yourself, so this is mostly useful for administrators testing aliases with permission overrides.

Arguments

ArgumentPermitted Inputs
[permissions tier]"standard," "power," "mod," or "admin," corresponding with the user-controllable permissions tiers offered by the bot.
[command]Any command, including alternate names and aliases, with arguments if desired. This command can include a prefix, but does not need to.

Examples

CommandResult
>run_as standard ban AugustUnauthorized: you must be a Moderator or higher to use that command.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate nameslibraries and dependencies
Premium subscription requiredNo


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

You do not need to format any part of the description, and you do not need to include your name unless you want us to credit you under a name other than your username.

Effect

The idea will be sent to our Creative Uses inbox. There it will be reviewed, and if it is accepted, it will be posted to the website with accreditation.

Arguments

ArgumentPermitted Inputs
[description]A description of your idea and clear instructions for how to implement it using the bot.

Examples

CommandResult
>submit_creative_use Create a command that searches Wikipedia. 1) Find Wikipedia's search URL, which is https://en.wikipedia.org/w/index.php?sort=relevance&search=. 2) Create the alias with >alias add wiki post here https://en.wikipedia.org/w/index.php?sort=relevance&search= %standard %nospace %url. 3) Search Wikipedia with >wiki your search term.Your idea will be sent to our Creative Uses inbox, where we will review it.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The command sends you a menu via private message. This menu shows all public commands, sorted by module and listed alphabetically, regardless of whether you can use them on any servers you may be on. Help pages for server-specific commands may be accessed by using this command on those servers.

Arguments

ArgumentPermitted Inputs
[*command]
  • Leave blank for the main help menu.
  • Any command, including alternate names but excluding aliases, without arguments. This command can include a prefix, but does not need to.

Examples

CommandResult
>helpThe help menu will open in your private messages.
>help combineThe help page for the >combine command will open in your private messages.


[Permalink]


Nexus

Functions

  • Sort Messages: when a message is sent in any Nexus stream channel, converts it to an embed format, transfers it across editions of the bot, and distributes it to all servers connected to the stream using webhooks. This function also handles cross-bot message edits, deletions, and embassy invites and receipts.
  • Reaction Monitor: when a user reacts to a message in a Nexus global or cluster stream with ❌, πŸ‡½, βœ–, or ❎, sends a link to the reported message and information identifying the reporter to the Nexus report channel on the bot's support server, where the Nexus Global Moderators can quickly handle it.

    When a user reacts to one of their own messages in a Nexus stream with ✏ or πŸ—‘, the bot allows them to globally edit or delete the message.

    When a Nexus cluster owner reacts to any message in their cluster stream with πŸ—‘ or πŸ”¨, the bot allows them to globally delete the message or ban the user who sent it.

Commands

Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The original Nexus message will be deleted on each server where it was delivered, assuming the bot is still present on that server.

Arguments

ArgumentPermitted Inputs
[message link]The link to any Nexus message you have authored, which does not need to be the original copy.

Examples

CommandResult
>nexus delete https://discord.com/channels/455185166030209024/672544958359797790/849324832659472464That Nexus message will be deleted globally.


[Permalink]


Details

Available in private messagesNo
Permissions tierStandard User and above
Alternate namesnexus list_streams
Premium subscription requiredNo

Effect

Instructions for managing Nexus streams are included with this command.

[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

If the cluster requires a password, a prompt will open, allowing you to enter the password.

Effect

If the server succeeds in joining the cluster, a channel will be created. This channel will be named after the cluster, the topic will include basic information about the Nexus, and the Nexus banner will be posted there. The cluster stream will begin running in the channel immediately.

Arguments

ArgumentPermitted Inputs
[cluster ID]The ID of any cluster the server is not in.

Examples

CommandResult
>nexus join_cluster 691050717657432167The server will join the Nexus cluster with the ID 691050717657432167. If the cluster has a password, a prompt will open, and you will need to enter the correct password first.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

A server cannot have more than one outbound invite pending.

Effect

If the other server has blacklisted you or your server, either server has the maximum number of channels (500), or the other server does not have a staff channel where the bot can deliver the invite, the invite will fail, and you will be notified. If the invite is delivered successfully, an embed containing the invite and identifying information about you and your server will be posted in the other server's staff channel. Staff members in the other server will have six minutes to accept or reject the invite using reactions. If the time runs out and the invite expires, or the other server rejects the invite, you will be notified. If the other server accepts, an embassy channel will be created in both servers. This channel will be named after the opposite server, the topic will include basic information about the Nexus, and the Nexus banner will be posted there. The embassy stream will begin running in the channel immediately.

Arguments

ArgumentPermitted Inputs
[server ID]The ID of any server except your own and those your server already has embassies with.

Examples

CommandResult
>nexus invite 455185166030209024An invitation to establish an embassy with your server will be delivered to the support server (which has the ID 455185166030209024), and staff members there will have six minutes to accept the invitation.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

A prompt will open, allowing you to set a password for the cluster. The password is optional, and if you choose to set one, servers will need to provide it before they can join the cluster.

Effect

This command will provide you with a cluster ID and limited instructions for managing the new cluster.

Arguments

ArgumentPermitted Inputs
[name]Any text, which will serve as the name of the cluster.

Examples

CommandResult
>nexus create_cluster The AllianceA Nexus cluster named "The Alliance" will be created with you as the owner.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesnexus set_stream
Premium subscription requiredNo

Usage

Deactivated streams can be reactivated simply by setting a new channel for that stream with this command.

Effect

When you set a channel for any stream, the Nexus banner and information about the stream will be posted in the channel.

Arguments

ArgumentPermitted Inputs
[stream]
  • "news" or "chat" to set a channel for one of the global streams
  • The ID of a server that has a Nexus embassy with yours
  • The ID of a Nexus cluster that your server is in
  • The name, #mention, or ID of a channel that currently houses a Nexus stream
[channel]
  • The name, #mention, or ID of a channel on the current server
  • "none" to deactivate the stream

Examples

CommandResult
>nexus set_channel chat nexus_chatThe Nexus global chat stream will open in the #nexus_chat channel, and close in the channel where it was previously open, if any.
>nexus set_channel 455185166030209024 noneThe embassy with the support server (which has the ID 455185166030209024) will close.
>nexus set_channel #embassy #new_embassyThe Nexus stream operating in #embassy will instead operate in #new_embassy.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[message link]The link to a message (not necessarily the original) in a Nexus cluster channel.

Examples

CommandResult
>nexus cluster_delete https://discord.com/channels/455185166030209024/672544958359797790/691029306171719700All copies of the message located at the link will be deleted.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Usage

The bot will not validate the target ID to make sure it belongs to an actual user or server.

Effect

A banned user will be able to post in the cluster's channel, assuming they have permission to do so on the server, but their messages will not be transmitted. A server in the cluster, once banned, will be removed from the cluster, and the cluster's channel on that server will continue to exist but not receive outside messages. A server outside the cluster, once banned, will not be able to join.

Arguments

ArgumentPermitted Inputs
[cluster ID]The ID of a cluster you own.
[operation]
  • "add" to add the target to the ban list, unless it is already there
  • "remove" to remove the target from the ban list, if it is there
  • "list" to show the users and servers that are on the ban list, along with the expiration times where applicable
[*target ID]The ID of any user or server. If [operation] is "add" or "remove," this argument is required.
[*time]This argument determines how long the ban will last.
  • Leave blank for an indefinite ban
  • A positive number followed by a single-letter unit. Units include seconds (s), minutes (m), hours (h), days (d), weeks (w), months (o), and years (y). For example, two and a half months would be written as "2.5o".
If [operation] is not "add," this argument should be left blank.

Examples

CommandResult
>nexus cluster_ban 691050717657432167 add 213088304537534464 1wMessages sent by August (who has the ID 213088304537534464) in the Nexus cluster with the ID 691050717657432167 will not be transmitted to other servers for the next week.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[cluster ID]The ID of any cluster the server is in.

Examples

CommandResult
>nexus leave_cluster 691050717657432167The server will leave the Nexus cluster with the ID 691050717657432167.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Arguments

ArgumentPermitted Inputs
[cluster ID]The ID of a Nexus cluster that you own, which you are given when you create a cluster.
[operation]
  • "delete" to delete the cluster
  • "rename" to rename the cluster
  • "password" to add, remove, or change the case-sensitive password that servers must provide to join the cluster
  • "transfer" to transfer ownership of the cluster to another user account
  • "list" to list the servers connected to the cluster
  • "remove" to kick one of those servers from the cluster
  • "description" to change the cluster's description on the public directory
  • "add_mod" to add a moderator, who can delete messages and ban users from the cluster
  • "remove_mod" to remove a moderator
  • "view" to display information about the cluster
[*input]
  • If [operation] is "rename," any text
  • If [operation] is "password," any text, or "none" to remove the password
  • If [operation] is "transfer," any user ID except your own or that of a bot
  • If [operation] is "remove," the ID of any server in the cluster
  • If [operation] is "description," any text
  • If [operation] is "add_mod" or "remove_mod," the nickname, username, @mention, or ID of any member of the server, or the ID of any Discord user
If [operation] is "rename," "password," "transfer," "remove," "description," "add_mod," or "remove_mod," this argument is required.

Examples

CommandResult
>nexus cluster rename 691050717657432167 Virgo SuperclusterThe Nexus cluster with the ID 691050717657432167 will be renamed to "Virgo Supercluster."
>nexus cluster password 691050717657432167 YouCan'tGetInTo join the Nexus cluster with the ID 691050717657432167, servers will need to enter the password "YouCan'tGetIn."


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

Compact Mode is disabled by default. To enable it, use the command once. To disable it, use the command again.

Effect

Compact Mode eliminates embeds so that Nexus messages look like ordinary user messages, at the price of also eliminating the sender's user and server names and IDs.

Arguments

ArgumentPermitted Inputs
[stream]
  • "news" or "chat" for one of the global streams
  • The ID of a server that has a Nexus embassy with yours
  • The ID of a Nexus cluster that your server is in
  • The name, #mention, or ID of a channel that currently houses a Nexus stream

Examples

CommandResult
>nexus set_compact chatCompact Mode will be enabled for the Nexus global chat stream on the server, or disabled if it was previously enabled.


[Permalink]


Details

Available in private messagesYes
Permissions tierStandard User and above
Alternate namesNone
Premium subscription requiredNo

Effect

The original Nexus message will be edited on each server where it was delivered, assuming the bot is still present on that server.

Arguments

ArgumentPermitted Inputs
[message link]The link to any Nexus message you have authored, which does not need to be the original copy.
[new text]Any text.

Examples

CommandResult
>nexus edit https://discord.com/channels/455185166030209024/672544958359797790/849324832659472464 This is a test.The text of that Nexus message will be replaced globally with "This is a test."


[Permalink]


Switchboard

Functions

  • Initial Setup Process: when a user adds the bot to their server, starts the initial setup process in their private messages. This process walks the user through a brief tutorial of the Nexus, permissions tiers, special channels, ADRB events, event logging, and command prefixes, and allows them to enter settings for these features. It also provides a link to the support server and some basic information on how to use the bot.

Commands

Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Usage

This command cannot itself be disabled.

Effect

Disabled commands cannot be used on the server by any member, regardless of permissions, except administrators.

Arguments

ArgumentPermitted Inputs
[operation]
  • "add" to disable a command
  • "remove" or "delete" to re-enable a command
  • "list" to show the commands that are currently disabled
[*command name]Any command, not including aliases, without arguments. If [operation] is "add" or "remove," this argument is required.

Examples

CommandResult
>disable appealExcept for administrators, members of the server will not be able to use the >appeal command on the server.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namesNone
Premium subscription requiredNo

Effect

This command is similar to >whitelist, except that it applies to a specific command instead of all commands. Members of the server will not be able to use the command given in [command name] unless they meet at least one of the criteria defined by >require. This could mean they have one of the required roles, they are using the given command in one of the required channels, or they are one of the required members. Administrators are immune to these requirements.

Arguments

ArgumentPermitted Inputs
[object type]
  • "channel" to limit the command to a set of channels
  • "role" to limit the command to use by members with any one of a set of roles
  • "member" to limit the command to use by a set of members
  • "list" to list the existing commands and aliases with authorization requirements
[*command name]Any command, including aliases, without arguments. This command does not need to include a prefix.
[*objects]
  • If [object type] is "channel," a list of channels, separated by double commas. Each item can be the name, ID, or #mention of any text channel on the server.
  • If [object type] is "role," a list of roles, separated by double commas. Each item can be the name, @mention, or ID of any role on the server except the @everyone role.
  • If [object type] is "member," a list of members, separated by double commas. Each item can be the nickname, username, @mention, or ID of any non-bot member of the server.
  • "none" to clear the list

Examples

CommandResult
>require role poll Pollmaster,, Server ModMembers of the server will not be able to use the >poll command unless they have the Pollmaster or Server Mod roles.


[Permalink]


Details

Available in private messagesNo
Permissions tierAdministrator
Alternate namessetup
Premium subscription requiredNo

Usage

This command opens a menu that allows you to change most of the bot's settings. Using reactions, you can navigate through the following six submenus. You can generally disable or remove any option by setting it to "none."
SubmenuSettings
Event LoggingThe bot can log sixteen types of server events. You can choose the channel where each type of server event is logged, if any, or set or disable all the events at once. The events are as follows.
  • Message deleted
  • Message edited
  • Messages bulk-deleted
  • Channel created
  • Channel updated
  • Role created
  • Role deleted
  • Role updated
  • Server updated
  • Emojis updated
  • Member arrived
  • Member departed
  • Member updated (roles or nickname)
  • User banned
  • User unbanned
Arrivals, Departures, Returns, and BansThe bot can act in response to member arrivals, departures, returns, and bans. You can choose these responses as follows.
  • Whether the bot restores a departed member's previous roles when they return to the server
  • Which roles, if any, the bot assigns automatically to all incoming members
  • What password, if any, the bot requires all incoming members to provide before they can see the server
  • The channel where arrival messages are sent, if any
  • The arrival message, which can include substitution variables
  • The channel where departure messages are sent, if any
  • The departure message, which can include substitution variables
  • The channel where return messages are sent, if any
  • The return message, which can include substitution variables
  • The channel where ban messages are sent, if any
  • The ban message, which can include substitution variables
Substitution Variables
$m β‡’ the name of the member who joined
$s β‡’ the server's name
$c β‡’ the server's member count
$d β‡’ the current date
$a β‡’ the member's age, formatted as "01 Aug 21 (25 days ago)"
Special ChannelsYou can choose which channels are designated as the following special channels, if any.
  • General, where the bot sends messages intended for the general public
  • Staff, where the bot sends messages intended for server staff
Permissions RolesYou can choose which roles fall into each of the following permissions tiers, which determine who can use higher-level commands.
  • Power User, for commands that require a small degree of trust
  • Moderator, for commands that can affect other members and require a medium degree of trust
  • Administrator, for commands that can affect all aspects of the server and require a high degree of trust
Request RolesMembers of the server can use the request command to add or remove certain roles to or from themselves. You can choose which roles are available for use with that command. You can also create mutually-exclusive groups of roles (MuEx). If a member adds a MuEx role to themselves, they will lose all other roles in that group, if they had any. A role cannot be in more than one MuEx group, and if it is in one, it cannot be on the list outside that group.
Bot SettingsYou can change the following miscellaneous settings.
  • Reset the bot's configuration for the server
  • Set the bot's command prefix for the server
  • Toggle whether commands respect server hierarchy
  • Toggle whether commands respect author permissions
  • Toggle whether logs are kept for >mute, >kick, and >ban
Deluxe SettingsIf you have a custom Deluxe bot, you can change the following account settings. The username and avatar settings are subject to a one-hour cooldown on every third change, and enabling message backups can only be done once every twelve hours.
  • Set the bot's username
  • Set the bot's avatar
  • Set the bot's activity, such as "Playing >help"
  • Set the bot's online/offline/idle/do-not-disturb status
  • Toggle message backup
  • Set a channel where the bot should forward its private messages


[Permalink]