Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 5.43 KB

configuration.mdx

File metadata and controls

88 lines (60 loc) · 5.43 KB
sidebar_position
3

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Configuration

Here is some information about the configuration of the bot.

Configuration File

The config.js file is located in the same folder as the bot executable. This file contains all the configuration options for the bot. You can find a list of all the configuration options below.

Configuration Options

General

Command Description
token Discord Bot token, You can obtain a bot token in the Discord Developers Portal make sure to use 1 bot per token, else you will get rate limited by Discord
licenseKey Your account ID of your DBD account, more info about this here
guildId The Discord server ID where the bot will be used in
updateIntervalSec The amount of seconds between data updates by the bot
debugMode Whether the bot should be in debug mode or not, this will enable more logging

Presence

All options inside the botPresence config option.

Command Description
username The username of the bot, keep empty if you don't want the name to be updated
status The status of the bot. (Options: Online, Idle, Dnd, Invisible )
activity The bot activity message that should be displayed
type The status type. (Options: Playing, Streaming, Listening, Watching)
Available Placeholders for the main bot presence

These placeholders can be used in the botPresence.activity field.

Placeholder Description
{totalPlayers} Displays the total amount of players on all servers
{totalMaxPlayers} Displays the total amount of max players on all servers
{totalServers} Displays the total amount of servers

Servers

All options inside the servers config option.

Command Description
id The ID of the server, this is used to identify the server. duplicated ids will result it issues
name The name of the server, this will be displayed in the bot activity message
ip The IP of the server
queryPort The query port of the server
gameId The game ID of the server, you can find a list of all game IDs here
joinLink The join link of the server, keep empty if you don't want the join link to be displayed
info The info of the server, you can use this however you like. you can use it anywhere in the server fields.

CounterPanels

This section is located inside the counterPanels config option. More information about this module can be found here.

CounterChannels

This section is located inside the counterChannels config option. More information about this module can be found here.

CounterBots Options

This section is located inside the counterBots config option. More information about this module can be found here.

Cache File

:::warning Never edit the cache file yourself, this can cause issues with the bot! :::

The cache file is used to store data, you never have to edit this file yourself. editing this file can cause issues with the bot. If you want to reset the cache file, you can replace the current cache file with the default cache file you get when you download the bot.

:::info The bot stores server data to use while the server is offline, when the servers are back online the bot will update the data. also the panel messages are stored in the cache file. :::