Settings
Every value /config set accepts. Generated from utils/settings.py. Edit that, not this page.
General
Roles and access
Who can use the bot's admin and staff commands.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Admin role | admin_role | role | Full access to every admin command. Server administrators always have this whether or not the role is set. Required for every admin command. | |
| Staff role | staff_role | role | Staff-level commands: tickets, divisions, products. The admin role counts as staff. |
Logging
Where the bot reports its own problems.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Error log channel | error_log_channel | text channel | Where the bot reports its own failures. |
Tickets
Where tickets live
The category tickets open in, and where their records go.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Ticket category | ticket_category | category channel | Ticket channels are created inside this category. Required for opening a ticket. | |
| Ticket log channel | ticket_log_channel | text channel | Ticket opens, closes and transcripts. |
Unclaim appeals
Staff voting on whether a claimed ticket can be taken back.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Unclaim vote channel | ticket_vote_channel | text channel | Where an unclaim appeal is posted for a vote. Required for unclaim appeals. | |
| Manager role | ticket_inner_circle_role | role | Who may vote on an unclaim appeal. Falls back to admin_role when unset. |
Product pipeline
Publishing
The forum products are posted to, and the staff thread beside it.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Product forum | product_forum_channel | forum channel | The public forum where product posts are created. Required for publishing a product. | |
| Product staff channel | product_thread_channel | text channel | Parent channel for the private staff thread on each product. |
Logging
A record of pipeline changes.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Product log channel | product_log_channel | text channel | Pipeline changes and checklist completions. |
Event hosting
Announcement
Where events are posted, who gets pinged, and what the message looks like.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Announcement channel | events_channel | text channel | Where event announcements are posted. Required for hosting an event. | |
| Ping roles | events_ping_roles | role list | Pinged when an event is announced. | |
| Also send as a DM | events_dm_optin | boolean | False | When an event is announced, direct message everybody holding a Direct messages opt-in role. Needs that module on and a role set. The announcement is posted first and never waits on the DMs. |
| Events colour | events_color | colour | Accent colour on event posts. Also the fallback for the other modules' colours. |
Who can host
The role required to announce an event.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Hoster role | event_hoster_role | role | Who may host an event. Required for hosting an event. |
Cooldowns and overrides
How long between events, and how staff approve one during a cooldown.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Cooldown between events | events_cooldown_minutes | 1–1440 minutes | 60 | How long after an event ends before another may be hosted. |
| Override request channel | events_override_channel | text channel | Where a request to host during a cooldown is posted for approval. Without it there is no override at all. Required for cooldown overrides. |
Vote requests
Members voting for what gets hosted next.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Games members can vote for | events_request_options | string list | The games offered when members vote on what gets hosted next. Use the short names from the Games list; anything this server has no game for is left out. Required for event vote requests. | |
| Votes to trigger an event | events_request_threshold | 1–50 votes | 5 | Votes needed on one option before it wins. |
| Votes to trigger during a cooldown | events_request_threshold_during_cooldown | 1–50 votes | 10 | Higher bar while a cooldown is running. |
| Vote request expires after | events_request_expiry_hours | 1–168 hours | 12 | How long a vote request stays open. |
Event log
A record of every event hosted, ended or cancelled, and by whom.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Events log channel | events_log_channel | text channel | Hosting, ending, overrides and vote requests. | |
| Delete announcement after | events_delete_minutes | 1–60 minutes | 10 | How long an announcement stays up once the event ends. |
Attendance records
Attendance charts
Where charts are posted.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Attendance chart channel | activity_chart_channel | text channel | Where attendance charts are posted. Required for attendance charts. |
Proof images
Where uploaded images are kept so their links do not expire.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Image storage channel | activity_chart_storage_channel | text channel | Uploaded proof images are re-hosted here so their links do not expire. Can be a private channel. Required for attendance images, declaration images. |
Diplomacy
Affiliations
Who may edit faction relations, and how the panel looks.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Diplomat role | affiliation_diplomat_role | role | May edit faction affiliations. | |
| Leader role | affiliation_leader_role | role | May edit faction affiliations. | |
| Affiliations panel colour | affiliations_panel_color | colour | Accent colour on the relations panel. Falls back to events_color when unset. |
Declarations
Where declarations are posted and how they look.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Declarations channel | declarations_channel | text or forum channel | Where declarations are posted. A forum channel enables tags. Required for posting a declaration. | |
| Declaration image storage | declaration_storage_channel | text channel | Re-hosts declaration images so their links do not expire. Falls back to activity_chart_storage_channel when unset. | |
| Declarations colour | declarations_color | colour | Accent colour on declaration posts. Falls back to events_color when unset. |
Forum tags
Which tags each kind of declaration is filed under.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Simple declaration tags | declaration_simple_tags | string list | Forum tag names applied to a simple declaration. | |
| Email declaration tags | declaration_email_tags | string list | Forum tag names applied to an email declaration. | |
| Communiqué declaration tags | declaration_communique_tags | string list | Forum tag names applied to a communiqué. |
Divisions directory
The directory
The forum holding one thread per division, and how threads are tagged.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Divisions forum | divisions_forum_channel | forum channel | The forum holding one thread per division. Required for publishing a division. | |
| Division forum tags | divisions_forum_tags | tag map | Which forum tag goes on a division, by its wing, category or status. Written as a name and a tag ID for each one. |
Limitations
The published limitations post that division threads link to.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Limitations thread | divisions_limitations_thread | thread channel | The published limitations post. Chancery fills this in when somebody publishes one, so you should not need to. Written by the bot. |
Direct messages
Who gets them
The roles that mean somebody has asked for direct messages.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Opt-in roles | dm_optin_roles | role list | Anyone holding any of these has asked for direct messages. Hand one out through Discord onboarding and joining the server is the sign-up; removing it is how somebody stops. Required for sending a direct message broadcast. |
Record
Where a broadcast is recorded after it is sent.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Broadcast log channel | dm_log_channel | text channel | Every broadcast is recorded here: who sent it, how many people were reached, and how many had their DMs closed. |
Server log
Where the log goes
One channel for everything, or a separate one per kind of event.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Server log channel | serverlog_channel | text channel | Everything goes here unless a more specific channel below is set. Without this and without the overrides, nothing is logged. Required for logging anything. | |
| Message log channel | serverlog_message_channel | text channel | Messages edited, deleted and purged. Usually the loudest category by a wide margin, which is why it is the one most servers separate. Falls back to serverlog_channel when unset. | |
| Member log channel | serverlog_member_channel | text channel | Joins, leaves, bans, nicknames, roles and timeouts. Falls back to serverlog_channel when unset. | |
| Server log channel (structure) | serverlog_server_channel | text channel | Channels, roles, threads, emoji, invites, webhooks and the server settings themselves. Falls back to serverlog_channel when unset. | |
| Voice log channel | serverlog_voice_channel | text channel | Joining, leaving and moving between voice channels. Falls back to serverlog_channel when unset. |
What is logged
Every event is on once a channel is set. Turn off the ones you do not want.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Events to skip | serverlog_disabled_events | event key list | Named events that are never logged, comma-separated. Everything not listed here is logged. /serverlog lists the names. |
What is skipped
Channels and authors the log never mentions.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Ignored channels | serverlog_ignore_channels | channel list | Nothing that happens in these channels is logged. The log channels themselves are always ignored, so the log cannot log itself. | |
| Ignore bots | serverlog_ignore_bots | boolean | True | Skip anything a bot did. On by default: a single webhook-driven feed can produce more log entries than every person in the server put together. |
Moderation
Who can moderate
The role required to warn, remove or ban somebody.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Moderator role | moderation_role | role | May warn, time out, remove and ban. The admin role always counts, and without this the staff role is used. Falls back to staff_role when unset. |
Where cases are recorded
One channel for everything, or a separate one per kind of action.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Moderation log channel | moderation_log_channel | text channel | Every case is posted here unless a more specific channel below is set. Required for recording a case. | |
| Removals log channel | moderation_removal_log_channel | text channel | Kicks, bans, softbans and unbans, if they should go somewhere of their own. Falls back to moderation_log_channel when unset. | |
| Warnings log channel | moderation_warning_log_channel | text channel | Warnings and timeouts, if they should go somewhere of their own. Falls back to moderation_log_channel when unset. | |
| Purge log channel | moderation_purge_log_channel | text channel | Bulk message deletions, if they should go somewhere of their own. Falls back to moderation_log_channel when unset. |
What the member is told
Whether a case is sent to the person it is about, and where they appeal.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Tell the member | moderation_dm_member | boolean | True | Send the case to the person it is about. They are told the action, the reason and the case number. |
| Appeal link | moderation_appeal_url | string | Included in that message. A banned member cannot post here, so an appeal has to live somewhere they can still reach. |
Rejoining
Whether roles come back when somebody returns.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Give roles back | moderation_keep_roles | boolean | False | Remember a member's roles when they leave, and restore them if they come back. |
Temporary voice channels
Who can step in
The role that may run any temporary channel, not only their own.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Voice moderator role | tempvoice_moderator_role | role | May rename, lock, empty or delete any temporary channel, and claim one whose owner is still in it. The admin role always counts, and without this the staff role is used. Falls back to staff_role when unset. |
Record
Where channels being made, deleted and handed over are recorded.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Voice log channel | tempvoice_log_channel | text channel | Channels made, deleted, renamed, locked, handed over, and people blocked or disconnected. A creator can send its own record somewhere else instead. |
Channel names
Words that are never allowed in a channel name.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Censored words | tempvoice_censor_words | string list | Replaced with asterisks in any channel name. * at the start or end of a word matches part of a word, the way Discord AutoMod does: *pet catches carpet, java* catches JavaScript. |
Timing
How fast channels can be made, and how long an empty one is kept.
| Setting | Key | Type | Default | What it does |
|---|---|---|---|---|
| Cooldown between channels | tempvoice_cooldown_seconds | 0–300 seconds | 10 | How long somebody waits after making a channel before they can make another. Joining the creator sooner disconnects them. Stops join-leave-join from making and deleting channels in a loop. |
| Keep an empty channel for | tempvoice_empty_grace_seconds | 0–600 seconds | 0 | How long a channel stays after the last person leaves. 0 deletes it at once. A short grace means a dropped connection does not cost somebody their channel and its settings. |