Configuration

Configuration

This is a list of all available configuration options that you can find in the config.yml file in your CommandsEX directory. Some of these options can be updated directly in-game using the /cex command.

• to retrieve a list of in-game configurable (and retrievable) options, type /cex config into chat
• to get a value of an option, type /cex config get <option></option>, or a shortcut /cex cg <option></option>
• to set a value of an option, type /cex config set <option> (add/remove) [value]</option>, or use short version of /cex cs <option> ...</option>
• syntax for each of the options is provided below for your reference

---

debugMode

• Description: If enabled and an error occures, you will see additional information about this error in your console. It is good idea to turn debug mode on when reporting issues with the plugin.
• Default value: false
• Get Usage: /cex config get debugMode
• Alternative Get Usage: /cex cg debugMode
• Set Usage: /cex config set debugMode
• Alternative Set Usage: /cex cs debugMode

---

defaultLang

• Description: Default language to be used when displaying informative and warning messages to users. Each user has also an option to set their own preferred language, if given permission.
• Default value: en
• Note: you will only be able to choose a language that is listed in the availableLangs option's list, explained below
• Get Usage: /cex config get defaultLang
• Alternative Get Usage: /cex cg defaultLang
• Set Usage: /cex config set defaultLang \<language-code>
• Alternative Set Usage: /cex cs defaultLang \<language-code>

---

availableLangs

• Description: List of available languages for the plugin. This list must contain values that correspond to language files located in your CommandsEX folder in the plugins directory. Language files have an extension of .properties and their file names always begin with lang_ prefix and continue with the language code. This language code can be used in the availableLangs list.
• Default value: [en]
• Note 1: if you try to translate a language file, please DO NOT change format of the file to UTF-8, since it will become unreadable by Minecraft. Minecraft itself does not support all international characters, therefore you would have to substitute some special characters for their ASCII counterparts (for example ž for z).
• Note 2: This option cannot be set from the console and can only be changed in the config file itself.

---

disableVersion

• Description: If enabled, players won't see CommandsEX version information when they type /cex into chat.
• Default value: false
• Get Usage: /cex config get disableVersion
• Alternative Get Usage: /cex cg disableVersion
• Set Usage: /cex config set disableVersion
• Alternative Set Usage: /cex cs disableVersion

---

enableDatabase

• Description: This block of options is used to set up storage options. CommandsEX uses sqlite as its default data storage engine, which means you don't need to edit any of these options and everything should work just fine. If, however you don't have sqlite driver installed or want to use MySQL instead, you will need to change these options to suit your needs.
• Note: These options cannot be set from the console and can only be changed in the config file itself.
• Options:
  • enableDatabase: if true, data storage will be enabled. Setting this to false will cause some of the commands and events not to work properly (for example, people will only be able to set homes temporarily until the server restarts). Default value: true
  • sqlType: can be either sqlite or mysql. Default value: sqlite
  • database: name of the database to use, for sqlite this is the name of DB file that will be created in your CommandsEX folder in plugins directory. Default value: minecraft
  • host: host to connect to, in 99% cases it can be left set to localhost - only used for MySQL connections. Default value: localhost
  • port: port to connect to, in 99% cases it can be left set to 3306 - only used for MySQL connections. Default value: 3306
  • name: username for the MySQL connection, this option is ignored when using sqlite. Default value: root
  • password: password for the MySQL connection, this option is ignored when using sqlite. Default value: ""
  • prefix: prefix for tables that CommandsEX needs to create in your database. Default value: cex_

---

logCommands

• Description: If enabled, each command typed by a player will be shown in the console. Normally, only chat is being outputted into console.
• Default value: true
• Get Usage: /cex config get logCommands
• Alternative Get Usage: /cex cg logCommands
• Set Usage: /cex config set logCommands
• Alternative Set Usage: /cex cs logCommands

---

chatReplaceFile

• Description: This is a name of the file which will hold replacements for chat messages. For more information, see [Chat Text Replacements].
• Default value: playerchat.txt
• Note: This option cannot be set from the console and can only be changed in the config file itself.

---

playerCommandsReplaceFile

• Description: This is a name of the file which will hold replacements for player commands. For more information, see [Custom Player Commands].
• Default value: playercmd.txt
• Note: This option cannot be set from the console and can only be changed in the config file itself.

---

consoleCommandsReplaceFile

