Generated13 settings
Voice Channels settings
The Voice Channels 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 | Ce que cela fait |
|---|---|---|---|
| Channels | |||
Lobby channellobby_channel_id |
voice channel | The voice channel members join to get their own room. Required. The dashboard health check flags join-to-create lobby while this is empty or points at something deleted. | |
Room categorycategory_id |
category channel | The category new rooms are created in. Rooms inherit its permissions unless custom roles are used. The dashboard health check flags voice channel category while this is empty or points at something deleted. | |
Lobby namelobby_name |
text | up to 100 characters | Name for the lobby when the bot creates it for you: the background auto-create, the Re-create Lobby + Category button, and a lobby set to Recreate if deleted that has no label. Default Click to Join. The Auto-Setup wizard always names its lobby Click to Join regardless of this value. |
Category namecategory_name |
text | up to 100 characters | Name for the room category when the bot creates it for you (background auto-create or the Re-create Lobby + Category button). Default YourBot Voice. The Auto-Setup wizard instead reuses or creates a category named Voice Channels and saves that name here. |
Create the lobby for meauto_create_lobby |
on or off | A one-time request. While it is on, the bot creates a voice channel named with the lobby name (default Click to Join) inside the room category when no lobby is saved or the saved one no longer exists, saves it as the lobby, then switches this back off. Runs within about 20 seconds while the bot is online and the service is enabled, and again when the bot starts. Off by default. The dashboard's Re-create Lobby + Category button does the same at once. | |
Create the category for meauto_create_category |
on or off | A one-time request. While it is on, the bot creates a category named with the category name (default YourBot Voice) when no room category is saved or the saved one no longer exists, saves it as the room category, then switches this back off. Runs within about 20 seconds while the bot is online and the service is enabled, and again when the bot starts. Off by default. The dashboard's Re-create Lobby + Category button does the same at once. | |
| Rooms | |||
Room name templatename_template |
text | up to 100 characters | How new rooms are named. Placeholders: {display_name} (the creator's server nickname), {username}, {count} (the room's number among the live rooms from that lobby) and {activity} (the game or stream the creator is in, or their display name when none is visible). Default 🎧 {display_name}. Names are cut to 90 characters. A lobby can set its own template, and a member's remembered name from /voice prefs replaces the template for their rooms. |
Default member limituser_limit |
whole number | 0 to 99 | How many people can be in a new room. 0 means no limit. Owners can change it with /voice limit. |
Delete empty roomsdelete_when_empty |
on or off | Removes a room as soon as the last person leaves it. | |
Creator owns the roomcreator_is_owner |
on or off | Gives the member who opened the room Discord's own permissions on it: View Channel, Connect, Manage Channels, Move Members, Mute Members, Deafen Members and Priority Speaker (plus Manage Permissions when Room owners can edit permissions is on), so Discord's channel menu works for them too. On by default. The /voice commands and the control panel belong to the room's owner whether this is on or off. | |
Bitratebitrate |
whole number | 8000 to 384000 | Audio bitrate for new rooms, in bits per second. Discord caps this by the server's boost level. |
| Access | |||
Permission modepermission_mode |
choice | inherit_category, custom_roles | Who can see and join new rooms. Inherit from category (the default): a room is created with no permissions of its own, so it takes the category's. Custom role allowlist: @everyone is denied View Channel and Connect on every room and each allowed role is granted both. Owner permissions stack on top either way. |
Allowed rolesallowed_role_ids |
list of roles | In Custom role allowlist mode, the roles granted View Channel and Connect on every new room. Ignored in Inherit from category mode. Lock and hide also apply to these roles unless the owner permits them. The dashboard health check flags voice access roles while this is empty or points at something deleted. Only checked when permission mode is custom roles is on. | |
Also on the dashboard form
Fallback category Where new rooms go when the room category already holds 50 channels, which is Discord's limit per category.
Control panel for room owners Sent to the owner by DM when their room is created: buttons for lock, hide, limit, rename, permit, reject, kick, transfer and claim. Anyone can open the same panel privately with /voice info. On by default.
Also post the panel in the room's chat Everyone in the room sees it. Only the owner can use the buttons; Claim works for anyone once the owner has left. Off by default.
Pass the room on when the owner leaves The first person still inside becomes the owner. Off means the room waits for /voice claim. On by default.
Room owners can edit permissions Adds Discord's Manage Permissions to the owner grant. The bot writes its own access on every room and restores it if an owner removes it. Off by default.
New rooms start locked Nobody new can join until the owner unlocks or permits them. A lobby can override this.
New rooms start hidden Only permitted members and roles see the room. A lobby can override this.
Extra lobbies The Lobbies card adds more join-to-create channels, each with its own name template, member limit, bitrate, category and start locked or hidden, overriding the server defaults.
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