Configuration Guide

IMPORTANT: This guide is for a future 2.0 version of CommandBlockerUltimate and does not apply in the current release version. Do not attempt to use this format with any version less than 2.0!

General

CommandBlockerUltimate uses the YAML format for its configuration, which is pretty standard among Spigot and Bungee plugins. If you need a reminder on the basics of the format, see TODO. (For now: this)

On both platforms, the configuration file is located at config.yml in the plugin folder. (Usually plugins/CommandBlockerUltimate/)

Please save the file with UTF-8 encoding. Do not attempt to edit it with a full word processor like Microsoft Word or LibreOffice Writer, but instead use a plain text editor such as notepad.exe, vim, nano or Notepad++ (recommended for Windows users). Do never place a tab character in the file, only ever use two spaces for indentation.

It is strongly recommended to check the whole file using a YAML Checker such as https://yaml-online-parser.appspot.com/ to make sure its syntax is correct before using it with CommandBlockerUltimate. Invalid syntax may cause loss of configuration and will force the plugin to fall back to the defaults. It is recommended to always reload the configuration using /cbu reloadcfg or /gcbu reloadcfg, respectively, because that allows you to notice and correct errors before the configuration is used.

It is further recommended to install Yamler along with CBU because that allows much more flexibility regarding configuration. If you don't install it, your configuration won't have new options as they are added in new updates.

You may inspect the default configuration here.

Actions

The config starts with defining what to do by default if a command is blocked. You'll define which commands are blocked later, and it's also possible to use a different action for some commands.