ClassMate Bot
Basic Overview :: Description :: Installation :: Commands :: Future Scope :: Contributors :: Wiki
Project 3 demo video:
Watch it on youtube! https://www.youtube.com/watch?v=KBBqUkOTuSo
Watch it here:
:dart: Basic Overview
This project helps to improve the life of students, TAs and teachers by automating many mundane tasks which are sometimes done manually. ClassMateBot is a discord bot made in Python and could be used for any discord channel.
This is Project 3 for the ClassMateBot. Changes are marked below and listed in Project 3 Changes.
:orange_book: Description
There are three basic user groups in a ClassMateBot, which are Students, Professor and TAs. Some basic tasks for the bot for the students user group should be automating the task of group making for projects or homeworks, Projection deadline reminders, asking questions, getting questions for review etc. For TAs it is taking up polls, or answering questions asked by the students.
Our ClassMateBot focuses on the student side of the discord channel, i.e. currently it focuses on the problems faced by the students while using these discord channels.
The user stories covered here would be more concerned about the activities for the channel for Software Engineering class in North Carolina State University for the Fall 2021 semester.
1 - Student Verification
Once the new member joins the server, before giving them the access to the channels there is a need to get the real full name of the member to map it with the discord nick name. This mapping can later be used for group creation, voting and so on. To do this we first assign the unverified role to the new comer and then ask them to verify their identity using $verify command. If that goes through, the member is assigned a student role and has full access to the server resources. The bot then welcomes the member and also provides important links related to the course.
2 - Project Voting
Voting for projects is a common occurence that many students must endure. With the addition of a voting system, this task is made easier by allowing student groups to place themselves on projects through an easy to use discord system. With the combination of the ClassMateBot grouping system, teams can easily vote their group into a project, switch their votes, or view the full list of projects that have been voted for.
3 - Deadline Reminder (Updated in Project 3!)
Deadlines now send automatic messgages for assignments that are due that day and assignments that are due within the hour! Check out more here
The next important thing our project covers is the Deadline reminder feature of our bot. Students may add homeworks, links, and due dates using the system, and then view their daily or weekly dues with ease. No longer will a student be vulnerable to those odd submission times like 3:00 PM. See homework specific to one class, due today, or due this week!
4 - Personally Pinning Messages
Another problem that the students face is that they cannot pin important messages they want to go back to later. With pinned messages, the student can save discord message links easily to point back to prior messages or just leave their own general messages. It is a very easy system to use and could be creatively used by a student in many different ways to promote better classroom success.
5 - Group Creation
Another unique and useful feature of our ClassMateBot is that it helps the students in the process of group making for their projects. Through this feature, the bot could help the students identify other members of the class with similar ideals and acts as a medium to connect them initially. This feature is also helpful for students randomly assigned to a group to connect with the new member which would not only save time, but also, saves effort as many times students do not have their names as their usernames on discord. Through this students can join, leave or connect with others.
Moreover, the group creation feature allows members of the group to join a private text channel to communicate with ease! This works by assigning a role to the user when they join a group and giving them access to the private channel specically for their group, this is especially useful when switching groups because a change in the user's role will automatically revoke access to the private channel. Additionally, the private channels are set up so instructors can help with clarifications directly without having to reach out to them via DMs.
6 - Question and Answer (Updated in Project 3!)
A common usage for our current class Discord is for students to ask questions about the course. It is helpful for the questions to be numbered and for the answers to be attached to the question so it be easily found. Some students may feel more comfortable asking and answering questions anonymously. It is also helpful for users to know if the question is answered by a student or instructor. This feature keeps the questions and answers all in one channel so it does not clutter other channels and can be more easily viewed.
7 - Review Questions
An essential part of studying is going over questions related to the exam topics. This feature allows instructors to add review questions and students to get random review questions. To enhance its effectiveness, the answers to the review questions are hidden as a spoiler that students can choose to unveil when they are ready.
8 - Polling (NEW in Project 3!)
Users can now create polls! Instructor can ask for student opinions.
We can also create Quiz Poll\
:arrow_down: Installation
To install and run the ClassMate Bot, follow instructions in the Installation Guide.
:computer: Commands
General commands in bot.py
:open_file_folder: $whitelist command (New Command in Project 3)
:open_file_folder: $dewhitelist command (New Command in Project 3)
:open_file_folder: $toggleFilter command (New Command in Project 3)
For the newComer.py file
:open_file_folder: $verify command
For the voting.py file
:open_file_folder: $projects command
:open_file_folder: $vote command
For the deadline.py file (Updated in Project 3!)
:open_file_folder: $add homework command (Updated in Project 3!)
:open_file_folder: $change reminder due date command (Updated in Project 3!)
:open_file_folder: $clear all reminders command
:open_file_folder: $course due command
:open_file_folder: $delete reminder command
:open_file_folder: $due this week command (Updated in Project 3!)
:open_file_folder: $duetoday command (Updated in Project 3!)
:open_file_folder: $listreminders command
:open_file_folder: $timenow command
:open_file_folder: $overdue command (New Command in Project 3)
:open_file_folder: $clearoverdue command (New Command in Project 3)
For the pinning.py file
:open_file_folder: $pin command
:open_file_folder: $unpin command
:open_file_folder: $pinnedmessages command
:open_file_folder: $updatepin command
For the groups.py file
:open_file_folder: $startupgroups command
:open_file_folder: $reset command
:open_file_folder: $connect command
:open_file_folder: $groups command
:open_file_folder: $group command
:open_file_folder: $join command
:open_file_folder: $leave command
For the qanda.py file (Updated in Project 3!)
:open_file_folder: $ask command (Updated in Project 3)
:open_file_folder: $answer command (Updated in Project 3)
:open_file_folder: $DALLAF command (New Command in Project 3)
:open_file_folder: $getAnswersFor command (New Command in Project 3)
:open_file_folder: $deleteAllQA command (New Command in Project 3)
:open_file_folder: $deleteQuestion command (New Command in Project 3)
:open_file_folder: $archiveQA command (New Command in Project 3)
:open_file_folder: $spooky command (New Command in Project 3)
:open_file_folder: $allChannelGhosts command (New Command in Project 3)
:open_file_folder: $channelGhost command (New Command in Project 3)
:open_file_folder: $unearthZombies command (New Command in Project 3)
:open_file_folder: $reviveGhost command (New Command in Project 3)
For the reviewqs.py file
:open_file_folder: $addQuestion command
:open_file_folder: $getQuestion command
For the polling.py file (All new in Project 3!)
:open_file_folder: $poll command
:open_file_folder: $quizpoll command
:earth_americas: Future Scope
Future scope suggested tasks are located in the Projects tab.
