Commands

There are two arrays of commands, commands and status_commands. You can find all commands in ./SCPToolsBot/configs/extra/commands.json

All commands that the bot can execute are defined in this global config. They can be changed to whatever the user likes, as long as the id's stay the same. This config also allows for the creation of entirely new commands.

{
  "commands": [
    {
      "active": true,
      "inherit": "",
      "name": "",
      "description": "",
      "default_permissions": [],
      "options": [
        {
          "type": "",
          "name": "",
          "description": "",
          "isRequired": true,
          "choices": [
            {
              "name": "",
              "id": ""
            }
          ]
        }
      ],
      "subcommands": [
        {
          "inherit": "",
          "name": "",
          "description": "",
          "options": [
            {
              "inherit": "",
              "name": "",
              "description": "",
              "options": [
                {
                  "type": "",
                  "name": "",
                  "description": "",
                  "isRequired": true
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Active

Determines if the command is active

Inherit

The inheritance is an id that tells the bot which inner functions to run when it receives a command. This is determined by loading the inheritance id every time a command is executed and searching for the function that it should execute. Available inheritance id's are:

commands.help.default, commands.template.default, commands.verify.default, commands.notice_of_departure.default, commands.regulars.default, commands.settings.default, commands.application.default, status_commands.status.default, status_commands.playerlist.default, status_commands.template.default

Name

Commands can be lowercase only

The name of the command that will be displayed to users

Description

The description can not be empty

The description of the command that will be shown to users

Default permissions

The permissions that are needed to run the command. Available permissions can be found in this javadocs

Options

Type - The type of the option. Available types can be found in this javadoc

Name - The name of the option that will be shown to users

Description - The description of the option that will be shown to users

Is Required - Defines if the option is required to run the command

Choices - Choices

Choices

Name - The name of the choice that will be shown to users

Id - The id of the choice

Subcommands

Currently no subcommands are implemented

Inherit - The inheritance id of the subcommand.

Name - The name of the subcommand that will be shown to users

Description - The description of the subcommand that will be shown to users

Options - Options