#
Configure YABOB Settings
Starting with version 4.3, YABOB will post a /settings
command to your sever as the entry point for all server related configurations such as:
After session message : The message sent to the students after they finish receiving helpRoles : Which roles should YABOB use as Bot Admin, Staff, and StudentQueue Auto Clear : How long should YABOB wait until all closed queues will be automatically clearedLogging Channel : Which text channel should YABOB send logs toAuto Give Student Role : Whether to automatically give new members the @Student Role upon joining the serverCalendar Settings : Which calendar should YABOB read from for the Upcoming Sessions EmbedGoogle Sheet Settings : Which google sheet should YABOB write attendance logs to
Note
- All settings are only available to Bot Admins.
- All settings are enabled/disabled for all queues on the server. For example, if queue auto clear is set to 30 minutes, then ALL queues on the server will clear 30 minutes after they close.
#
📝 Server Roles
YABOB needs to know which roles to interpret at Bot Admin , Staff , and Student to enforce the access levels of all the commands. This setting controls which role will be used. We recommend using either one of the "Use Existing Roles" option.
#
🔘 Use Existing Roles
Use existing roles named the same as the missing roles. If not found, create new roles.
#
🔘 Use Existing Roles (@everyone is Student)
Same as
#
🔘 Create New Roles
Create brand new roles for the missing roles.
If roles named Bot Admin, Staff, or Student already exist, duplicate roles will be created.
#
🔘 Create New Roles (@everyone is Student)
Same as
#
/set_roles
Command
For more granular control, use the /set_roles
command to individually configure the roles.
#
⏳ Queue Auto Clear
This setting controls whether the queues will automatically clear themselves after closing.
#
🔘 Set Auto Clear Time
Use the modal to put in the number of hours and minutes to wait before clearing a closed queue. For example, if auto clear is set to 9h 0min
, then after the queue becomes closed, everyone that's still in the queue will be cleared in 9 hours.
- Maximum timeout is 100 hours and 39 minutes. (If 99 hours 99 minutes is entered into the textbox)
- If there's a running timer when this command is used, the old timer will be discarded and a new timer with the new timeout will be started.
Queue channels will also display the timer:
#
🪵 Logging Channel
This setting controls which channel should YABOB send logging messages to. The logs will look like the following:
All command usages, button presses, and errors will be sent to this channel.
#
📨 After Session Message
Sometimes it could be useful to automatically send a message to the students after they finish receiving help, such as asking for feedbacks. Here's an example message:
#
🔘 Set After Session Message
Use the modal to input the after session message. All discord markdown syntax is supported. You can check which markdown rules are supported on discord here
#
🎓 Auto Give Student Role
Manually assigning the student role to new members could be tedious. This setting configures whether YABOB should automatically give the student role to new members when they join the server.
#
🔘 Enable
YABOB will automatically give new members the
Student
role as soon as they join the server. You can always check which role is
Student
on your server by going to the
#
🔘 Disable
YABOB will not add roles to new members.
#
📅 Calendar Settings
Changes the calendar this server reads from for office hour events.
#
🔘 Change Calendar Settings
Once clicked, a form will pop up asking for a calendar ID and an optional public embed URL.
#
How to find this calendar ID
Open Google Calendar, click the 3 dots on the calendar that you want to use \to click
Settings and Sharing
.Click
Make available to public
Scroll down to
Integrate Calendar
and copy the string underCalendar ID
. This is the id string of your calendarFill the calendar id field with this id.
If the public embed url is unspecified, the [Full Calendar]
button in all the #queue
channels will take users to the default google calendar embed, which looks like the following:
If you wish to have a different calendar website than the default google calendar embed, fill in the public embed URL as well (URL must be complete, i.e include https).
YABOB cannot check if this URL is safe for users to click on, so it is the server owner's responsibility to ensure the link is safe.
#
🙋 Help Topic Prompt
Controls whether to show students a modal asking for a help topic. This is useful if helpers wishes to know what the students in the queue need help with before they join the voice channel.
#
🔘 Enable
YABOB will start showing students a modal that asks them what topic do they need help with. Students are not required to submit the modal (they can dismiss it by closing it or clicking Dismiss), and they will still be queued if they don't submit.
This modal is shown when the student uses /enqueue
or click [Join]
.
Once the student submits this modal, all helpers of this queue will see:
#
🔘 Disable
YABOB will not show students the Help Topic modal. Students will be directly enqueued when they use /enqueue
or the [Join]
button.
#
🧐 Serious Mode
Controls whether to show "fun stuff" like emojis in queue channels.
#
🔘 Enable
Removes all emotions and the hidden cat from the queues
#
🔘 Disable
Enables all emotions and the hidden cat from the queues
#
📊 Google Sheet Settings
Controls which Google Sheet this server will be used for logging.
#
🔘 Change Google Sheet
Use this button to change which google sheet to use for logging helper hours. Clicking this button will prompt a modal asking for a google sheet ID.
#
How to find this google sheet id
A google sheet's URL looks like this:
https://docs.google.com/spreadsheets/d/<thisVeryLongStringIsYourGoogleSheetIdYesItsReallyLong>/edit
The string after d/
and before /edit
is your google sheet id.
#
Before you click submit
Make sure the google sheet is shared with the YABOB in your server and YABOB has EDIT permission. You can find YABOB's email in the google sheet settings menu.
You can always revoke the permission by removing yabob from the list of accounts with access or reset to the default google sheet.
GoogleSheetConnectionError
- If this google sheet is not accessible. This can happen if you did not share the google sheet with the YABOB inside your server. Don't worry, YABOB will tell you what its email address is when this error happens.
No immediate side effect. The next log will be written to this new google sheet.
#
🔘 Reset Google Sheet
Clicking this button will tell YABOB to use the default (public) google sheet for logging tutor hours. We recommend not using this default sheet for production environment since it's public.