Features

These are features that need some configuration before being used.

Verify

Webserver must be active for verify to work

This feature let's users connect their steam and discord to cache correct data from e.g. the CedMod api

# ** WARNING ** For this setting to work, you need to activate the webserver.
# The webserver is generally just a redirect to receive data from the discord OAuth Api, so it
# should not interrupt any other web stuff running on your server.
verify:
  # Activates the verify feature, make sure you have configured webserver accordingly
  active: false
  # This link can be obtained from the oauth section on the discord developer portal. First, enter the redirect you entered in the webserver section exactly
  # as described here: <uri>:<port><redirect_uri>, e.g. http://localhost:80/auth/discord/redirect. After entering the redirect, click on save to proceed with the
  # setup. You now have to scroll down to the 'OAuth2 URL Generator' where you need to click on 2 options, 'identify' and 'connections', after that scroll down
  # and select your redirect for the redirect url. Now you can copy the generated url into your clipboard. Paste it in here.
  oauth_link: ""
  # Which channel should verify logs be sent to?
  verify_log_channel: ""

Active

Determines if the verify feature is active

OAuth Link

This is the link users will be prompted to click when verifying. To activate OAuth for your application, head to the discord developer portal. Head to the OAuth section and follow these steps:

Enter the redirect you entered on webserver setup.
Click on identify and connections
Select your redirect link and generate a OAuth link

Verify Log Channel

The id of the channel you want to send verify logs to.

Notice of Departure

This feature let's staff members define a time period in which they are not available. This period will be regularly checked and admin's will be notified if the time runs out.

notice_of_departure:
  # Activates the notice of departure feature
  active: false
  # The formatting that is used to format the notice of departure dates
  date_formatting: "dd.MM.yyyy"
  # Which channel should the form be sent to, to be accepted by moderators?
  decision_channel_id: ""
  # Which channel should the notice messages be sent to?
  notice_channel_id: ""
  # List of role's that are able to accept/dismiss/revoke notices (INPUT ID'S ONLY)
  roles_access_notices: []
  # Put the following in the type: [NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS]
  check_type: "HOURS"
  # The rate at that the notices are checked.
  check_rate: 1

Active

Determines if notice of departures is active

Date Formatting

Always include dd, MM and yyyy in your custom formatter e.g. dd-MM-yyyy, dd/MM/yyyy or dd,MM,yyyy

Define a custom formatter for dates.

Decision Channel

The id of the channel that the message for regular decision will be sent to. This decision message can only be accessed by users who permitted to. If decision is accepted or denied a message will be sent to the sender, notifying them of the decision

Notice Channel

The id of the channel that the accepted notices will be sent to. These notice messages contain a button for revoking the notice if needed.

Roles Access Notices

An array of roles who should be able permitted to accept/deny/revoke notices.

Check Type

The type of time-format the checker should follow. Available formats are:

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

Check Rate

The rate at which notices should be checked/validated

Regulars

Regulars needs extra configuration, check out the regular page to learn more. Webserver, Verify and CedMod or XP integration must be activated for regulars to function.

regulars:
  # Activates regulars, make sure you have correctly configured the regular's configs, as well as activated the necessary compatibility settings
  active: false
  # Should example configuration be created (deactivate if you want to delete the example config)
  create_example_configuration: true
  # Should the bot only load from the specified folder within the /regulars/ folder?
  only_load_certain_folder: false
  # Specify which folders should be specified if the option above is active
  only_load_folders: []

Active

Determines if regulars is active

Create Example Configuration

If active, an example configuration directory is created under /SCPToolsBot/regulars/ . Deactivate this after you know how to configure regulars correctly

Only Load Certain Folders

Determines if only certain folders should be loaded

Only Load Folders

only works if only_load_certain_folder is active

An array consisting of the folders that should be loaded

Active

Determines if notice of departures is active

PreviousIntegration NextStatus Bots

Last updated 8 months ago

hashtagVerify

hashtagNotice of Departure

hashtagRegulars

Verify

Notice of Departure

Regulars