Skip to content

Global config

Info

You can skip this page if you are using managed hosting.

The config file (user/config.js) can be used to configure settings that affect the entire bot (such as the user presence) and default settings. Changes to this file require a restart to take affect.

All properties are required and not nullable.

debug

debug

Type: Boolean

Default: false

Enable debug mode?

defaults

defaults

Type: Object

Default values for guild settings.

colour

colour

Type: ColorResolvable

Default: #009999

The default embed colour.

command_prefix

command_prefix

Type: string

Default: -

The default prefix for commands.

log_messages

log_messages

Type: Boolean

Default: true

Enable logging messages (ticket archives) by default? You should disable this if using SQLite.

name_format

name_format

Type: string

Default: ticket-{number}

The default name format for ticket channels. See categories configuration for details.

opening_message

opening_message

Type: string

The default ticket opening message text. See categories configuration for details.

locale

locale

Type: string

Default: en-GB

The global locale to use for commands (names and arguments etc). This is also the default guild locale.

logs

logs

Type: Object

enabled

enabled

Type: Boolean

Default: true

Enable log files?

keep_for

keep_for

Type: number

Default: 30

The number of days to keep log files for.

split

split

Type: Boolean

Default: true

Split the logs into separate stdout and stderr files?

max_listeners

max_listeners

Type: number

Default: 10

The maximum number of event listeners for the same event before memory leak warnings begin.

plugins

plugins

Type: Array<string>

An array of plugins to load. The plugins must be manually installed with NPM. See plugins for details.

presence

presence

Type: Object

duration

duration

Type: number

Default: 60

The rotation time in seconds if there is more than one activity. Do not go below 15 seconds.

presences

presences

Type: Array<Object>

The rotation time in seconds if there is more than one presence. Do not go below 15 seconds.

The object must have the activity and type properties and can optionally have the status and url properties.

activity
activity

Required

Type: string

The activity name.

status
status

Type: string

Default: online

One of:

  • online
  • idle
  • invisible
  • dnd
type
type

Required

Type: string

The activity type, one of:

  • PLAYING
  • STREAMING
  • LISTENING
  • WATCHING
  • COMPETING
url
url

Type: string

If you set the type to STREAMING, you can set the url to a https://twitch.tv URL.

randomise

randomise

Type: Boolean

Default: true

Randomise the order of the activities?

super_secret_setting

super_secret_setting

Type: Boolean

Default: true

Enable the sending of statistics?

update_notice

update_notice

Type: Boolean

Default: true

Check for updates from GitHub's API on startup?


Last update: October 11, 2021
This website supports keyboard shortcuts