The ITWS Discord bot manages the ITWS Discord server by managing courses' roles, channels, and permissions.
Check out the commands/ folder for all of the available commands. In the object that each exports is a name, description, and details of subcommands with descriptions.
- /join course
- /join team
- /leave course
- /leave team
- /test
- /admin courses add
- /admin courses add-teams
- /admin courses remove
- /admin courses remove-teams
- /admin courses clear
Copy over .env.example to .env and populate all of the values. You'll probably have to ask a previous/current developer for a copy.
Hints:
DISCORD_BOT_TOKENthe secret bot token found on the Discord developer page for the bot
npm run devAnytime the name, descriptions, subcommands, etc. of any commands change, the changes must be deployed to Discord to be reflected in the Discord UI.
npm run deploy-commands<title>refers to a course's full title in the database, e.g."Intro to ITWS"<short title>refers to a course's short title in the database, e.g."intro"
@<title>: Role for every student, TA, and instructor in the course.@<title> Instructor: Role for every instructor in the course.@<title> Team <team>: Role for Team<team>members (students only, not faculty).
All of these channels are hidden by default to those without the general course role detailed above.
#<short title>-announcements: Text channel for course faculty to make read-only announcements about the course.#general: Text channel for students and faculty to generally discuss the course.#discussion: Text channel for students and faculty to facilitate discussions on inclass topics or general topics.#team-<team>: Private text channel for team members and course faculty.Team <team>: Private voice channel for team members and course faculty.
