From 15720a1f131efed9924482e58fceef04fcb1c1e6 Mon Sep 17 00:00:00 2001 From: Brendan Golden Date: Mon, 3 Jun 2024 18:23:54 +0100 Subject: [PATCH] doc: better documentation --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ec022b6..068979a 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,12 @@ 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 +## Commands - Admin +You need admin access to run any of the commands in this section. +Either the server owner or a suer with the ``Administrator`` permission + +### 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, ) @@ -17,23 +21,50 @@ For example is a user links on the CompSoc Discord then they will also get their 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 +### Minecraft +The bot is able to manage the whitelist of a Minecraft server managed by the Computer Society. +Talk to us to get a server. -### User is an active member on wolves +#### Add +This links a minecraft server with your club/society. -#### If they have never used the bot before or need to change their email: -* ``/link_wolves`` 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 +``/minecraft_add SERVER_ID`` -#### 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 +#### List +List the servers linked to your club/society. +It is possible to have more than one minecraft server -### User is not an active member on wolves +``/minecraft_list`` -#### If they have both roles: -The current-member role will be removed from them \ No newline at end of file +#### Delete +This unlinks a minecraft server from your club/society. + +``/minecraft_delete SERVER_ID`` + +## Commands - User + +### Setup +* Start the process using ``/link_wolves WOLVES_EMAIL`` + * The email that is in the Contact Email here: +* An email will be sent to them that they need to verify using ``/verify CODE`` +* This will only have to be done once. + +* If the user is an active member on wolves + * If they are in any servers with teh Skynet Bot + * They will get relevant roles. + * If they Join a server with teh bot enabled. + * They will be granted the roles automatically +* If the user is **not** an active member on wolves. + * If they have no Roles + * No change + * If they have Past Member Role + * No change + * If they have both Roles + * The current-member role will be removed from them + * Past Member role will remain unchanged + +### Minecraft +Users can link their Minecraft username to grant them access to any servers where teh whitelist is managed by teh bot. + +``/link_minecraft MINECRAFT_USERNAME``