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 24, 2018 · 4 revisions

Token

"token": ""

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

Giphy API 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 API 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.

Pastebin API Key:

"pastebin_api_key": ""

This is required if you want to use the pastebin command.
How to get the key? Just login to pastebin with your account, then, you developer key will be displayed here.

Host ID:

"hostid": ""

Here, you need to enter your discord account ID (not the tag, username or whatelse) that th bot can identify, that you are the host of the bot. Following, you'll have permission level 999 on all guilds as host of the bot. Also, your account tag will be displayed in the info command as reference for questions or bug submissions.

Command Logging:

"logcmds": true

If this is enabled, every command executed with the bot will be saved in the MySql database in the table cmdlog with following values:

guild_id, guild_name, user_id, user_tag, channel_id, channel_name, msg_cont, time_text, timestamp

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