Configuring Red Star

There are several options in the Red Star configuration file you can change to suit your needs. Many of these things need to be changed before the bot will function correctly. Below are the options and their descriptions.

Base options:

• token: This is your bot's token, as shown on the Discord applications page. Keep it secret!
• bot_maintainers: This is a list of integer user IDs. Any user on this list gains access to the high-level bot management commands (configuration editing, plugin (de)activation, etc), along with bypassing command permission checks. Be careful!
• plugin_path: This is where Red Star will load plugin files from.
• disabled_plugins: This is a list of plugins not to load. deactivate plugin true modifies this list.
• global_tick_interval: This controls how often the bot emits a global tick event in seconds.

Announcer:

Per-server options:

• greeting_enabled: This controls whether or not the bot will display greeting_message when first loaded.
• greeting_message: If enabled, the message the bot will display in the general channel when first loaded.
• new_member_greeting_enabled: This controls whether or not the bot will display a greeting message to new members.
• new_member_greeting_message: If enabled, this message is displayed to new members in the welcome channel.
• ping_messages: Whether to have the bot respond to being pinged.
• ping_messages_on_everyone: Whether to have the bot additionally respond to @everyone or @here pings.
• ping_message_options: The list of strings the bot will pick from to respond with when pinged.

Command Dispatcher

Per-server options:

• command_prefix: The prefix the bot will use to look for commands.

Custom Commands

• rslisp_max_runtime: The maximum time, in seconds, that a custom command can run before being terminated.
• rslisp_minify: Whether to compress uploaded custom commands by removing whitespace and comments. Per-server options:
• cc_prefix: The prefix the bot will use to look for Custom Commands.
• cc_limit: The maximum number of custom commands each user can have.

Logger

Per-server options:

• log_type_blacklist: The types of events the bot will not log. Valid types: "message_delete", "message_edit", "member_join", "member_remove"

MotD

• motd_file: The file path from which MotD will load its messages.

Music Player

• default_volume: The default volume (out of 100) that the bot will use when it first runs.
• opus_path: The path to your libopus library. Most of the time, it will be found automatically, but if not, you can declare it here.
• save_audio: If this is set, the bot will download songs to a cache for improved performance.
• video_cache_clear_age: If download_songs is set, the amount of time a cached file can go unplayed before it is deleted.
• ydl_options: A dictionary of settings for youtube-dl. Only touch these if you know what you're doing.

Per-server options:

• max_queue_length: The maximum number of items in the queue at once.
• max_video_length: The maximum length of a video in seconds.
• print_queue_on_edit: Whether to print the queue when songs are added or removed from it.
• vote_skip_threshold: The fraction of users, in decimal, that are required to use !skip before the skip completes.

Miscellaneous Information

• Channel IDs can be obtained by enabling Developer Mode in Discord (Settings > Appearance), right-clicking the channel you want the ID of, and clicking "Copy ID."