Kilian

Kilian is a Discord bot that manages channels and roles. He was forged to meet the requirements for our BigBrains Server, but he likes to join and manage other servers as well. His main purpose is to manage invisible roles on Discord.

Why invisible roles, you ask? - Great question.

On our server we have a lot of roles to manage which user should see which channel. Now if a user is visiting 12 courses, they have these 12 roles and some vanity roles. But no one wants to see a wall of roles when clicking on a user, so we decided to hide them. Another advantage of letting Kilian hide roles is that he automatically manages the roles of all users, which want to see uni-channels, and we do not have to move a finger.

Usage

Start

Use python kilian.py to start the bot. On every startup, Kilian will pull all courses for the current semester from KUSSS. This can take a few moments. When everything is done, Kilian will greet you properly on the commandline.

/kusss

The command /kusss <link> [student-id] subscribes you to Kilian™ services. The parameter link is the link for the calendar file in KUSSS. The proper link can be obtained here by clicking Create and copying the link. The Optional parameter student-id is the user's student id and can be provided, so others can check it if they need it for a group project for example.

/unkusss

/unkusss unsubscribes you from all Kilian™ services and removes all related collected data.

/ping | @ManagedRole

/ping <@ManagedRole> [Content] lets you ping all users which attend the course, just like @ManagedRole does. The advantage of pinging such a managed role is, that these managed roles are not visible in Discord at all. Further information can be found in the Implementation Details.

/join

With /joinyou can join any course which is managed by Kilian. This allows veterans to help others in need. Furthermore this lets people lurk other subjects if they are interested in what is going on there. If a user does not participate in this subject then they won't be pinged initially. This can be changed with /toggleping

/leave

This command is the opposite of the previous. With /leave users can leave channels by typing the command in the corresponding channel. Even if a user is partaking in the subject, they can leave. A rejoin is always possible, and pings will automatically be enabled for users participating in the subject.

/toggleping

/toggleping toggles the pinging bit in the bot for the current channel where the command has been performed. If you are not sure what state you are currently in, Kilian will tell you after performing the command.

/studid

The studid <@User>-Command returns the student id of the user if they provided it with their link.

/sleep

/sleep shuts Kilian down properly. This command can only be run by Kilian's dads, so make sure to be one of them!

Requirements

Requirements are listed and can be installed with pip install -r requirements.txt

How to get a working discord bot:

• Follow this guide to get your bot
• Set all "Privileged Gateway Intents" to true
• Important note: Select bot and applications.commands as scope
• Add the bot to your server with "Administrator" permissions
• Reset and copy your bot token

Fill out config.json

• Paste your bot-token into the corresponding field
• Paste your discord-id as a string into the "dads" list (to turn Kilian off properly)

Scalability issues

• If 250 roles are generated in less than 48 hours, discord will block your bot for 24 hours. (source)