Adding Bot to a IIIT Club Server

Adding the bot

1. Make a pull request to the server by ediing the bot/server_config.ini file as per your server requirements. (configurations are detailed below)

2. Create a new role for the bot, which is above the roles of regular members (bot can only verify members lower in role than itself)

3. After your PR is merged, navigate to the this URL to authenticate the bot and add it to your server. Note that you must have "Manage Server" permission on this server. (If you're new to Discord roles, read the FAQ: link)

4. One of the admins will then merge your pull request allowing the bot to work on your server.

Notes

1. .verify might not work for server-admins. In that case, the role the bot has should be higher than the role of the server admin.
2. We recommend that you create a new channel (like #server-help) where all your users can run the .verify command.

If at any point you face any difficulty, raise a new issue in this GitHub repository.

Regarding roles

1. The bot will only be able to give the user the role A if the bot's topmost role is above role A.
2. To change nickname for a user, the user's highest role should be lower than the bot's highest role.
3. The bot should have read access to the channel to read .verify commands
4. The bot should have write access to the channel to give feedback on verification (Success/Failure).

Configuration parameters

The following configuration are possible through bot/server_config.ini:

1. setrealname: set member nickname (post verification) equal to their real name (obtained from CAS).
2. grantroles: a comma-separated list of roles you'd like to assign to the member post-verification. If the roles do not exist in the server, they'll be created automatically.
3. serverid: ID of the Discord server. See Discord FAQ. (In Discord lingo, a server is known as a guild.)

Example usage:

[Chess Club]
serverid=724827932778037370
setrealname=yes
grantroles=Verified,IIIT