Configuration can be provided in the form of a JSON file or as environment variables. When using environment variables the names are hierarchy delimited using a colon (:). A startup the bot will look for a file named config.json and load it if it is available. Environment variables will then be loaded. Values from envrionment variables will override values from the JSON file.
Example JSON:
{
"discord": {
"token": "ABCD123"
},
"database": {
"url": "mongodb://localhost/uo"
},
"bot": {
"commandPrefix": "!",
"channels": {
"whitelist": [
"bot-dev"
]
},
"permissions": {
"cancel-group": [
"Regular", "Officer"
]
}
}
}| Option | Details |
|---|---|
| discord:token | The Bot User token required for the bot to connect to a server. |
| database:url | URL to connect to a MongoDB data store to store group data. |
| bot:commandPrefix | Command prefix to match on. Defaults to !. |
| bot:channels:whitelist | Array of channels that the bot will pay attention to. An empty list means all channels on the server. |
| bot:permissions | Map of permissions, mapped by command id. Should map to an array of roles that can run the command. Some commands may hve programmatic overrides, such as allowing the owner of a group to cancel it even if they do not meet the role requirements. |