coderit / lehrbot Goto Github PK

BrickHack and other hackathon servers will likely be setup by people without intimate knowledge of this bot's inner workings. Proper documentation is needed to explain how to correctly setup these servers so that the bot may function effectively.

Currently, it is left up to each mentor and mentee to determine how to communicate. A nice feature would be to automate moving each pair into a voice channel when the mentor sends the ~ready command. Here's the current plan for implementing this:

• A user enters a "waiting" room voice channel (force mute/deafen all clients)
• User types ~queue <topic>
• Mentor enters a dedicated voice channel for topic
• Mentor types ~ready <topic>, removing user from queue
• Student is moved by bot into dedicated voice channel

A couple of considerations:

• Accessibility: how can we replicate this with text channels for deaf/HoH users?
• Scaling: how can we scale this up to an arbitrary number of mentor-mentee meetings for each topic?

The current queue implementation works across multiple Discord servers, but each topic name must be unique across all servers, not within a single server. This makes it unfeasible for public distribution. A possible solution would be to store queue lists in a {Guild: List[Queue]} dictionary.

The term "class" makes sense in the context of mentoring for college courses, but less so in the context of BrickHack. Renaming it to "topic" will help to avoid confusion.

Currently, only administrators are allowed to use mentor commands like ~ready. However, this is insecure in production, especially considering the large number of (unvetted) mentors that could be participating in BrickHack. Checking for the existing topic roles instead of administrator status would alleviate this issue.