feat: Updated README
This commit is contained in:
16
README.md
16
README.md
@ -10,14 +10,22 @@ DiscordKeyBot is a bot designed to securely distribute Steam game keys to users
|
||||
|
||||
## How to use the bot
|
||||
|
||||
The bot will only work for users who have the ability to both manage the discord guild/server and also ban users. I didn't want to make it role based because that's more work, so instead it just checks if you have those permissions from all the roles assigned to you, which I confirmed our mod role in the main server does have. If you don't have these permissions, you won't even be able to see the commands in the server. Only in DMs, but it shouldn't work there.
|
||||
|
||||
- **Set the logging channel:**
|
||||
Before using the registration feature, run `/keys logging` and select the channel where you want bot warnings and notifications to be sent.
|
||||
- **Upload keys:**
|
||||
Use `/keys load` and upload a text file with one Steam key per line. The bot will send a confirmation message saying how many keys are in the file. Confirm the upload to add keys to the vault.
|
||||
- **Post registration message:**
|
||||
Run `/register` to send an official message with a "Claim Key" button. Users who are eligible can click the button to receive a key via DM.
|
||||
Run `/register` in the channel you want the bot to send a message with the "Claim Key" button. Users who are eligible can click the button to receive a key via DM.
|
||||
|
||||
### Manually get users' keys
|
||||
### Claiming a key
|
||||
|
||||
Admins can use `/keys get` and select a user to view their registered key.
|
||||
To check how many keys are left, use `/keys check`.
|
||||
Any user that can view the message where `/register` was ran will be able to click the "Claim key" button. The only restriction is the user must have joined on or before Aug 7th. Users will be DM'd a steam link to redeem their key, as well a copy of the key if they prefer to do it manually. Any future attempts of pressing the "Claim key" button will re-send their existing key in a DM (same message as before).
|
||||
|
||||
When a user claims a key, the bot is set to send a warning in the logging channel when there are 50 keys left and 10 keys left. If a user tries to claim a key when there are no keys left (or none have been loaded), it sends a much bigger warning message in the logging channel, as well as which user tried to claim the key so we can reach out. The user is also told to reach out to me in the offtopic channel for assistance.
|
||||
|
||||
### Manually get a user's key
|
||||
|
||||
Admins can use `/keys get` and select a user to view their registered key, if one is associated with their account.
|
||||
To check how many keys are left in the vault, use `/keys check`.
|
||||
Reference in New Issue
Block a user