Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 13.1 KB

configuration-variables-config-vars.md

File metadata and controls

38 lines (35 loc) · 13.1 KB

Configuration Variables (Config Vars)

These are currently all the valid configuration variables you can change with the config set command.

Name Description
account_age Specific time accounts must have before using modmail. (Prevents spam.)
activity playing, listening to, watching, streaming You can set a custom activity for the bot using the activity command. Do [p]activity for more info. Note: Listening MUST be followed by to, When activity type is set to streaming, you can set the linked twitch page: ?config set twitch_url https://www.twitch.tv/somechannel/ and finally, you can clear the activity by using the command ?activity clear
anon_avatar_url The icon URL in the anonymous reply embed (defaults to the guild's icon URL).
anon_tag Sets the tag for author section of an embed for anonreply. (Default is Response)
anon_username The name of the anonymous user for use with the anonreply command (defaults to be the same as mod_tag configuration).
blocked_emoji Changes the blocked emoji (defaults to 🚫).
close_emoji Emoji used if user accidentally made a thread. Only if disable_recipient_thread_close is not set. (defaults to 🔒)
guild_age Specific date that member must be in guild before using modmail.
log_channel_id Set the channel where bot logs will be sent.
main_category_id Set the category where new threads spawn.
main_color The general color of Modmail in hexadecimal format or accepted color name (defaults to blurple - 7289da).
mention The message at the start of each thread.
mod_color The color of the mod reply embed in hexadecimal format or accepted color name (defaults to green - 2ecc71).
mod_tag The footer text in the mod reply embed (defaults to your highest role name).
mod_typing Shows when moderator starts typing in thread channel. (default is off)
prefix The prefix of the bot (defaults to ?).
recipient_color The color of the recipient's message embed in hexadecimal format or accepted color name (defaults to gold - f1c40f).
recipient_thread_close By default, the recipients can't close their ticket. Use this command to enable it.
reply_without_command Making all non-command messaged to be forwarded to the user without command. ?reply
sent_emoji Changes the sent emoji (defaults to ✅).
thread_auto_close Time that has to pass after no reply from a user before the thread auto closes. If not set, thread will not auto close.
thread_auto_close_response Custom closing message for when a thread is auto closed. Use the %t variable in the message to add human time.
thread_close_footer Footer of message that user will receive when thread is closed.
thread_close_response Content message user will receive when the thread is closed.
thread_close_title Title of the message the user will receive when thread is closed.
thread_creation_response Message that shows when user has opened a thread.
thread_creation_title Title of the message the user will receive when the thread is opened.
thread_self_close_response Message that the user will receive if the thread was closed by themselves.
twitch_url The twitch URL when activity_type is set to 1 (streaming).
user_typing Shows when user starts typing to bot. (default is off)

Accepted color names can be found here: {% page-ref page="color-names.md" %}.