mirror of
https://github.com/aydenjahola/discord-multipurpose-bot.git
synced 2024-11-22 16:55:55 +00:00
update README and .env.example
This commit is contained in:
parent
f65ec8ca0f
commit
2600ab8523
2 changed files with 13 additions and 67 deletions
10
.env.example
10
.env.example
|
@ -6,19 +6,9 @@ EMAIL_NAME="Example"
|
||||||
EMAIL_USER=example@example.com
|
EMAIL_USER=example@example.com
|
||||||
EMAIL_PASS=YOUR_EMAIL_PASS
|
EMAIL_PASS=YOUR_EMAIL_PASS
|
||||||
|
|
||||||
# Allowed domains for email verification
|
|
||||||
EMAIL_DOMAINS=example@example.com // or it can be a list, example: example.com,example2.com
|
|
||||||
|
|
||||||
# API
|
# API
|
||||||
RAPIDAPI_KEY=YOUR_RAPIDAPI_KEY // grab yours from https://rapidapi.com/community/api/urban-dictionary/playground/53aa4f68e4b07e1f4ebeb2b0
|
RAPIDAPI_KEY=YOUR_RAPIDAPI_KEY // grab yours from https://rapidapi.com/community/api/urban-dictionary/playground/53aa4f68e4b07e1f4ebeb2b0
|
||||||
WORDNIK_API_KEY=YOUR_WORDNIK_API_KEY // grab yours from https://developer.wordnik.com/
|
WORDNIK_API_KEY=YOUR_WORDNIK_API_KEY // grab yours from https://developer.wordnik.com/
|
||||||
|
|
||||||
# Discord
|
|
||||||
GUILD_ID=YOUR_GUILD_ID
|
|
||||||
VERIFICATION_CHANNEL_NAME=YOUR_VERIFICATION_CHANNEL_NAME
|
|
||||||
VERIFIED_ROLE_NAME=YOUR_VERIFIED_ROLE_NAME
|
|
||||||
LOG_CHANNEL_ID=YOUR_LOG_CHANNEL_ID
|
|
||||||
MOD_ROLE_ID=YOUR_MOD_ROLE_ID
|
|
||||||
|
|
||||||
# Database
|
# Database
|
||||||
MONGODB_URI=YOUR_MONGODB_URI
|
MONGODB_URI=YOUR_MONGODB_URI
|
70
README.md
70
README.md
|
@ -6,9 +6,15 @@ Welcome to the **Discord Multipurpose Bot**! This bot manages user verification
|
||||||
|
|
||||||
- **Email Verification**: Users receive a verification code via email and must enter it in Discord to verify their account.
|
- **Email Verification**: Users receive a verification code via email and must enter it in Discord to verify their account.
|
||||||
- **Role Management**: Automatically assigns a specific role to users once they have been verified.
|
- **Role Management**: Automatically assigns a specific role to users once they have been verified.
|
||||||
- **Trivia Game**: Play a video game-themed trivia game and compete with others in the server.
|
- **Trivia Game**: Play a video game-themed trivia game with various categories such as Anime & Manga, Computers, Board Games, Comics, Cartoons & Animations, Film, General Knowledge, Science, Animals, Music, History, Mythology, and Geography & Nature.
|
||||||
- **Leaderboard**: Displays the top players based on correct trivia answers.
|
- **Leaderboard**: Displays the top players based on correct trivia answers.
|
||||||
- **Customizable**: Configure email domains, roles, trivia settings, and more to suit your server.
|
- **User Information**: Retrieve information about a specific user or yourself, including roles and account details.
|
||||||
|
- **Warning System**: Issue warnings to users with a reason logged for future reference.
|
||||||
|
- **Message Purge**: Moderators can delete messages from a channel.
|
||||||
|
- **Ping and Uptime**: Check the bot's latency and how long it has been running.
|
||||||
|
- **Admin Log**: Admins can review logs of verification attempts and trivia games in a designated channel.
|
||||||
|
- **Customizable Settings**: Configure email domains, channels, roles, and more to suit your server.
|
||||||
|
- **Help Command**: List all available commands and their descriptions for easy reference.
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
|
@ -38,60 +44,10 @@ rename the [`.env.example`](./.env.example) to `.env` and fill in the required e
|
||||||
node bot.js
|
node bot.js
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
make sure to run `/setup` or otherwise the verification process wont work.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Information Commands
|
run `/help` command to get list of all avaiable commands, or visit the [commands](./commands/) directory to view them.
|
||||||
|
|
||||||
- **/botinfo**: Displays information about the bot
|
|
||||||
- **/serverinfo**: Displays information about the server
|
|
||||||
|
|
||||||
### Utility Commands
|
|
||||||
|
|
||||||
- **/help**: Lists all available commands
|
|
||||||
- **/ping**: Replies with Pong! and bot latency
|
|
||||||
- **/uptime**: Shows how long the bot has been running
|
|
||||||
|
|
||||||
### Email Verification Commands
|
|
||||||
|
|
||||||
- **/verify `your_email@example.com`**: Sends a verification code to the provided email.
|
|
||||||
- **/code `your_code`**: Validates the provided verification code and completes the verification process.
|
|
||||||
|
|
||||||
### Moderation Commands
|
|
||||||
|
|
||||||
- **/purge**: Deletes messages from the channel
|
|
||||||
- **/userinfo**: Displays information about a user
|
|
||||||
- **/warn**: Issue a warning to a user
|
|
||||||
|
|
||||||
### Fun Commands
|
|
||||||
|
|
||||||
- **/trivia**: Starts a trivia game with video game-themed, Anime & Manga, Computers, Board Games, Comics, Cartoons & Animations, Film, General Knowledge, Science, Animals, Music, History, Mythology and Geography & Nature (more to come soon!) questions. Players have 30 seconds to answer.
|
|
||||||
|
|
||||||
- Accepts both number answers (1-4) **or** the correct answer
|
|
||||||
- for example:
|
|
||||||
```sh
|
|
||||||
Trivia Question
|
|
||||||
In Terraria, which of these items is NOT crafted at a Mythril Anvil?
|
|
||||||
Option 1
|
|
||||||
Ankh Charm
|
|
||||||
Option 2
|
|
||||||
Sky Fracture
|
|
||||||
Option 3
|
|
||||||
Orichalcum Tools
|
|
||||||
Option 4
|
|
||||||
Venom Staff
|
|
||||||
```
|
|
||||||
##### **Answer**
|
|
||||||
```sh
|
|
||||||
1
|
|
||||||
```
|
|
||||||
**or**
|
|
||||||
```sh
|
|
||||||
Ankh Charm
|
|
||||||
```
|
|
||||||
|
|
||||||
- **/leaderboard**: Displays the top 10 players on the trivia leaderboard based on their correct answers.
|
|
||||||
|
|
||||||
### Other Functionalities
|
|
||||||
|
|
||||||
- **Role Management**: Once a user is verified, they are automatically assigned a predefined role.
|
|
||||||
- **Admin Log**: Admins can review logs of verification attempts and trivia games in a designated channel.
|
|
||||||
|
|
Loading…
Reference in a new issue