diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a5cf24 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Skynet Discord Bot +This bots core purpose is to give members roles based on their status on . +It uses an api key provided by wolves to get member lists. + +Users are able to link their wolves account to the bot and that works across discord servers. +For example is a user links on the CompSoc Discord then they will also get their roles (automagically) on Games Dev if they are a member there. + +## Getting the Skynet Discord bot + +1. Email ``keith@assurememberships.com`` from committee email and say ye want an api key for ``193.1.99.74`` +2. Create a role for current members (maybe call it ``current-member`` ?) +3. (Optional) create a role for all past and current members (ye can use the existing ``member`` role for this, ) +4. Invite the bot https://discord.com/api/oauth2/authorize?client_id=1145761669256069270&permissions=139855185984&scope=bot +5. Make sure the bot role ``@skynet`` is above these two roles (so it can manage them) +6. Make sure that you have a role that gives ye administrator powers +7. Use the command ``/add`` and insert the api key, role current and role all (desktop recommended) + +The reason for both roles is ye have one for active members while the second is for all current and past members. + +## Using the bot +This is for the user side of things + +### User is an active member on wolves + +#### If they have never used the bot before or need to change their email: +* ``/link`` and enter their email that is in the Contact Email here: +* An email will be sent to them that they need to verify +* Once verified they will be given both roles + +#### If they have previously used the bot and are not yet on the discord server: +* Once they join the server they will be given the roles + +#### If they have previously used the bot and are already on the discord server: +* They will be given both roles within an hour + +### User is not an active member on wolves + +#### If they have both roles: +The current-member role will be removed from them \ No newline at end of file