GitHubOverride

Getting Started

First you need to install the bot onto your system. Installation on Linux servers is advised, but installing the bot on Windows and MacOS is still possible through Docker or the raw Jar.

Installation Methods

These are all currently available installation methods for ScpTools.

Installer (Linux)

The installer is the recommended way to install the bot. It is easy to use and allows for easy setup using the onboard configurator. It's only downside is the Linux exclusivity.

Installer

Fist Time Setup

If you used the installer script and configured it with the build in configurator you can skip this

When first installing the bot you need to tweak some settings to get it working. This small guide will help you to find them and eliminate issues.

1. Mandatory Settings

On first startup you have probably experienced the bot crashing with an error. That is because you need to enter in three important id's for it to start up. These are the token, client secret and guild id. They can be found in the config.yml just at the top.

# 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: ""

You can get 2 of these values from the official Discord Developer Portal. Create a bot application and then navigate to the OAuth and Bot sections. There you can find the buttons for resetting the applications client secret and token. Reset them, copy them and at last paste them into the config.

Client Secret Reset Button
Token Reset Button

The last value, meaning your guild id is just your discord server id. You can easily retrieve it by activating developer mode in the settings (Settings --> Advanced --> Developer Mode) and then right-clicking on your server.

Learn more about configuring on the Configuration Page

2. Language

If you don't like the standard English version of the bot, you can switch to the German version or copy the translation files (located in the lang folder) and change them to your liking.

# 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"

Learn more on this topic on the Translation Page

3. Feature Settings

For some features you need to tweak the configs. Generally it is good to look into the config and search for the section containing the feature to look what they need.

The status bots and support system have their own separate configs, located in the same folder as the config.yml

Learn more about this topic on the Feature Page

4. Webserver and CedMod

If you have CedMod installed on your server you might want to use the integrated CedMod link in SCPTools. There's also a small Webserver implemented that can handle discord OAuth request.

CedMod

If you want to activate CedMod, navigate to the CedMod section of the config and change active to true. You will need your instance URL as well as an API key. This API key can only be obtained when asking CedMod staff directly, so head to their discords support channel and request it.

cedmod:
  # This activates the CedMod Api integration. This feature is only used for the following functions, only activate if you have these features in use: Regulars
  # CedMod Api is only available to users who request access from the CedMod team, ask on their discord for more information - https://discord.gg/p69SGfwxxm
  active: false
  # Include https://
  instance_url: ""
  # Put the plain API key here
  api_key: ""

Learn more about this topic on the Integration Page

Webserver

The Webserver is a special feature that must be active for the verify and regulars feature. It handles Discord OAuth requests to link users steam and discord accounts. Follow the instructions in the config to activate it and make sure you configure your firewall correctly to filter requests.

webserver:
  # Should the webserver be launched? This feature is only used for regulars
  active: false
  # The port under which the webserver will be launched
  port: 8080
  # What uri to start the webserver under
  redirect_uri: "/auth/discord/redirect"
  # Where should the redirect be, include the full url e.g., https://localhost:80/auth/discord/redirect
  uri: ""

Learn more about this topic on the Webserver Page

PreviousSCPToolsBotNextInstaller

Last updated