Getting Started

This is the most standard configuration, consisting of token, secret, language, updating etc

Tokens

Tokens

Not entering the token, secret or guild id can result in crashes/immediate shutdown

These are values that are essential for the bot's functionality, they can not be missing/aren't optional

# The token of your bot application, create one here https://discord.com/developers/
token: ""
# The client secret of your bot, get it from here https://discord.com/developers/ under OAuth section
client_secret: ""
# Your server ID, you can get it by activating discord developer mode and right-clicking your server
guild_id: ""

Token

The discord bot token can be found on the discord developer portal after creating a new application. For a detailed guide on the creation of a discord app, look here. Search for it in the bot section.

Client Secret

The client secret can be found on the discord developer portal after creating a new application. For a detailed guide on the creation of a discord app, look here. Search for it in the OAuth section.

Guild Id

The guild id is the Id of your discord server. You can copy it after activating discords developer mode:

1. Head to the Settings

2. Go to the Advanced section

3. Activate "Developer Mode"

4. Right-Click your Server and click on copy guild id

Language

Language

Only languages which translation files are in the /ScpToolsBot/lang/ can be entered in the language field

The langage changes all text that is displayed by the bot to the users. Log messages are not affected from this.

# Which language should the bot use?
#Choose from these supported languages or duplicate one of the translation files and change it yourself
# available translations: ["en_US", "de_DE"]
load_translation: "en_US"

You can easily replace the en_US with any language that is avaidible. Avaidible languages are:

Languages

en_US - (US) English version of the bot

de_DE - (DE) German version of the bot

If you want to translate the bot into your own language or change something about the translation, look here:

Translation

Debug & Updates

Debug

The advanced debug option can spam your console, to make reading live logs, almost impossible. Only use it if you know what you are doing. Also note that advanced_debug can only be activated when debug is also activated.

These are the avaidible debug modes. They are supposed to be used for finding errors in the configurations or the bot itself.

# Activates debug logging, which gives you much more information on what the bot is doing.
debug: false
# ** Warning ** This feature is not recommended
#Displays all available information
advanced_debug: false

Debug

This shown so called DEBUG logs. They contain some additional information about the bot's processes and running tasks.

Advanced Debug

This shows so called TRACER logs. They contain all information about the bot's processes and running tasks.

Updates

This regulates which types of updates will be shown to users. Note that the update checker itself cannot be deactivated, just regulated.

# Settings for the update checker
updates:
  # Activate to ignore all versions that contain the beta tag
  ignore_beta: false
  # Activate to ignore all versions that contain the alpha tag
  ignore_alpha: true

Ignore Beta

All updates that have beta in their tag will be ignored by the update checker and not be shown in the console

Ignore Alpha

All updates that have alpha in their tag will be ignored by the update checker and not be shown in the console

Activity

Activity

The default activity displays PLAYING /help. The /help command can only be used by administrators, making this activity misleading in a way. Remove it to be sure prevent frustration.

# The activity type of the bot, choose from the available list: [COMPETING, CUSTOM_STATUS, LISTENING, PLAYING, WATCHING]
activity_type: "PLAYING"
# The text that is being displayed in the activity
activity_content: "/help"

Activity Type

The activity type, is the type of display that will be used, e.g. PLAYING. Avaidible activity types are:

COMPETING; CUSTOM_STATUS, LISTENING, PLAYING and WATCHING

Activity Content

Leaving this field empty, will result in a crash

The activity content is the text that will be displayed next to the activity type.