• Description: This is a name of the file which will hold replacements for console commands. For more information, see [Custom Console Commands].
• Default value: consolecmd.txt
• Note: This option cannot be set from the console and can only be changed in the config file itself.

---

tpaTimeout

• Description: This option sets the amount of time (in seconds) after which a /tpa requests expire. For more information on the /tpa command, see [Teleportation]
• Default value: 50
• Get Usage: /cex config get tpaTimeout
• Alternative Get Usage: /cex cg tpaTimeout
• Set Usage: /cex config set tpaTimeout \<seconds>
• Alternative Set Usage: /cex cs tpaTimeout \<seconds>

---

tpahereTimeout

• Description: This option sets the amount of time (in seconds) after which a /tpahere requests expire. For more information on the /tpahere command, see [Teleportation]
• Default value: 50
• Get Usage: /cex config get tpahereTimeout
• Alternative Get Usage: /cex cg tpahereTimeout
• Set Usage: /cex config set tpahereTimeout \<seconds>
• Alternative Set Usage: /cex cs tpahereTimeout \<seconds>

---

homeQualifyTime

• Description: This option sets required time (in seconds) for a player to be on the server before he's allowed to set and use their home location using /sethome (or /home set) command. For more information on the /sethome and /home set commands, see [Homes Management]
• Default value: 43200 (12 hours)
• Get Usage: /cex config get homeQualifyTime
• Alternative Get Usage: /cex cg homeQualifyTime
• Set Usage: /cex config set homeQualifyTime \<seconds>
• Alternative Set Usage: /cex cs homeQualifyTime \<seconds>

---

allowMultiworldHomes

• Description: This option sets whether players are allowed to have separate home locations in each world. Setting this to false will set player's home in the world they actually reside when using the /sethome command. For more information on the /sethome command, see [Homes Management]
• Default value: true
• Get Usage: /cex config get allowMultiworldHomes
• Alternative Get Usage: /cex cg allowMultiworldHomes
• Set Usage: /cex config set allowMultiworldHomes
• Alternative Set Usage: /cex cs allowMultiworldHomes

---

silentKicks

• Description: Set this to false if you want everyone on the server see when a player gets kicked and the reason why this happened, otherwise set it to true.
• Default value: false
• Get Usage: /cex config get silentKicks
• Alternative Get Usage: /cex cg silentKicks
• Set Usage: /cex config set silentKicks
• Alternative Set Usage: /cex cs silentKicks

---

maxWarpsPerPlayer

• Description: Set this to maximum number of warps each player is allowed to create. If set to 0, no limit will be imposed - use wisely, it can fill your database quite quickly if you do so. To allow certain people or groups to create unlimited warp points with this limit set, give them cex.warp.bypasslimits permission.
• Default value: 10
• Get Usage: /cex config get maxWarpsPerPlayer
• Alternative Get Usage: /cex cg maxWarpsPerPlayer
• Set Usage: /cex config set maxWarpsPerPlayer \<max-warps>
• Alternative Set Usage: /cex cs maxWarpsPerPlayer \<max-warps>

---

maxIPholdTime

• Description: Number of seconds to keep player IPs internally. This is used when a player repeatedly joins the server, griefs (or spams) heavily and quit right away, so we have his IP stored and can ip-ban the guy even after he left.
• Default value: 120
• Get Usage: /cex config get maxIPholdTime
• Alternative Get Usage: /cex cg maxIPholdTime
• Set Usage: /cex config set maxIPholdTime \<max-time>
• Alternative Set Usage: /cex cs maxIPholdTime \<max-time>

---

minTempBansWarn

• Description: Number of bans for the player to have in history before the system will suggest to ban this player permanently.
• Default value: 5
• Get Usage: /cex config get minTempBansWarn
• Alternative Get Usage: /cex cg minTempBansWarn
• Set Usage: /cex config set minTempBansWarn \<min-bans>
• Alternative Set Usage: /cex cs minTempBansWarn \<min-bans>

---

silentBans

• Description: Set this to false if you want everyone on the server see when a player gets banned and the reason why this happened, otherwise set it to true.
• Default value: false
• Get Usage: /cex config get silentBans
• Alternative Get Usage: /cex cg silentBans
• Set Usage: /cex config set silentBans
• Alternative Set Usage: /cex cs silentBans

---

joinSilentTime

