Configuration for server owners

The CommandAPI has a few configuration options to change how it functions. These options can be configured in the plugins/CommandAPI/config.yml file, which is generated automatically when the CommandAPI runs for the first time.

Configuration settings:

  • verbose-outputs - If true, outputs command registration and unregistration logs in the console

  • silent-logs - If true, turns off all logging from the CommandAPI, except for errors

  • missing-executor-implementation - Sets the text to display when a command is run by an executor which has not been implemented (for example, if a command can only be run by the console and a player tries to run the command).

  • create-dispatcher-json - If true, the CommandAPI creates a command_registration.json file showing the mapping of registered commands. This is designed to be used by developers - setting this to false will improve command registration performance

  • use-latest-nms-version - If true, the CommandAPI will always use the latest NMS implementation.

    Developer's Note:

    This can be used to run the CommandAPI on versions higher than it can support. For example, if the CommandAPI supports Minecraft 1.18 and Minecraft 1.18.1 comes out, you can use this to enable support for 1.18.1 before an official CommandAPI release comes out that supports 1.18.1. This feature is not guaranteed to work in every case, so beware!

  • plugins-to-convert - Controls the list of plugins to process for command conversion. See Command conversion for more information!

  • skip-sender-proxy - Determines whether the proxy sender should be skipped when converting a command. See Skipping proxy senders for more information!

  • other-commands-to-convert - A list of other commands to convert. This should be used for commands which are not declared in a plugin.yml file. See Arbitrary command conversion for more information

Default configuration file

The default config.yml is shown below:

################################################################################
# Logging                                                                      #
################################################################################

# Verbose outputs (default: false)
# If "true", outputs command registration and unregistration logs in the console
verbose-outputs: false

# Silent logs (default: false)
# If "true", turns off all logging from the CommandAPI, except for errors.
silent-logs: false

################################################################################
# Messages                                                                     #
################################################################################

# Messages
# Controls messages that the CommandAPI displays to players
messages:

  # Missing executor implementation (default: "This command has no implementations for %s")
  # The message to display to senders when a command has no executor. Available
  # parameters are:
  #   %s - the executor class (lowercase)
  #   %S - the executor class (normal case)
  missing-executor-implementation: "This command has no implementations for %s"

################################################################################
# Debugging                                                                    #
################################################################################

# Create dispatcher JSON (default: false)
# If "true", the CommandAPI creates a command_registration.json file showing the
# mapping of registered commands. This is designed to be used by developers -
# setting this to "false" will improve command registration performance.
create-dispatcher-json: false

# Use latest version (default: false)
# If "true", the CommandAPI will use the latest available NMS implementation
# when the CommandAPI is used. This avoids all checks to see if the latest NMS
# implementation is actually compatible with the current Minecraft version.
use-latest-nms-version: false

################################################################################
# Command conversion                                                           #
################################################################################

# Plugins to convert (default: [])
# Controls the list of plugins to process for command conversion.
plugins-to-convert: []

# Other commands to convert (default: [])
# A list of other commands to convert. This should be used for commands which
# are not declared in a plugin.yml file.
other-commands-to-convert: []

# Skip sender proxy (default: [])
# Determines whether the proxy sender should be skipped when converting a
# command. If you are having issues with plugin command conversion, add the
# plugin to this list.
skip-sender-proxy: []