doc: split out the documentation
This commit is contained in:
parent
68d7b53905
commit
4691869ae9
3 changed files with 108 additions and 94 deletions
26
doc/User.md
Normal file
26
doc/User.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
# Skynet Discord Bot
|
||||
The Skynet bot is designed to make it easy to verify that you are a member of a Club/Society.
|
||||
The bot will be able to give you member roles for any partnered servers.
|
||||
It also provides secondary manifests such as granting access to minecraft servers managed by teh Computer Society.
|
||||
|
||||
## Setup
|
||||
This is to link your Discord account with your UL Wolves account.
|
||||
**You will only need to do this once**.
|
||||
|
||||
### Setup
|
||||
1. In a Discord server with the Skynet Bot enter ``/link_wolves YOUR_WOLVES_CONTACT_EMAIL``
|
||||
<img src="../media/setup_user_01.png" alt="link process start" width="50%" height="50%">
|
||||
* Your ``YOUR_WOLVES_CONTACT_EMAIL`` is the email in the Contact Email here: <https://ulwolves.ie/memberships/profile>
|
||||
* This is most likely your student mail
|
||||
2. An email will be sent to you with a verification code.
|
||||
<img src="../media/setup_user_02.png" alt="signup email" width="50%" height="50%">
|
||||
3. Verify the code using ``/verify CODE_FROM_EMAIL`` in Discord.
|
||||
<img src="../media/setup_user_03.png" alt="verify in discord" width="50%" height="50%">
|
||||
4. Once complete your Wolves and Discord accounts will be linked.
|
||||
|
||||
You will get member roles on any Discord that is using the bot that you are a member of.
|
||||
|
||||
### Minecraft
|
||||
You can link your Minecraft username to grant you access to any Minecraft server run by UL Computer Society.
|
||||
|
||||
``/link_minecraft MINECRAFT_USERNAME``
|
Loading…
Add table
Add a link
Reference in a new issue