• Description: Number of seconds to be silent about join/leave messages and then show them all together.
• Default value: 25
• Get Usage: /cex config get joinSilentTime
• Alternative Get Usage: /cex cg joinSilentTime
• Set Usage: /cex config set joinSilentTime [seconds]
• Alternative Set Usage: /cex cs joinSilentTime [seconds]

---

jailArea

• Description: Area around jail location (in blocks) to be still considered a jail, so when people teleport there, they won't be stuck on each other.
• Default value: 5
• Get Usage: /cex config get jailArea
• Alternative Get Usage: /cex cg jailArea
• Set Usage: /cex config set jailArea \<blocks>
• Alternative Set Usage: /cex cs jailArea \<blocks>

---

kamikazeInstaKill

• Description: Set true to instantly kill a player who carries TNT block in the inventory and is caught on fire (or damaged from explosion). Set this to false to leave TNT explosion effect to take over instead and do predefined amount of damage.
• Default value: false
• Get Usage: /cex config get kamikazeInstaKill
• Alternative Get Usage: /cex cg kamikazeInstaKill
• Set Usage: /cex config set kamikazeInstaKill
• Alternative Set Usage: /cex cs kamikazeInstaKill

---

kamikazeTimeout

• Description: Time (in seconds) after which TNT will explode in player's inventory from the moment they catch fire (or are effected by an explosion).
• Default value: 3
• Get Usage: /cex config get kamikazeTimeout
• Alternative Get Usage: /cex cg kamikazeTimeout
• Set Usage: /cex config set kamikazeTimeout \<seconds>
• Alternative Set Usage: /cex cs kamikazeTimeout \<seconds>

---

timedPromoteTaskTime

• Description: Time (in seconds) after which the plugins should periodically check how much time players played on the server.
• Default value: 180
• Get Usage: /cex config get timedPromoteTaskTime
• Alternative Get Usage: /cex cg timedPromoteTaskTime
• Set Usage: /cex config set timedPromoteTaskTime \<seconds>
• Alternative Set Usage: /cex cs timedPromoteTaskTime \<seconds>
• Minimum value: 180

---

timedPromote

• Description: Configure how much time must a player play on the server before auto-promoted to each group.
• Note: This option cannot be set from the console and can only be changed in the config file itself.

Default value:

timedPromote:
    default: 0

---

timedPromoteExclude

• Description: Players in the following groups will be excluded from timed auto-promotions (admins, moderators, ...)
• Default value: [admin]
• Get Usage: /cex config get timedPromoteExclude
• Alternative Get Usage: /cex cg timedPromoteExclude
• Set Usage: /cex config set timedPromoteExclude (add/remove) \<group_name>
• Alternative Set Usage: /cex cs timedPromoteExclude (add/remove) \<group_name>

---

ecoPromoteTaskTime

• Description: Time (in seconds) after which the plugins should periodically check players' wealth and promote them based on these findings.
• Default value: 180
• Get Usage: /cex config get ecoPromoteTaskTime
• Alternative Get Usage: /cex cg ecoPromoteTaskTime
• Set Usage: /cex config set ecoPromoteTaskTime \<seconds>
• Alternative Set Usage: /cex cs ecoPromoteTaskTime \<seconds>

---

ecoPromote

• Description: Configure how much currency must a player have before auto-promoting him to each group.
• Note: This option cannot be set from the console and can only be changed in the config file itself.

Default value:

ecoPromote:
    default: 0

---

ecoPromoteExclude

• Description: Players in the following groups will be excluded from economy-based auto-promotions (admins, moderators, ...)
• Default value: [admin]
• Get Usage: /cex config get ecoPromoteExclude
• Alternative Get Usage: /cex cg ecoPromoteExclude
• Set Usage: /cex config set ecoPromoteExclude (add/remove) \<group_name>
• Alternative Set Usage: /cex cs ecoPromoteExclude (add/remove) \<group_name>

---

ecoPromoteAutoDemote

• Description: If this is true, players that drop below treshold of their own group will be removed from this group (i.e. demoted).
• Default value: true
• Get Usage: /cex config get ecoPromoteAutoDemote
• Alternative Get Usage: /cex cg ecoPromoteAutoDemote
• Set Usage: /cex config set ecoPromoteAutoDemote
• Alternative Set Usage: /cex cs ecoPromoteAutoDemote