Skip to content
This repository has been archived by the owner on Nov 13, 2022. It is now read-only.

Configuration

synzen edited this page Sep 24, 2017 · 2 revisions

Type Definitions:

Number - A non-negative integer (no quotes).

Boolean - Either true or false (no quotes).

String - Text that must be enclosed with quotes. Example: "my text"

Array[String] - Multiple strings enclosed by [ and ], separated by commas. Example: ["mythinghere", "mysecondthinghere"] or with a single item: ["myotherthing"]

General Configs

Name Description
token Bot token generated with discord.
timezone Timezone used for X-axis time labels. use a timezone from this list under the TZ column. Default is "UTC".
databasePrefix Prefix used for the different databases needed to store data for Trackers. Make sure it is unique from your other databases. There is a reset command used to drop databases starting with this prefix.
mysql Your MySQL host, username and password is set here.
defaults See below.

Method Default Configs

Under each method name, there is a command key. For example:

"game": {
    "command": "gamestats"
},

// more configs..

"onlineUsers": {
    "command": "onlineusers",
    "intervalHrs": 24,
    "maxPlots": 120
}

The command is the Discord command used to output that particular stat.

Current Method

The only key each Current method needs to have is a command key.

Tracker Method

Each method has a intervalHrs and a maxPlots key.

intervalHrs - Insert an entry into the database at this interval used for data plots.

maxPlots - Max number of entries allowed in a table for a particular Tracker.

minimum - Only needed for the messageMinimum Tracker. Specifies the minimum number of messages a member must make within an interval to be added into the database for data plots.

Clone this wiki locally