The BICS bot's source code may be found in this repository. Its primary goal is to automate the BICS server and provide users and students with a variety of ways to communicate with it.

The bot now supports text channel instructions including help, role attribution, and enrolment/unenrolment to courses.

• Getting Started
  • Initial Setup
  • Bot Deployment
• Commands Available
  • General Commands
  • Role Commands
• Dependencies
• Contributing
  • Steps to Contribute
  • Conventions to Follow

The logic is implemented in a python module called bics_bot that is part of this repository. You will have to install the software locally as a result. This is why I suggest installing it using a virtual Python environment.

1. Set up a python virtual environment (ignore this command if you don't want to)
   • python3 -m env env
2. Install the dependencies
   • pip install -r requirements.txt
3. Create a file .env in the root folder which contains the bot token as TOKEN_BOT_CLONE=token. To get the token, reach out to @Pedro.

You must deploy a bot if you wish to test the code you have written. Run python main.py -c from this repository's root directory to accomplish this. The program to launch the clone rather than the actual bot is specified by the -c option. When the bot is operating, the message Bot is online should appear. Go to the #bot-dev-discussion text channel in the BICS discord server to test any commands you have added. (Note: To view this channel, you must hold the role BotDev)

All commands can be used in any channel as only the user that requests for one is able to see the bot messages.

• /help: This command is used to view the list of the available bot commands.

• /useful_links: This command is used to view a list of some links that might be useful for a BICS student, such as the BSP enrolment form.

• /intro (Only for new members): Allows a new member to get role and to introduce themselves. This command can only be used in the introduction channel (#starting-up).

• /enroll: This command is used for students who wish to get viewing permissions to the text channels of their courses.

• /unenroll: This command is used for students who wish to remove their viewing permissions to the text channels of the courses they are no longer taking.

• /update: This command is used to update the students year. For example, if you are in year 1, then this command will update the year to 2

• /gamer: Gives the Gamer role, which also gives access to the #games text channel to communicate with other gamers in the server.

• /harem: Gives the Harem role, which also gives access to the #harem text channel to collect harem cards.

• /botdev: Gives the BotDev role, which also gives access to the #bot-dev-discussion text channel.

• nextcord: python discord API

• python-dotenv: used to retrieve environment variables

Any contributions are welcome! 😉 If you desired to contribute, you can head to the issues tab and check if there are issues you want to address. In addition, you can also just leave issues as features requests, or bugs that you might have found.

1. Create your own bot. You can follow this (tutorial)[https://discord.com/developers/docs/getting-started] where you should go until Adding scopres and permissions section. When choosing the bot permissions, choose administrator.

2. Create the clone of the BICS discord server. The link for the template can be found in the #bot-discussion text channel in the pin messages.

3. Fork this repo.

4. If you are contributing to an issue make sure to notify that you will be working on that issue, to let others now that someone took that issue.

5. Create a branch where you will work on. The branch name should start with the type of change you want to do followed by a / and the description of the change. For example, say you want to add a new feature which adds a new command to the bot. Then the branch would look like feature/new_command. Another example would be if you want to fix a but then the branch would be of the form fix/...

6. Once you have made your desired changes, you need to make sure that there are no bugs and everything works as expected. (Unless the changes do not affect the code itself, like documentation)

7. Create a pull request from your branch to the main branch of repo.

• All the commands should be seen only by the user that has called the command. This can be achieved by using the ephemeral=True parameter when sending a message. In case the command is supposed to be seen by everyone then the parameter needs to be set to false.

• Class names should follow the CamelCase naming convention

• Everything else than classes should follow the snacke_case naming convention

• The use of docstrings is encouraged to give a brief description of the functions to others