Launch Configuration

The launch configuration defines the order in which processed are started and if they are started at all.

Launch Options

The launch options contain general settings for the launch order.

"launch_options": {
  "ignore_broken_entries": false
},

Ignore Broken Entries

A broken launch configuration is not good. You should delete it and let it be regenerated before you start the bot again

Defines if entries that are missing from the config, or configured incorrectly should be ignored on startup. If this option is set to false, the bot will notify the user of the broken entry or sometimes crash to prevent further errors.

Launch Order

This is only an example for the main bot startup, you can find the whole configuration in /SCPToolsBot/configs/extra/launch-configuration.json

The launch order is a list that defines in which order the bot's features/processes are started (top to bottom). It also defines if a process will be started/or the processes sections to be started.

"launch_order": [
    {
      "id": "",
      "engage": true,
      "sections": [
        {
          "id": "",
          "engage": true,
          "logAction": true
        }
      ]
    }
]

The id of the process, all available Id's are:

main:BOT, main:STATUS_CLUSTER, main:COMMAND_MANAGER, main:COMMAND_LISTENER, main:STATUS_COMMAND_LISTENER, main:BUTTON_LISTENER, main:ENTITY_SELECT_LISTENER, main:MODAL_LISTENER, main:STRING_SELECT_LISTENER, main:NOTICE_OF_DEPARTURE_CHECKER, main:REGULARS_CHECKER

Engage

Determines if the process should be engaged

Sections

Id - Section Id's

Engage - Defines if the section should be engaged

Log Action - Defines if the action should be logged in the console

Section Id's

Main Id

Section Id

main:COMMAND_LISTENER

section:HELP_COMMAND, section:TEMPLATE_COMMAND, section:VERIFY_COMMAND, section:NOTICE_OF_DEPARTURE_COMMAND, section:REGULARS_COMMAND, section:PLAYER_COMMAND, section:SETTINGS_COMMAND, section:APPLICATION_COMMAND

main:STATUS_COMMAND_LISTENER

section:STATUS_COMMAND, section:STATUS_PLAYERLIST_COMMAND, section:STATUS_TEMPLATE_COMMAND

main:BUTTON_LISTENER

section:HELP_BUTTONS, section:TICKET_BUTTONS, section:APPLICATION_BUTTONS, section:VERIFY_BUTTONS, section:NOTICE_OF_DEPARTURE_BUTTONS, section:REGULARS_BUTTONS

main:ENTITY_SELECT_MENU

section:TICKET_ENTITY_SELECT_MENUS

main:MODAL_LISTENER

section:TICKET_MODALS, section:APPLICATION_MODALS, section:NOTICE_OF_DEPARTURE_MODALS

main:STRING_SELECT_LISTENER

section:TICKET_STRING_SELECT_MENUS, section:APPLICATION_STRING_SELECT_MENUS, section:REGULARS_STRING_SELECT_MENU

PreviousCommands NextGetting Started

Last updated 5 months ago