Generated57 settings
Welcome settings
The Welcome settings, from the typed spec the dashboard form and the AI server builder share. Accepted range is what the settings writer takes; where the form or the service is stricter, the description says so. Controls that exist only on the dashboard form are listed at the end.
| Setting | Type | Accepted range | What it does |
|---|---|---|---|
| Welcome message | |||
Welcome channelwelcome_channel_id |
channel | Where new members are greeted. Required for the welcome message. The dashboard health check flags welcome message while this is empty or points at something deleted. | |
Welcome messagewelcome_message |
text | up to 1900 characters | The greeting text, the Message box on the Welcome tab of the Messages page. Every tag in its All tags and conditions list is filled in, such as {user.mention}, {server}, {member_count.ordinal} and {inviter}, and conditions such as {if user.returning}...{else}...{end} pick between two texts. The Messages page takes up to 2,000 characters. Default: Welcome to **{server}**, {user.mention}! You are member #{member_count}!. While the Rotating messages list has entries, one of those is sent instead of this text. |
Send as an embedwelcome_embed |
on or off | Send as on the Messages page. Embed (the default) sends the greeting with the colour below, the member's avatar as thumbnail and a Member #N footer, and How it looks adds a title, an author line, pictures, up to 6 fields, your own footer and a timestamp. Server highlights and Start-here channels only appear inside the embed. Plain text sends the message on its own; the card still attaches. | |
Embed colourwelcome_embed_color |
colour | The accent colour of the welcome embed, as a hex value. The goodbye, the DM and the boost message use it too while they are set to the same colour as the welcome message. | |
Text above the embedwelcome_embed_content |
text | up to 1900 characters | A line sent with the welcome embed. Discord never pings a mention inside an embed, so this line is what notifies the new member. It takes the same tags as the welcome message. Default: {user.mention}. Empty sends the embed alone. Not used while the welcome is plain text, where the text carries its own mentions. |
| Channels | |||
Join and leave loglog_channel_id |
channel | A staff channel, set on the Logs & cleanup page, that gets one line per join with the account age in days, the member number, the user id and, when the Analytics service traced the invite, who invited them, and one line per leave with how long they were a member. With verification on, the join line says whether the member had to verify, and a member removed, banned or put on hold at the deadline gets a line too. The Setup page creates #welcome-logs for this. The dashboard health check flags welcome log while this is empty or points at something deleted. | |
| Goodbye | |||
Send a goodbyegoodbye_enabled |
on or off | Posts a message when a member leaves. Default off. | |
Goodbye channelgoodbye_channel_id |
channel | Where goodbye messages go. The welcome channel is used when this is empty. The dashboard health check flags goodbye message while this is empty or points at something deleted. Only checked when goodbye enabled is on. | |
Goodbye messagegoodbye_message |
text | up to 1900 characters | The text posted when a member leaves. It takes the member and server tags, including {user.member_for}, how long they were a member. The bot adds a line saying how many days they were a member when it knows the join date, unless the text uses {user.member_for}. The Messages page takes up to 2,000 characters. Default: **{user}** has left the server. We had {member_count} members. While the goodbye's Rotating messages list has entries, one of those is sent instead. On the Messages page the goodbye can be sent as an embed and carry the goodbye card. |
| Auto roles | |||
Roles to giveautorole_ids |
list of roles | Roles granted on join, up to 25 from the Roles page. Roles with dangerous permissions are refused. Members already in the server can get them too: count them on the Roles page, then start. The dashboard health check flags auto-assigned roles while this is empty or points at something deleted. Only checked when autorole enabled is on. | |
Give roles on joinautorole_enabled |
on or off | Gives every new member who is not a bot the roles listed below. On the Roles page each role can wait before it is given, up to 365 days, and be taken away again a set time later. With verification on, the roles are given when the member verifies (each wait starts then), or at once for a member the targeting rule trusts. Default off. /welcome set autorole switches it on as well. | |
Wait before giving themautorole_delay_sec |
whole number | 0 to 600 | Seconds to wait after the join before a role is given, up to 600, for every role that has no timer of its own on the Roles page. 0 gives them at once. A member who leaves during the wait never gets the roles. |
Restore roles when a member rejoinsrole_persist |
on or off | Gives a returning member the roles they had when they left, within 180 days of leaving. Roles the bot cannot hand out are skipped, and the verification roles, the boost role and a join role that is taken away after a while are never given back. | |
| Direct message | |||
Send a welcome DMdm_enabled |
on or off | Sends new members a direct message as well as the channel greeting. It also works with no welcome channel set. Default off. | |
DM textdm_message |
text | up to 1900 characters | The direct message text. Same tags as the welcome message; the Messages page takes up to 2,000 characters. There the DM can be sent as an embed with up to 3 link buttons, and Include the welcome card attaches the card. |
| Extras | |||
Celebrate member milestonesmilestone_enabled |
on or off | Posts 🎉 **We just hit N members!** when the member count reaches one of the Member counts set on the Engagement page (100, 250, 500, 1,000, 5,000 and 10,000 by default). Each milestone is announced once. Default off. | |
Milestone channelmilestone_channel_id |
channel | Where milestone posts go. Empty uses the welcome channel. The dashboard health check flags milestone posts while this is empty or points at something deleted. Only checked when milestone enabled is on. | |
Show server highlightshighlights_enabled |
on or off | Adds a Server line to the welcome embed with the member count and boost level, plus how many people are in voice on servers running their own bot. Only shows when the embed is on. Default on. | |
| Welcome card | |||
Send a welcome cardwelcome_card_enabled |
on or off | Attaches the card designed in the Card Studio to the welcome message: a still image, or an animated GIF when its background is animated. Default on. A rotating greeting that carries its own picture is sent without the card, and a card that takes too long to build is dropped so the greeting still goes out. | |
Card templatewelcome_card_template |
choice | gradient, dark, light, minimal, custom | The older card look, which /welcome set card still sets: gradient, dark, light, minimal or custom with the background link below. It is drawn as a centred 1,024 by 400 card while no Card Studio design is saved; a design saved in the Card Studio replaces it, and /welcome set card clears that design again. |
Custom background URLwelcome_card_bg_url |
text | up to 400 characters | The picture behind the custom card template, used while no Card Studio design is saved. An https link to an image of up to 5 MB; it is cropped to fill the card and darkened so the text stays readable. Imgur page links are accepted. When the picture cannot be loaded the card falls back to a gradient. In the Card Studio a background can be a link or an upload instead. |
| First message | |||
Celebrate a new member's first messagefirst_msg_enabled |
on or off | Notices the first message of a member who joined within the last 30 days. Default on. Nothing is visible unless the reaction, the announcement or the role below is set. | |
Announce itfirst_msg_announce |
on or off | Posts 🎉 **Name** just sent their first message! in the welcome channel, not under the message itself. Needs a welcome channel. Default off. | |
React with 🎉first_msg_react |
on or off | Adds a 🎉 reaction to the member's first message. Default on. | |
Give a role for itfirst_msg_role_id |
role | A role given once the member has posted for the first time. The dashboard health check flags first message role while this is empty or points at something deleted. Only checked when first msg enabled is on. | |
| Verification | |||
Turn on verificationverify_enabled |
on or off | Holds back auto roles, remembered roles and the buddy pairing until the member verifies with the button, the captcha or the web page. The welcome message still posts at join. Default off. After saving, press Post the message on the Verification page so the Verify button exists. | |
Verification channelverify_channel_id |
channel | Where the verification message and its button are posted. The dashboard health check flags verification while this is empty or points at something deleted. Only checked when verify enabled is on. | |
Verified roleverify_role_id |
role | The role given when a member verifies. Your channels should require it. The dashboard health check flags verified role while this is empty or points at something deleted. Only checked when verify enabled is on. | |
Verification messageverify_message |
text | up to 1500 characters | The text of the verification message, above its button, up to 1,500 characters on the Verification page. With the captcha or the web page a line is added saying what the button does. Default: Click the button below to verify and access the server. |
Rules textverify_rules_text |
text | up to 4000 characters | The older single rules text, one rule per line. While the rules list on the Rules page is empty, these lines are the server's rules everywhere: /rules, the rules DM, the verification message and the web page. Saving the rules list clears this text. |
Rules channelrules_channel_id |
channel | Where the server's rules are posted as one numbered message. A Start Your Server build posts them there, and the Rules page posts and updates the same message afterwards. Rules you already posted in another channel stay where they are. | |
How members verifyverify_type |
choice | button, captcha, web | button is one click, captcha shows an image code, web sends the member to a browser page where they sign in with Discord. |
Who has to verifyverify_target |
choice | everyone, suspicious | everyone: every new member must verify. suspicious: only accounts younger than the age below, or with no avatar, must verify; everyone else gets the verified role the moment they join. An account whose age cannot be read counts as suspicious. Default everyone. |
Suspicious belowverify_suspicious_max_age_days |
whole number | 1 to 365 | In suspicious mode, accounts younger than this many days must verify. Default 7. |
Unverified roleverify_unverified_role_id |
role | A role held from join until the member verifies, so you can restrict them meanwhile. Set it up for me on the Verification page makes one and hides your channels from it. | |
Deadline after joiningverify_kick_after_min |
whole number | 0 to 10080 | Minutes a member has to verify before the action set under At the deadline runs, up to 10,080 (7 days). 0 means no deadline. |
Reminder DMverify_dm_reminder_min |
whole number | 0 to 10080 | Minutes before the deadline at which the member gets one reminder DM. 0 sends none. Must be smaller than the deadline, otherwise it is saved as 0. |
New captcha image everyverify_captcha_refresh_sec |
whole number | 0 to 600 | Captcha type only. While a captcha is open the image is swapped for a new one this often, from 30 to 600 seconds; a value from 1 to 29 is saved as 30. An answer to an old image fails. At most ten swaps per captcha. 0 keeps one image (the default). |
At the deadlineverify_fail_action |
choice | kick, ban, hold, none | kick, ban, hold (give the hold role and keep them) or none. Default kick. |
Hold roleverify_fail_role_id |
role | The role given by the hold action, taken back when the member later verifies. Must differ from the verified and unverified roles. With hold chosen and no role here, nothing happens at the deadline. | |
| Buddy system | |||
Pair new members with a buddybuddy_enabled |
on or off | Pairs each new member with the volunteer from the buddy pool who has had the fewest pairings, and posts the buddy introduction in the welcome channel. Needs a buddy role and a welcome channel. With verification on, the pairing happens when the member verifies. Default off. | |
Buddy rolebuddy_pool_role_id |
role | Members with this role volunteer to be buddies. The dashboard health check flags buddy pool role while this is empty or points at something deleted. Only checked when buddy enabled is on. | |
Also DM the buddybuddy_dm_enabled |
on or off | Tells the buddy by DM who they have been paired with. | |
Buddy introductionbuddy_welcome_message |
text | up to 1900 characters | The message posted in the welcome channel when a buddy is assigned. {user} and {user.mention} are the new member, {buddy} and {buddy.mention} the volunteer, {server} the server name. Default: Welcome {user.mention}! Your buddy is {buddy.mention}. They will help you get started. A blank field restores the default. |
| Quests | |||
Welcome questsquest_enabled |
on or off | Posts a checklist of tasks to each new member when they join and tracks their progress, shown with /quests list. Switched on from the Quests page (Turn quests on). Nothing posts until at least one task exists. Default off. | |
Quest channelquest_channel_id |
channel | Where the quest list is posted when a member joins and where the completion announcement goes. Empty uses the welcome channel. A reward message tied to one task posts in the channel where the task was completed. The dashboard health check flags quest posts while this is empty or points at something deleted. Only checked when quest enabled is on. | |
Quest reward rolequest_role_id |
role | A role given when every quest task is complete. The dashboard has no field for it today; the server builder sets it. On the Quests page, a Grant Role reward that fires on Quest complete does the same job. The dashboard health check flags quest reward role while this is empty or points at something deleted. Only checked when quest enabled is on. | |
| Boost message | |||
Thank members who boostboost_enabled |
on or off | Posts a thank-you when a member boosts the server: when they start boosting and for every boost Discord announces in the system channel. Boosts by the same member within two minutes are thanked once. Default off. | |
Boost channelboost_channel_id |
channel | Where the thank-you is posted. The welcome channel is used when this is empty. The dashboard health check flags boost message while this is empty or points at something deleted. Only checked when boost enabled is on. | |
Boost messageboost_message |
text | up to 1900 characters | The thank-you text. It takes the member and server tags, such as {user.mention}, {server}, {server.boosts} (the boost count with this boost) and {server.boost_tier}. {if user.first_boost}...{else}...{end} picks between a member who just started boosting and one boosting again. The Messages page takes up to 2,000 characters. Default: Thank you for boosting **{server}**, {user.mention}! |
Send as an embedboost_embed |
on or off | Embed (the default) sends the thank-you with the booster's avatar as thumbnail, in the welcome colour or one of its own. How it looks on the Messages page adds a title, an author line, a picture link, fields, a footer and a timestamp. Plain text sends the message on its own. | |
Text above the embedboost_embed_content |
text | up to 1900 characters | A line sent with the boost embed so the booster gets a ping, the same tags as the boost message. Default: {user.mention}. Empty sends the embed alone. |
Also DM the boosterboost_dm_enabled |
on or off | Sends the booster a plain text direct message as well as the thank-you in the channel. Default off. | |
Boost DM textboost_dm_message |
text | up to 1900 characters | The direct message text, with the same tags as the boost message. Default: Thank you for boosting **{server}**! Your boost helps everyone here. |
Only first boostsboost_first_only |
on or off | Thanks a member only when they start boosting, not again when they add another boost. Default off. | |
Boost roleboost_reward_role_id |
role | A role given when a member boosts and taken away when they stop boosting, through the same safety check as every role Welcome hands out. Discord's own Server Booster role is managed by Discord and cannot be picked. The dashboard health check flags boost role while this is empty or points at something deleted. Only checked when boost enabled is on. | |
Delete Discord's boost noticeboost_delete_discord_notice |
on or off | Deletes the boost message Discord posts in the system channel once the thank-you is posted. It stays when the thank-you could not be posted. Needs Manage Messages in the system channel; the Messages page says when that is missing. Default off. | |
Also on the dashboard form
Rotating messages On the Messages page, under Extras on the Welcome and Goodbye tabs: lists of up to 25 alternative messages, each up to 1,900 characters with an optional https picture or GIF link, sent at random or in order (one Order setting covers both lists). While a list has entries it replaces the single message text, and a message's own picture takes the card's place.
Rules screening On a server with Discord's rules screening on, the welcome waits until a member accepts the rules: the join log line goes out at once and says so, and the join count, the greeting and card, the DM, the roles and the verification gate follow when they accept.
Send as (goodbye and DM) The goodbye and the welcome DM can be plain text (the default) or an embed like the welcome message.
How it looks For each message sent as an embed: the colour (the goodbye, the DM and the boost message can keep the welcome's), a title, an author line with an icon, a small picture (the member's avatar, the server icon, a link or none), a big picture (the card or the rotating message's picture, a link or none; the boost message has no card), up to 6 fields side by side or stacked, a footer with an icon and the time it was sent. Tags work in every part. A save that would go over a Discord limit (256 characters for a title, 1,024 for a field, 6,000 for the whole embed) is refused instead of cut.
Link buttons Up to 3 buttons under the welcome message and the welcome DM, each with a label of up to 80 characters, an https link and an optional emoji. Tags work in labels and links.
Goodbye card Sends the goodbye card with the goodbye message. Off by default, and only sent while goodbye messages are on. Until it is designed in the Card Studio it follows the welcome card's look with goodbye wording.
Include the welcome card Attaches the same card as in the welcome channel to the welcome DM. Off by default.
Card Studio Designs the welcome and goodbye cards: start from one of 12 templates, pick a background (54 library pictures in 8 sets, a colour, a gradient, the main colour of the member's avatar, an upload or a link) and edit up to 20 text, avatar, image and shape layers, with 39 fonts, on a card from 300 to 2,000 pixels a side. A card on an animated GIF or WebP background is sent as an animated GIF of up to 48 frames, 800 pixels wide and 8 MB, otherwise as a still image. A saved design replaces the Card template and Custom background URL above.
Card uploads Up to 20 background uploads per server: PNG, JPEG, GIF or WebP, up to 8 MB and 25 megapixels, at least 300 by 100 pixels, with up to 64 frames. They are stored by YourBot's image service and served from a public link. An upload a saved card uses cannot be deleted until the card uses another background.
Delete it later On the Messages page, under Extras on the Welcome and Goodbye tabs: delete the welcome message a set number of minutes after it is sent, delete it when its member leaves within a set number of minutes and delete the goodbye a set number of minutes after it is sent. Each runs from 0 (off) to 1,440 minutes. A failed delete is tried up to 3 times, and a message that is already gone is skipped.
Join counter What {join_count} prints. The first counted join starts it at the member count and every later join adds one; members leaving never lower it. The Logs & cleanup page shows it and can set it to any whole number from 0 to 1,000,000,000,000, for a server moving from another bot.
Self-assignable roles On the Roles page: Turn on /roles and pick up to 25 Roles members can pick. Members add them with /roles add and drop them with /roles remove; no other role can be picked, and roles the bot cannot hand out are greyed out with the reason.
Rules On the Rules page: a Title (up to 100 characters, Server rules when empty) and up to 25 rules of up to 300 characters each, with an Embed colour. /rules shows them, Post the rules puts them in a Rules channel and edits that copy in place next time, DM the rules to new members sends them on join and Show the rules when members verify (on by default) puts them under the verification message and on the web page. Saving the list clears the older Rules text.
Button label The text on the verify button, up to 80 characters, such as I agree to the rules. Empty shows Verify in the server's language.
DM the verification steps on join Members who have to verify get a DM with where to go, what to press and the deadline. When the rules DM is on too, it is one DM. Off by default.
Cloudflare Turnstile on the web page A bot check on the web verification page before it verifies anyone. A check that cannot be confirmed verifies nobody, and no IP address is sent. The switch only appears once the platform has Turnstile keys; until then the page says it is not set up yet. Off by default.
Set it up for me On the Verification page: makes an Unverified role (or uses one you pick) and, when no verified role is picked, a Verified role, both without permissions, and a #verify channel that only Unverified members, staff roles and the bot can see, where Unverified members can read but not post. It then hides every other channel Unverified members could see, one channel at a time, turns verification on with your method and who has to verify, and posts the verification message. A confirm step lists every change first, and members already in the server keep their access. Undo deletes only the roles and the channel setup made, puts back the permissions it changed on a role of yours and restores your previous verification settings. Channels made later are visible to Unverified members unless they sit in a category setup hid; run setup again to hide them.
Hold greetings during a raid While Sentinel's raid mode is on, members who join get no greeting, card, welcome DM, rules or verification DM, quest, buddy, milestone post or first-message celebration, and are not greeted later, also after Discord's rules screening or when they verify. The join log still gets a line saying the greeting was held, and roles are still given. On by default. Does nothing while Sentinel is off.
Everyone verifies during a raid While Sentinel's raid mode is on, every member who joins has to pass the gate, even when only suspicious accounts normally do. Needs verification on with a channel and a verified role. Off by default.
Also hold accounts that look like a banned member With Who has to verify set to suspicious accounts, a member Sentinel's ban evasion check flags has to verify too, whatever the account's age, and the join log line names the banned account. It does nothing until ban evasion is on in Sentinel, and with everyone set it changes nothing. If the check is slow or fails, the rest of the gate decides. On by default.
Role menus On the Role menus page: menus of buttons or a dropdown with up to 25 roles, or emoji reactions with up to 20. Choice sets the mode: any combination, one at a time, add only (nothing takes the role away), remove only (nothing gives it), reversed (picking takes the role away and un-picking gives it back) or first pick is final. Max picks caps how many roles a member can hold from the menu (0 means no limit). Each role can also give up to 4 more roles and have a member limit (Most members, 0 means no limit). A full role is refused. Needs one of these roles and Not for members with these roles decide who may use the menu. Reply picks what a click answers privately: what changed, nothing (a refused pick still says why) or your own text with {role}, {roles} and the member tags. Reaction menus never reply. A refused reaction is taken back off. Start from a template creates the roles of a name colour, pronoun, notification, region or platform menu, with no permissions and directly below the bot's role, reusing roles that already have the name. Until the menu is posted, Delete the roles this template created removes them. The bot posts menus as an embed or plain text, and a reaction menu can instead go on a message already in the server, by its link. A paused menu stays in Discord but changes nobody's roles.
Not in this table
Things with their own editor in the dashboard, such as rules, panels, templates and schedules, are described on the overview page under In the dashboard. Internal state is not a setting.
YourBot docs
Reference tables are generated from the code that is running.
Ask in Discord
Suggest a correction