Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crock authored Nov 21, 2020
1 parent ce50c46 commit 2fc5f15
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# Simple Discord Verification Bot

Originally created for the [Domaincord Community](https://discord.gg/R6wTYQ9).
Originally created for the Domaincord Discord server.

https://discord.gg/R6wTYQ9

## Usage
I'm assuming you already know how to get a bot token and add the bot to your server.

1. Rename the `.env.example` file to `.env` and fill in the appropriate values.
2. Edit the files `intro-message.md`, `community-guidelines.md`, and `verification-message.md` to add your own server rules and custom verification message. Do not change the filenames.
3. Open `index.js` and edit the values of the variables on Lines 2-5. Don't touch anything else unless you know what you are doing.
4. Run `npm install`
5. Run `npm start` or use a process manager like [pm2](https://pm2.keymetrics.io/) to keep the bot running across server restarts and automatically restart the bot if it crashes.
6. As the guild owner, run the command `!svm` in the channel you want designated as the verification channel. **Make sure the bot has access to send messages, delete messages, and react to messages in this channel!**
3. Open `index.js` and edit the values of the variables on Lines 3-5. Don't touch anything else unless you know what you are doing.
4. Create a channel called #verification in your server and make sure that the bot has permission to READ MESSAGES, SEND MESSAGES, and REACT TO MESSAGES.
5. Run `npm install`
6. Run `npm start` or use a process manager like [pm2](https://pm2.keymetrics.io/) to keep the bot running across server restarts and automatically restart the bot if it crashes.
7. **As the guild owner**, run the command `[prefix]svm` in the #verification channel

_Note:_
- If you want to change the name of the verification channel, you need to change the value on lines 69 and 87.
- If you want others to be able to run the command instead of the guild owner, remove or comment out line 36.

## Command Output
![screenshot of command output](https://i.imgur.com/WtcdYsM.png)

0 comments on commit 2fc5f15

Please sign in to comment.