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 | What it does |
|---|---|---|---|
| Lobbies | |||
The channel members join (main lobby)lobby_channel_id |
voice channel | The voice channel members join to get a room of their own. Required: nothing happens until it is set. It has to be a voice channel of this server, and never a room the bot manages. Home's "Set it up for me" makes one for you. The dashboard health check flags join-to-create lobby while this is empty or points at something deleted. | |
Make a lobby again if someone deletes itauto_create_lobby |
on or off | A one-time request with no switch on the dashboard. While it is on, the bot makes a voice channel with the saved lobby name in the room category when no main lobby is saved or the saved one is gone, saves it as the main lobby, then turns this off again. Runs within about 20 seconds while the bot is online and the service is on. Off by default. A lobby's own switch on the Lobbies page makes it again every time it is deleted, and "Make what is missing" on Settings does it at once. | |
Make a lobby again if someone deletes itauto_create_category |
on or off | A one-time request with no switch on the dashboard. While it is on, the bot makes a category with the saved category name when no room category is saved or the saved one is gone, saves it as the room category, then turns this off again. Runs within about 20 seconds while the bot is online and the service is on. Off by default. "Make what is missing" on Settings does it at once. | |
| New rooms | |||
The category rooms are made in, and where they go when it is fullcategory_id |
category channel | The category new rooms are made in. Rooms take its permissions unless only some roles may join. Empty: rooms are made outside any category. A lobby can send its rooms to another category. The dashboard health check flags voice channel category while this is empty or points at something deleted. | |
Room namename_template |
text | up to 100 characters | What a new room is called. It can hold {display_name} (the member's name on the server), {username}, {count} (the room's number in its lobby) and {activity} (the game they are playing, or their name when none is visible). Default 🎧 {display_name}. Names are cut to 90 characters. A lobby can have its own room name, and a member's own name saved with /voice prefs wins for their rooms. |
How many people a room holds and how it soundsuser_limit |
whole number | 0 to 99 | How many people can be in a new room, 1 to 99. Empty or 0: no limit. An owner can change it with /voice limit, and a lobby can set its own. |
Delete a room when the last person leavesdelete_when_empty |
on or off | On (the default): a room is deleted as soon as the last person leaves it. Off: rooms stay until someone deletes them. | |
Who can see and join new roomspermission_mode |
choice | inherit_category, custom_roles | Everyone who can see the category (the default): a room is made with no permissions of its own, so it takes the category's. Only the roles you pick: @everyone is denied View Channel and Connect on every room and each picked role is allowed both. An owner's permissions come on top either way. |
Who can see and join new roomsallowed_role_ids |
list of roles | When only the roles you pick may join: those roles, allowed View Channel and Connect on every new room. Lock and hide apply to them too 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. | |
How many people a room holds and how it soundsbitrate |
whole number | 8000 to 96000 | How a new room sounds, shown in kbps on the page (stored in bits per second). Empty: Discord's own setting. The highest choice depends on the server's boost level. A lobby can set its own. |
| Settings | |||
Names for a new main lobby and a new categorylobby_name |
text | up to 100 characters | What the main lobby is called when the bot has to make it: "Set it up for me" on Home, "Make what is missing" on Settings, and a lobby made again after it was deleted that has no short name of its own. Default Click to Join. |
Names for a new main lobby and a new categorycategory_name |
text | up to 100 characters | What the room category is called when the bot has to make it, the same ways. A category that already has this name is used instead of making a second one. Default Voice Channels. |
| Room owners | |||
Owners can also use Discord's own channel menucreator_is_owner |
on or off | Gives the member who made the room Discord's own permissions on it: View Channel, Connect, Manage Channels, Move Members, Mute Members, Deafen Members and Priority Speaker, and Manage Permissions too when the switch under it is on, so Discord's channel menu works for them. On by default. The /voice commands and the control panel belong to the room's owner either way. | |
Also on the dashboard form
Your lobbies Lobbies: every lobby, the main one first. Each lobby can make its own kind of room: its own room name, people limit, sound quality, how its rooms start, the category they go in and whether owners get the control panel. Anything a lobby does not set follows New rooms. "Add a lobby" makes a new channel for it or uses a voice channel you already have.
Make a lobby again if someone deletes it Lobbies, a lobby's own switch: when its channel is deleted in Discord, the bot makes it again within about 20 seconds, in the category its rooms go in, named with its short name (else the saved lobby name), and the lobby keeps its settings. Off by default. It does not make a deleted category again: "Make what is missing" on Settings does.
Rooms start locked or hidden New rooms: locked, nobody new can join until the owner unlocks or permits them; hidden, only permitted members and roles see the room. Both off by default. A lobby follows this unless it sets its own, and a member's own choice saved with /voice prefs wins.
The category rooms are made in, and where they go when it is full New rooms, the second category: where new rooms go when the room category already holds 50 channels, Discord's limit. Empty: the lobby's own category when it has space, else outside any category. Managers get a notice when rooms overflow.
The control panel Room owners: sends each new owner the room's buttons by DM (on by default), and can also post a copy in the room's chat for everyone in the room to see (off by default; only the owner can use its buttons, and Claim works for anyone once the owner has left). Anyone in a room can open the panel privately with /voice info. A lobby can turn it on or off for its own rooms.
When the owner leaves Room owners: the room passes to the first person still inside (the default), or waits until someone claims it with /voice claim.
Make what is missing Settings: makes the main lobby and the room category again with the saved names when they were deleted in Discord, and moves the main lobby's own settings to the new channel. It reads Discord first and makes nothing when it cannot. A category with the saved name is used instead of a new one, and whatever still exists is left alone. It says what it made, or that nothing was missing.
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