Command Reference

This page lists all commands and their arguments. An argument in (parentheses) is required, while an argument in [brackets] is optional.

Admin Commands

• Purge:
  • Syntax: Purge (count) [match] [-u/--user USER] [-r/--regex] [-v/--verbose] [-e/--emulate/--dryrun] [-b/--before message_id] [-a/--after message_id]
  • Aliases: Prune
  • Permissions: MANAGE_MESSAGES
  • Description: Purges count messages from the channel it's used in. Optionally search the messages for match and only delete messages that match.
  • Flags:
    • With -[-u]ser (user), the bot will only delete messages from the specified user.
    • With -[-b]efore (msg_id), only messages before the given message ID will be deleted.
    • With -[-a]fter (msg_id), only messages after the given message ID will be deleted.
    • With -[-r]egex, match is interpreted as a regular expression for more powerful matching.
    • With -[-v]erbose, complete information on deleted messages is dumped into the bot log.
    • With -[-e]mulate, the bot will count and return the messages that would be deleted with the match string.

Bot Management Commands

• LogEvent:
  • Syntax: LogEvent [add/remove (event)]
  • Permissions: MANAGE_GUILD
  • Description: Adds or removes event types to be logged by logger, or lists valid event types if none specified.
• UpdateName:
  • Syntax: UpdateName (username?) (name)
  • Permissions: MANAGE_GUILD (BOT_MAINTAINER is required to change the bot's username)
  • Description: Changes the bot's nickname (or username if username? is true) to the given name.
  • Can be used in DMs.
• UpdateAvatar:
  • Syntax: UpdateAvatar (URL)
  • Permissions: BOT_MAINTAINER, MANAGE_GUILD
  • Description: Changes the avatar of the bot to the image at URL.
  • Can be used in DMs.
• GetConfig:
  • Syntax: GetConfig (path/to/value) [-f/--file file]
  • Permissions: BOT_MAINTAINER, MANAGE_GUILD
  • Description: Displays the value at the specified config path.
  • Flags:
    • With -[-f]ile (file), GetConfig will read and return from the specified plugin config/storage file instead of config.json.
  • Can be used in DMs.
• SetConfig:
  • Syntax: SetConfig (path/to/value) (value or -r/--remove) [-a/--append] [-k/--addkey key_name] [-t/--type type] [-f/--file file]
  • Permissions: BOT_MAINTAINER, MANAGE_GUILD
  • Description: Changes the config value at the specified path to the specified value.
  • Flags:
    • With -[-f]ile, SetConfig will write to the specified plugin config/storage file instead of config.json.
    • With -[-r]emove, SetConfig will delete the specified key instead of editing it.
    • With -[-a]ppend, SetConfig will append value to the specified array instead of overwriting it.
    • With --add[k]ey (key), SetConfig will add "key": value to the specified object instead of overwriting it.
    • With -[-t]ype (type), SetConfig will ignore type-checking and force value to be the specified type.
  • Can be used in DMs.
• Activate:
  • Syntax: Activate (plugin) [permanent]
  • Permissions: BOT_MAINTAINER
  • Description: Activates the specified inactive plugin. If permanent is true, the plugin will be loaded on subsequent restarts as well.
  • Can be used in DMs.
• Deactivate:
  • Syntax: Deactivate (plugin) [permanent]
  • Permissions: BOT_MAINTAINER
  • Description: Deactivates the specified active plugin. Note that you cannot deactivate bot_management. If permanent is true, the plugin will not be loaded on subsequent restarts as well.
  • Can be used in DMs.
• ReloadPlugin:
  • Syntax: ReloadPlugin (plugin)
  • Permissions: BOT_MAINTAINER
  • Description: Reloads an active plugin, clearing out its in-memory data and pulling in code edits.
  • Can be used in DMs.
• ListPlugins:
  • Syntax: ListPlugins
  • Permissions: BOT_MAINTAINER
  • Description: Lists all plugins and their activation status.
  • Can be used in DMs.
• Exec:
  • Syntax: Exec (code in code block)
  • Permissions: BOT_MAINTAINER
  • Description: Executes the given Python code in the plugin's context. Prints anything written to self.res. aef is included as an alias for asyncio.ensure_future.
  • Can be used in DMs.
• Shutdown:
  • Syntax: Shutdown
  • Permissions: MANAGE_GUILD
  • Description: Shuts down the bot.
  • Can be used in DMs.

Channel Management Commands

• GetChannel:
  • Syntax: GetChannel [type]
  • Permissions: MANAGE_GUILD
  • Description: Retrieves the channel of the specified type, or all channel types for the server if none specified.
• SetChannel:
  • Syntax: SetChannel (type) [channel]
  • Permissions: MANAGE_GUILD
  • Description: Sets the specified channel type to the specified channel. If channel is a text channel, use a mention. If channel is a voice channel, use its name. If channel is missing, unsets the channel for that type.
• GetCategory:
  • Syntax: GetCategory [category]
  • Permissions: MANAGE_GUILD
  • Description: Gets all channels in the specified category, or lists categories if none specified.
• AddToCategory:
  • Syntax: AddToCategory (category) (channel) [channel2] ...
  • Permissions: MANAGE_GUILD
  • Description: Adds the listed channels to the specified category. If the category starts with voice, channel are the names of the voice channels, otherwise, they are text channel mentions.
• RMFromCategory:
  • Syntax: RmFromCategory (category) (channel) [channel2] ...
  • Permissions: MANAGE_GUILD
  • Description: Removes the listed channels from the specified category. If the category starts with voice, channel are the names of the voice channels, otherwise, they are text channel mentions.

Info Commands

• Help:
  • Syntax: Help [command/category]
  • Description: Lists information about a command, commands in a category, or lists categories.
• About:
  • Syntax: About
  • Description: Displays information about the Red Star bot.

Roles Commands

• CreateRole:
  • Syntax: CreateRole (name) (ROLE) [-n/--name string] [-c/--colour FFFFFF] [-h/--hoist bool] [-m/--mentionable bool] [-p/--position int]
  • Permissions: MANAGE_ROLES
  • Description: Creates a new role named name based on ROLE with the given parameters.
  • Flags:
    • With -[-n]ame (string), the new role's name will be set to string.
    • With -[-c]olo[u]r (hexcode), the new role's color will be set to hexcode.
    • With -[-h]oist (bool), the new role's "display separately" status will be set to bool.
    • With -[-m]entionable (bool), the new role's mentionability will be set to bool.
    • With -[-p]osition (index), the new role's position in the role list will be set to index.
• EditRole:
  • Syntax: `EditRole (ROLE) [-n/--name string] [-c/--colour FFFFFF] [-h/--hoist bool] [-m/--mentionable bool]
  • Permissions: MANAGE_ROLES
  • Description: Edits ROLE with the given parameters.
  • Flags:
    • With -[-n]ame (string), the new role's name will be set to string.
    • With -[-c]olo[u]r (hexcode), the new role's color will be set to hexcode.
    • With -[-h]oist (bool), the new role's "display separately" status will be set to bool.
    • With -[-m]entionable (bool), the new role's mentionability will be set to bool.
    • With -[-p]osition (index), the new role's position in the role list will be set to index.[-p/--position int]`
• DeleteRole:
  • Syntax: DeleteRole (ROLE) [position]
  • Permissions: MANAGE_ROLES
  • Description: Deletes ROLE, in the specified position if there's more than one with the same name.
• RoleInfo:
  • Syntax: RoleInfo (ROLE)
  • Aliases: InfoRole
  • Description: Returns detailed information about ROLE.
• ListRoles:
  • Syntax: ListRoles
  • Aliases: ListRole
  • Permissions: MANAGE_ROLES
  • Description: Lists every role on the server. Potentially very long, so limited access.

Custom Commands Commands

• CreateCC:
  • Syntax: CreateCC [-s/--source [name]] (name) (contents or file)
  • Aliases: NewCC
  • Description: Creates a Custom Command with name name and output contents. See the Custom Commands page for more information. A JSON file can be uploaded in place of the name and contents.
  • Flags:
    • With -[-s]ource [name], the attached file will be considered RSLisp source code instead of a JSON CC dump, and given the name name, or the filename if not specified.
• EditCC:
  • Syntax: EditCC [-s/--source [name]] (name) (contents)
  • Permissions: MANAGE_MESSAGES (for editing others' CCs)
  • Description: Changes the output of Custom Command name to contents. A JSON file can be uploaded in place of the name and contents.
  • Flags:
    • With -[-s]ource [name], the attached file will be considered RSLisp source code instead of a JSON CC dump, and given the name name, or the filename if not specified.
• DeleteCC:
  • Syntax: DeleteCC (name)
  • Aliases: DelCC, RMCC
  • Permissions: MANAGE_MESSAGES (for deleting others' CCs)
  • Description: Deletes the Custom Command name
• CCInfo:
  • Syntax: CCInfo (name)
  • Description: Displays information about Custom Command name.
• DumpCC:
  • Syntax: DumpCC (name)
  • Description: Dumps the specified Custom Command to a JSON file.
• SearchCCs:
  • Syntax: SearchCCs (search)
  • Aliases: SearchCC, ListCCs, ListCC
  • Description: Returns a list of Custom Commands with names or authors matching search. If search is *, returns all Custom Commands.
• LockCC:
  • Syntax: LockCC (name)
  • Permissions: MANAGE_MESSAGES
  • Description: Toggles the lock on Custom Command name, preventing it from being used.
• RestrictCC:
  • Syntax: RestrictCC (name) [category]
  • Permissions: MANAGE_MESSAGES
  • Description: Restricts the usage of the specified Custom Command to the specified category, or clears the restriction if no category is specified.
• CCMute:
  • Syntax: CCMute (USER)
  • Aliases: MuteCC
  • Permissions: MANAGE_MESSAGES
  • Description: Toggles a CC mute on USER, preventing them from using Custom Commands.
• CCBan:
  • Syntax: CCBan (USER)
  • Aliases: BanCC
  • Permissions: MANAGE_MESSAGES
  • Description: Toggles a CC ban on USER, preventing them from making or editing Custom Commands.
• ListCCBans:
  • Syntax: ListCCBans
  • Permissions: MANAGE_MESSAGES
  • Description: Lists all muted or banned users and their status.
• RPN:
  • Syntax: RPN (expression)
  • Description: Evaluates an expression in Reverse Polish Notation syntax.
• EvalCC:
  • Syntax: EvalCC (CC source code)
  • Permissions: MANAGE_MESSAGES
  • Description: Runs the given CC source code without uploading it.

Music Commands

• JoinVoice:
  • Syntax: JoinVoice
  • Aliases: JoinVC
  • Description: Causes the bot to join the voice channel you're in.
• LeaveVoice:
  • Syntax: LeaveVoice
  • Aliases: LeaveVC
  • Permissions: MUTE_MEMBERS (to make the bot leave if music is playing)
  • Description: Causes the bot to leave the voice channel.
• PlaySong:
  • Syntax: PlaySong (URL or search string)
  • Aliases: Play
  • Description: Plays the song specified in the voice channel.
• PauseSong:
  • Syntax: PauseSong
  • Aliases: Pause, ResumeSong, Resume
  • Description: Toggles pause on the currently playing song.
• SkipSong:
  • Syntax: SkipSong
  • Aliases: Skip
  • Permissions: MUTE_MEMBERS (for instant skipping)
  • Description: Votes to skip the currently playing song.
• SongVolume:
  • Syntax: SongVolume [0-100]
  • Aliases: Volume
  • Description: Sets the volume to the given number, or prints the current volume.
• StopMusic:
  • Syntax: StopMusic
  • Aliases: StopSong, Stop
  • Permissions: MUTE_MEMBERS
  • Description: Stops the current song and empties the queue.
• DeleteSong:
  • Syntax: DeleteSong (index)
  • Aliases: DelSong, RMSong
  • Permissions: MUTE_MEMBERS
  • Description: Deletes the song at index in the queue.
• SongMode:
  • Syntax: SongMode [n/normal|rs/repeat_song|rq/repeat_queue|s/shuffle|sr/shuffle_repeat]
  • Aliases: Shuffle, Repeat
  • Description: Sets the playback mode of the bot; normal plays songs in order, removing them as it does; repeat_song repeats the same song continuously; repeat_queue plays songs in order, inserting them into the end of the queue after playback; shuffle plays the songs in random order, removing them as it does; shuffle_repeat is a combination of shuffle and repeat_queue.
• SongQueue:
  • Syntax: SongQueue
  • Aliases: Queue
  • Description: Prints out the song queue.
• NowPlaying:
  • Syntax: NowPlaying
  • Aliases: SongInfo
  • Description: Prints detailed information about the currently playing song in a pretty-formatted embed.
• MusicBan:
  • Syntax: MusicBan (USER)
  • Permissions: MUTE_MEMBERS
  • Description: Toggles a music ban on user, preventing them from using music-bot commands.
• MusicConfig:
  • Syntax: MusicConfig [option (value)]
  • Permissions: MANAGE_GUILD
  • Description: Allows the editing of per-server config options for the music player, or lists the current configuration. Allowed values are idle_disconnect_time (int), max_queue_length (int), max_video_length (seconds), print_queue_on_edit (bool), and vote_skip_threshold (decimal).

Voting Commands

• StartVote:
  • Syntax: StartVote (HID) (Query) [Responses, up to 20] [-1/--question (str), up to 20] [-v/vote_limit (int)] [-n/--no_retracting]
  • Description: Starts a poll. HID is used to interact with the poll, so make sure it's simple and memorable. Arguments can be wrapped in quotes for multi-word questions or answers.
  • Flags:
    • With -1/--question (str), you can define responses non-positionally.
    • With -[-v]ote_limit (int), you can allow users to vote up for up to int different options, or all if int is 0.
    • With -[-n]o_retracting, you can prevent users from being able to change their vote.
• Vote:
  • Syntax: Vote (HID) (option)
  • Aliases: UpVote
  • Description: Votes on poll HID for option option, which should be a single letter.
• DownVote:
  • Syntax: DownVote (HID) (option)
  • Description: Removes your vote on option on poll HID, if you had one.
• EndVote:
  • Syntax: EndVote (HID)
  • Permissions: MANAGE_MESSAGES (to end others' polls)
  • Description: Ends vote HID and displays the results.

Reminder Commands

• Remind
  • Syntax: Remind (reminder) [-d/--delay DD//@HH:MM:SS] [-t/--time DD/MM/YYYY@HH:MM:SS] [-r/--recurring y/m/d###] [-p/--private]
  • Description: Schedules a reminder. When --time is reached or --delay has passed, the bot will ping you with reminder. Either --delay or --time must be specified. When writing times, unneeded numbers may be skipped as long as the separators are intact; 08:00:00 and 8:: are functionally equivalent.
  • Flags:
    • With -[-d]elay DD//@HH:MM:SS, the reminder will be set to trigger at the given amount of time in the future.
    • With -[-t]ime DD/MM/YYYY@HH:MM:SS, the reminder will be set to trigger at the given time. Must be in the future.
    • With -[-r]ecurring y/m/d###. the bot will automatically reschedule the reminder for the given amount of time in the future once it has triggered.
    • With -[-p]rivate, the bot will send you a Direct Message with the reminder instead of posting it in a public channel.
• RemindList
  • Syntax: RemindList [del/delete/- (index)]
  • Description: Prints out all of your currently scheduled reminders. When used with the delete argument, deletes the reminder at index.

Debug Commands

• TestMotDs:
  • Syntax: TestMotDs (month) (day) (weekday)
  • Permissions: MANAGE_GUILD
  • Description: Outputs all valid MotDs for the given date.
• LastError:
  • Syntax: LastError (command/event/unhandled)
  • Permissions: MANAGE_GUILD
  • Description: Prints the last error to occur in the specified context.
  • Can be used in DMs.

Other Commands

• AddMotD:
  • Syntax: AddMotD (month) (day) (line)
  • Permissions: MANAGE_GUILD
  • Description: Adds an MotD for the specified date.
• AddHoliday:
  • Syntax: AddHoliday (month) (day)
  • Permissions: MANAGE_GUILD
  • Description: Adds a holiday on the specified date.