Generated45 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 | Tipo | Accepted range | O que isso faz |
|---|---|---|---|
| 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. {user}, {user.mention}, {user.name}, {user.id}, {server}, {member_count} and {created_at} are filled in. Up to 2,000 characters. Default: Welcome to **{server}**, {user.mention}! You are member #{member_count}!. To rotate several greetings, add them to the Rotating Messages list on the Settings page; while that list has entries this text is not sent. |
Send as an embedwelcome_embed |
on or off | Sends the greeting as an embed with the accent colour, the member's avatar as thumbnail and a Member #N footer. Server Highlights and Start Here channels only appear inside the embed. Off sends plain text; the card still attaches. Default on. | |
Embed colourwelcome_embed_color |
colour | The accent colour of the welcome embed, as a hex value. | |
| Channels | |||
Join and leave loglog_channel_id |
channel | A staff channel that gets one line per join with the account age in days, the member number and the user id, 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 | |||
Goodbye messagesgoodbye_enabled |
on or off | Posts a message when a member leaves. | |
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. Same placeholders as the welcome message. The bot adds a line saying how long they were a member when it knows the join date. Default: **{user}** has left the server. We had {member_count} members. While the Rotating Goodbyes list has entries, one of those is sent instead. |
| Auto roles | |||
Roles to giveautorole_ids |
list of roles | Roles granted on join. Roles with dangerous permissions are refused. The dashboard health check flags auto-assigned roles while this is empty or points at something deleted. Only checked when autorole enabled is on. | |
Auto rolesautorole_enabled |
on or off | Gives every new member the roles listed below when they join. With verification on, the roles are given when the member verifies, or at once for a member the targeting rule trusts. Default off. /welcome set autorole switches it on as well. | |
Delayautorole_delay_sec |
whole number | 0 to 86400 | Seconds to wait after the join before the roles are given, up to 600. 0 gives them at once. A member who leaves during the wait never gets the roles. |
Remember rolesrole_persist |
on or off | Gives a returning member the roles they had when they left. | |
| Direct message | |||
Welcome DMdm_enabled |
on or off | Sends new members a direct message as well as the channel greeting. | |
DM textdm_message |
text | up to 1900 characters | The direct message text. Same placeholders as the welcome message. |
| Extras | |||
Member milestonesmilestone_enabled |
on or off | Posts 🎉 **We just hit N members!** when the member count reaches one of the milestones set on the Settings 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. | |
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 | |||
Attach a welcome cardwelcome_card_enabled |
on or off | Attaches an 800 by 350 image with the member's avatar, Welcome to <server>, their display name and Member #N. 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 card look: gradient, dark, light, minimal, or custom with your own background image. |
Custom background URLwelcome_card_bg_url |
text | up to 400 characters | The picture behind the Custom Background template. Paste an https link to a JPG or PNG up to 5 MB, ideally 800 by 350; it is stretched 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 the gradient look. |
| First message | |||
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 to itfirst_msg_react |
on or off | Adds a reaction to the member's first message. | |
Role after first messagefirst_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 | |||
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 / Update message on the Settings page so the Verify button exists. | |
Verification channelverify_channel_id |
channel | Where the verify prompt is 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. | |
Verify promptverify_message |
text | up to 1900 characters | The text shown with the verify button or captcha. |
Rules textverify_rules_text |
text | up to 4000 characters | Rules shown to the member before they verify. |
Verify methodverify_type |
choice | button, captcha, web | button is one click, captcha shows an image code, web sends the member to a browser page. |
Who must 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 account ageverify_suspicious_max_age_days |
whole number | 1 to 365 | In suspicious mode, accounts younger than this many days must verify. |
Unverified roleverify_unverified_role_id |
role | A role held from join until the member verifies, so you can restrict them meanwhile. | |
Time limitverify_kick_after_min |
whole number | 0 to 10080 | Minutes a member has to verify before the fail action runs. 0 means no limit. |
Reminder before the limitverify_dm_reminder_min |
whole number | 0 to 10080 | Minutes before the time limit at which the member gets one reminder DM. 0 sends none. Must be smaller than the time limit, otherwise it is saved as 0. |
Captcha refreshverify_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). |
When the limit runs outverify_fail_action |
choice | kick, ban, hold, none | kick, ban, hold (give the fail 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 programme | |||
Buddy programmebuddy_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 pool role and a welcome channel. With verification on, the pairing happens when the member verifies. Default off. | |
Buddy pool 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. | |
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, not the Settings page. 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. | |
Also on the dashboard form
Rotating Messages and Rotating Goodbyes Lists of up to 25 alternative greetings or goodbyes, each with an optional picture link, served at random or in order. While a list has entries it replaces the single message text.
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