kaoushikmurugan / yet-another-better-office-hour-bot

Yet Another Better Office-Hours Bot

      

Architecture redesigned by Zhongning Li (Tommy).

Based on original OH-Bot, BOB V2, and BOB V3 created by Kaoushik Murugan, Noah Rose Ledesma, Grant Gilson, and Stephen Ott.

Office Hour Protocol • User Wiki • Developer Documentation • License

Purpose

We wanted to implement a way to help instructors efficiently automate their office hours through Discord.

So we created YABOB, the Yet Another Better Office-hours Bot, with the goal of allowing students to effectively communicate with their instructors with the option to be able to ask their peers for help while they wait to ensure they receive the help they need.

Overview

YABOB is a Discord queue managment automation bot. This means that YABOB handles students joining/leaving a queue as well as staff members pulling a student out of the queue for a session.

YABOB implements a simple first come first serve queue system, where student are allowed to enter and leave the queue whenever they like while the office hour session is being held.

Apart from basic queue operations, some of YABOB's other useful features are:

• Displaying upcoming office hours as listed on a linked google calendar
• Logging help sessions (who, and how long)
• Notifying students for the queues they're interested in
• Automatically clear queues after a specified amount of inactive time

If you would like to host your own YABOB instance, see the Development Setup Guide to get started with running the bot.

Server Roles

There are three roles that YABOB will interact with on your server.

• Bot Admin: The Bot Admin Role has total control of YABOB's functionalities and server interfaces.
• Staff: The Staff Role allows control over OH sessions and locked channels. This role is usually given to Instructors, TAs and Tutors.
• Student: The Student Role allows for the ability to interface with OH-Queue.

Office Hour Protocol

Below is the standard office hour protocol we follow.

Staff's Protocol

1. Use the /start command to open queues that correspond to the office hour queues they help for.
2. Wait for students to enter the queues of their choice.
3. Use the /next command to dequeue a student and send them an invite to join the voice channel.
4. Use the /stop command once the office hour session is over.

Multiple staff members can help for the same queue. A queue will close if and only if there is no one helping for that queue.

Student's Protocol

1. Wait for the queue to open
2. Join the queue by clicking on the Join button or using the /enqueue command.
3. Wait to be pulled out of the queue by a staff member.
4. Once they are pulled out of the queue, they will received a direct message from YABOB with a voice channel link. Click the link to join the voice channel with the staff member.
5. Leave the voice channel at the end of the session.

More commands can be found here in our wiki.

License

Copyright (C) 2022 Zhongning Li, Kaoushik Murugan, Grant Gilson, Noah Rose Ledesma, Stephen Ott

Released under the GNU GPL v3 license.