Skip to content
This repository was archived by the owner on Jul 13, 2019. It is now read-only.

Config Explaination

zekro edited this page Apr 1, 2018 · 4 revisions

Token

"token": ""

Your Discord Bot Token you will get from Discord Developer Page.

Giphy Key:

"giphy_key": ""

If you want to use the zb:gif command, you need to add your giphy API key.
How to get the key?
Just go to this site and click on Create an App. Then give the child a name and after that, you'll get displayed your API key, which you need to enter here in the config.

YouTube Key:

"youtube_api_key": ""

For playing music with the bot, there is no key needed, but if you want to play YouTube playlists, you'll need to enter a Google API key to access the YouTube Data APi to get the videos out of the playlist.

Here you can find a simple guide how to create a YouTube API key.

Prefix

"prefix": "zb:"

Default config will be generated with value zb:.

The prefix, you will be able to call te bot globally, also if guild prefix is set or changed. This prefix should not be such a simple prefix like - or !, because it could cause errors and unwanted behaviours with other bots using this prefix, because the bot will always answer with this prefix!

MySql

"mysql": {
    "host": "localhost",
    "user": "",
    "password": "",
    "database": "zekroBot2"
}

You access data to your MySql database.

As user, you should create a seperate user only having access to only this DB. Just for security purposes.
NEVER USE YOUR ROOT ACCOUNT FOR THIS!

Experience

"exp": {
    "interval": 10,        
    "xpinterval": 15,      
    "xpmsgmultiplier": 150,
    "flatter": 100,        
    "cap": 0.8,            
    "delta": 1.2,   
    "startlvl": 1000,      
    "reports": [10000, 5]                      
}

The default values are example values I personally use on the official public zekroBot2 account.

The function for XP calculation for messages looks like following:

xp = log( ( LENGTH / FLATTER ) + CAP ) * XPMULTIPLIER
  • interval
    Interval in minutes online membs getting xp

  • xpinterval
    Ammount of xp users get in online interval

  • xmultiplier
    Multiplier for message length

  • flatter
    How much the calculation function is flattened

  • cap
    At which growth the function will cap

  • delta
    How much xp is needed for the next level
    (XPlvl2 = XPlvl1 * 1.2) ...

  • startlvl
    XP needed for lvl 1 and base for each other level above

  • interval
    XP which will substracted after a report
    [0] -> ammount at first report
    [1] -> times the start ammount at each next report (2nd: 10000 * 5)

Clone this wiki locally