This bot is used to generate and maintain text channels for courses taken by university students to collaborate and chat. It also provides a number of other moderation tools
Commands are restricted to discord users with roles authorised in the config file under "trustedRoles"
-
Install requirements
pip install -r requirements.txt -
Create configuration file from example
cp config.json.example config.json -
Generate OAuth Token (see here) and populate config.json
-
Run bot!
python3 bot.py
The bot has functionality to read courses from a JSON file and automatically create text and voice channels accordingly. The format is as follows:
- A category for each item in the
coursesdictionary in the specified JSON - Nested in this category, a text channel for each item in that category's list
- Nested in this category, a single voice channel
Prefix is $rain followed by some command. All commands and arguments are case sensitive!
$raincreate <filename> will create course channels, roles, and voice channels based on a JSON file with the specified filename
$rainedit <rolemenu name> <arg1> <arg2> [<arg3>] will edit the role menu of the specified name. This command must be sent in the channel that the role menu exists in. It will only edit the role menu - if the reason you are editing is because you are adding or removing channels or roles, you need to manually create or remove these channels or roles. I figure this will be an infrequent thing and so I decided to leave the option open regarding what to do here.
<arg1> should be one of the following commands add, remove, update
add will add a role to a rolemenu
arg2 should be the name of the role to be added
arg3 is not required
remove will remove a role from a rolemenu
arg2 should be the name of the role to be removed
arg3 is not required
update will edit the name of a role in a rolemenu
arg2 should be the name of the role to change
arg3 should be the name you wish to change it to
There is a number of reasons why you might wish messages to be automatically deleted and reposted elsewhere. Whether it is for sending in personal data to the moderation team for verification, or as a reporting system for people to bring things to the moderators attention.
In the "reportingChannels" section of config.json you can add a list of lists to specify what channels should be listened to and where messages should be reposted. The first item in the list is the listening channel, the second item is the channel to repost the message in, and the final item is the message that should be reposted.
The @user, @message, and @<Role>$ keywords will be replaced with the author (As a mention), message of the sender, and the role name respectively
Feature can be disabled by leaving "reportingChannels" an empty list []
To allow for academic integrity moderation, any edited or deleted message will be reposted in a channel specified in config.json under "moderationChannel". By default this is edit-delete-log
Feature can be disabled by leaving "moderationChannel" an empty string ""
Channels that have been created with the automated channel creation can also be locked for a period of time by disabling send message permissions to the role that makes that channel available. This can be helpful during exams and assessment tasks in order to help moderate for academic integrity.
$rainlock [channelName] is a manual command that will disable send message permissions to the role with the same name as the selected channel. If no argument is given, the selected channel is the name of the channel in which the command is sent. If an argument is given, the selected channel will be the channel whose name matches the argument. Either way, a message will be sent by the bot into the channel the command was sent with an unlocked padlock, a user with a "trustedRole" adding their reaction to this message will unlock the channel again.
Alternatively, a file with a schedule of lock and unlock times can be added into the root directory and registered with $rainaddtask <filename>. Registered task files will lock and unlock channels automatically according to the times specified. Note that the time will not fall exactly on the minute so it is recommended to choose a time slightly earlier than the exact time that you need a channel to be locked. The format of times in this file should match that of linux cron jobs. If at any point you are not using a specific file anymore, it is recommended that you run $rainremtask <filename> to unmount the task and save processing power. Files can be validated by using the command $rainchecktask <filename> which will validate the task file.
It is possible to update the config file or add a new json file for channel creation straight from discord!
$rainaddfile with an attached file will add a file to the cwd - if the file already exists you can pass either -o to overwrite, or -a to add a copy in which case the file will be added with an integer eg. (1) added to the filename
$rainremfile <filename> will remove a file from the cwd - Source files are protected
$rainlistfiles will list all files currently the cwd - Source files are excluded
RainbowBot has a built in method of running a shell script on demand. Primarily this is designed to pull the latest master from GitHub and restart the bot, but it can have many other applications.
$rainupdate is the command that will run an executable shell script in the cwd named updatebot.sh
The bot has the capability to receive Direct Messages from users and repost their questions in a moderators channel. The bot looks through all mutual servers it has with the user and posts in all channels where the name matches the name specified in "logChannel".
Feature can be disabled by leaving "logChannel" an empty string ""
Contributions are welcome! Please read the contribution guide before commencing development
Tasks for future development are maintained as issues