Status Bots

The Status Bots are multiple bot instances that receive information about your scp:sl servers and display it accordingly.

Getting Started

Getting Started

The status bots general settings.

# Determines if the bot(s) are active or not
active: false

# Your servers api key. You can get it from the console by typing < !api show >
api: ""
# Can be obtained by typing < !id > into your console
account_id: ""

# ** WARNING ** Turning off messes with template playerlists
# Turn this of if you don't want playerlists to be periodically updated
check_playerlist: true

# Should the server status be posted to a specified channel?
post_server_status: false
# The channel that the server status is going to be posted to
post_channel : ""
# Status page url, change this if you have a custom server status page set up, if not leave it as is
page_url: "https://status.scpslgame.com/"

Active

Determines if Status Bots are active

Api

You can only obtain an api key when your server is verified.

The api key of your server (scp:sl). You can obtain it by running !api show in your server console. If you are not receiving a key, type !api reset and then again !api show

Account Id

You can only obtain an account id when your server is verified.

The account id of your server (scp:sl). You can obtain it by running !id in your server console

Check Playerlist

Determines if playerlist's that have been created with the /template command be regularly checked and updated

Post Server Status

Determines if the current server status (online/offline/unreachable) should be posted to a channel.

Post Channel

Only works if post_server_status is active

The id of the channel which server status messages will be posted in

Page Url

If you have a custom status page set up, you can reset this link with it

Rates

Rates

The check/retry/idle rates of the status bots.

# ** WARNING ** If this value is under 10, the api will rate limit all requests
# The rate at which the bot request updated information from the api
check_rate: 10
# If the retrieval of information fails, the bot wil retry for how many times you entered here
retry_to_fetch_data: 5
# When the bot fails to retrieve information, it will suspect a rate limit until passing the
# number you entered here
suspect_rate_limit_until: 2
# The time after the bot idles (it will automatically change to a higher check cooldown)
idle_after: 60
# The rate at which the bot checks for new information when it idles
idle_check_rate: 30

Check Rate

The rate (in seconds) at which the bot tries getting new information from the secret lab api. This rate will be applied to all instances

Retry to Fetch Data

How many times the bot retries after marking the api as unreachable

Suspect Rate Limit Until

How many retries the bot considers as rate limited requests

Idle After

The time the bot waits after not receiving any new data before idling

Idle Check Rate

The rate at which the bot requests new information from the secret lab api when idling

Instances

Instances

The different bot instances each provide data about a single server.

# The bot instances you want to create are entered here. To create a second one, copy over the already
# existing element and paste it underneath the other one (separate with comma)
instances: [
  {
    # The token for the bot you want to be the status bot
    token: "",
    # The name of the server the bot represents (can be anything you like)
    name: "",
    # The port of the server that this bot represents (e.g., 7777 as the default port)
    server_port: 0,
    # How many times should the bot retry to fetch data for this specific server until
    # declaring it as offline or unavailable
    retries: 4,
    playerlist: {
      # Activates the bots automatic playerlist placement
      active: false,
      # The channels the playerlist should be sent to and updated
      channel_ids: []
    }
  },
]

Instances

The list of instances objects, they will be loaded from top to bottom

Token

The token of the bot instance

Name

The name that will be displayed to users

Server Port

The port of the server, data is being queried from

Retries

How often the bot retries after marking the server as offline/unreachable

Playerlist

Active - Determines if a persistent playerlist should be created

Channel Ids - The id's of the channels the playerlist will be sent to