Update README.md

master
Auri Collings 2021-03-17 15:12:22 -07:00 committed by GitHub
parent e772031f06
commit 241fe05a0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 16 deletions

View File

@ -41,37 +41,48 @@ To allow the bot to start, track levels, and give role rewards, fill out `conf.t
```TOML ```TOML
[auth] [auth]
discord = "token" # https://discord.com/developers/applications # A Discord Bot token
mongo_url = "mongodb_url" # MongoDB URL discord = "token"
# MongoDB URL
mongo_url = "mongodb://host/database"
[options] [options]
status = string # Custom status # Custom status
prefix = string # Command prefix status = "Hanging out"
delete_triggers = boolean # Delete commands after execution # Command prefix
prefix = "/"
# Delete commands after execution
delete_triggers = true
[plugin.level] [plugin.level]
please_and_thank_you = boolean # Bot responds to "good dog" after ranking up. # Bot responds to "good dog" after ranking up.
please_and_thank_you = false
[plugin.level.message] [plugin.level.message]
cooldown = number # Cooldown time # Cooldown time
min_length = number # Minimum message length cooldown = 30
# Minimum message length
min_length = 30
[plugin.level.experience] [plugin.level.experience]
# https://www.desmos.com/calculator/80hyi0deu6 # https://www.desmos.com/calculator/80hyi0deu6
a = number # First level XP offset. # First level XP offset.
b = number # Larger values makes XP / level higher. a = 15
c = number # Larger values make XP / level exponentially higher. # Larger values makes XP / level higher.
b = 6.5
# Larger values make XP / level exponentially higher.
c = 1.5
[[plugin.level.roles]] [[plugin.level.roles]]
level = 1 # Level to acquire role # Level to acquire role
role = string # Role ID level = 1
role = "RoleID"
[[plugin.level.roles]] [[plugin.level.roles]]
level = 2 level = 2
role = string role = "RoleID"
[[plugin.level.roles]] [[plugin.level.roles]]
level = 5 level = 5
role = string role = "RoleID"
...
``` ```
### Contributing ### Contributing