Skynet/discord-bot
6
0
Fork 2
Code Issues 4 Pull requests Projects 1 Releases Packages Wiki Activity Actions

doc: update user docs

Browse source
This commit is contained in:
silver 2024-10-29 14:00:43 +00:00
parent 80c9191eee
commit da4d006bc0
Signed by: silver
GPG key ID: 36F93D61BAD3FD7D
1 changed files with 15 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -1,14 +1,13 @@
# Skynet Discord Bot # Skynet Discord Bot
This bots core purpose is to give members roles based on their status on <ulwolves.ie>. This bots core purpose is to give members roles based on their status on https://ulwolves.ie.
It uses an api key provided by wolves to get member lists. 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. 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. 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.
## Commands - Admin ## Setup - Committee
You need admin access to run any of the commands in this section. You need admin access to run any of the commands in this section.
Either the server owner or a suer with the ``Administrator`` permission Either the server owner or a user with the ``Administrator`` permission
### Getting the Skynet Discord bot ### 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`` 1. Email ``keith@assurememberships.com`` from committee email and say ye want an api key for ``193.1.99.74``
@ -42,29 +41,21 @@ This unlinks a minecraft server from your club/society.
``/minecraft_delete SERVER_ID`` ``/minecraft_delete SERVER_ID``
## Commands - User ## Setup - Users
This is to link your Discord account with your UL Wolves account.
**You will only need to do this once**.
### Setup ### Setup
* Start the process using ``/link_wolves WOLVES_EMAIL`` 1. in a server with the Skynet Bot enter ``/link_wolves WOLVES_EMAIL``
* The email that is in the Contact Email here: <https://ulwolves.ie/memberships/profile> * Your ``WOLVES_EMAIL`` is the email in the Contact Email here: <https://ulwolves.ie/memberships/profile>
* An email will be sent to them that they need to verify using ``/verify CODE`` * This is most likely your student mail
* This will only have to be done once. 2. An email will be sent to you with a verification code.
3. Verify the code using ``/verify CODE``
4. Once complete your Wolves and Discord accounts will be linked.
* If the user is an active member on wolves You will get member roles on any Discord that is using the bot that you are a member of.
* 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 ### Minecraft
Users can link their Minecraft username to grant them access to any servers where teh whitelist is managed by teh bot. You can link your Minecraft username to grant you access to any Minecraft server run by UL Computer Society.
``/link_minecraft MINECRAFT_USERNAME`` ``/link_minecraft MINECRAFT_USERNAME``