mirror of
https://github.com/TotalFreedomMC/TF-EssentialsX.git
synced 2024-06-28 08:50:57 +00:00
Improve config.yml comments and structure (#3151)
This PR fixes some issues with the config.yml: * Adds links to the EssentialsX docs where appropriate * Moves a couple of settings into their correct locations * Changes headers to remove the weird implications of modularity (EssentialsHelp isn't a module, it's *one* command) * Updates support link at top * Minor grammar nitpicks
This commit is contained in:
md678685
GitHub
parent
307bd2a35f
commit
5082badca4
|
|
@ -4,6 +4,9 @@
|
|||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# This is the config file for EssentialsX.
|
||||
# This config was generated for version ${full.version}.
|
||||
|
||||
# If you want to use special characters in this document, such as accented letters, you MUST save the file as UTF-8, not ANSI.
|
||||
# If you receive an error when Essentials loads, ensure that:
|
||||
# - No tabs are present: YAML only allows spaces
|
||||
|
|
@ -11,11 +14,7 @@
|
|||
# - You have "escaped" all apostrophes in your text: If you want to write "don't", for example, write "don''t" instead (note the doubled apostrophe)
|
||||
# - Text with symbols is enclosed in single or double quotation marks
|
||||
|
||||
# If you have problems join the Essentials help support channel: http://tiny.cc/EssentialsChat
|
||||
|
||||
# Version ${full.version}
|
||||
|
||||
# KITS ARE NOW IN THE kits.yml FILE
|
||||
# If you need help, you can join the EssentialsX community: https://essentialsx.cf/community.html
|
||||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
|
|
@ -593,17 +592,20 @@ safe-usermap-names: true
|
|||
# Example: CommandBlock at <x>,<y>,<z> issued server command: /<command>
|
||||
log-command-block-commands: true
|
||||
|
||||
# Set the maximum speed for projectiles spawned with /fireball.
|
||||
max-projectile-speed: 8
|
||||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsHome | #
|
||||
# | Homes | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# Allows people to set their bed at daytime.
|
||||
# Allows people to set their bed during the day.
|
||||
update-bed-at-daytime: true
|
||||
|
||||
# Set to true to enable per-world permissions for using homes to teleport between worlds.
|
||||
# This applies to the /home only.
|
||||
# This applies to the /home command only.
|
||||
# Give someone permission to teleport to a world with essentials.worlds.<worldname>
|
||||
world-home-permissions: false
|
||||
|
||||
|
|
@ -629,23 +631,23 @@ sethome-multiple:
|
|||
# change the compass' direction to point towards their first home.
|
||||
compass-towards-home-perm: false
|
||||
|
||||
# Set the maximum speed for projectiles spawned with /fireball.
|
||||
max-projectile-speed: 8
|
||||
# If no home is set, would you like to send the player to spawn?
|
||||
# If set to false, players will not be teleported when they run /home without setting a home first.
|
||||
spawn-if-no-home: true
|
||||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsEco | #
|
||||
# | Economy | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# For more information, visit http://wiki.ess3.net/wiki/Essentials_Economy
|
||||
|
||||
# You can control the values of items that are sold to the server by using the /setworth command.
|
||||
|
||||
# Defines the balance with which new players begin. Defaults to 0.
|
||||
starting-balance: 0
|
||||
|
||||
# worth-# defines the value of an item when it is sold to the server via /sell.
|
||||
# These are now defined in worth.yml
|
||||
|
||||
# Defines the cost to use the given commands PER USE.
|
||||
# Some commands like /repair have sub-costs, check the wiki for more information.
|
||||
command-costs:
|
||||
|
|
@ -670,6 +672,10 @@ min-money: -10000
|
|||
# Enable this to log all interactions with trade/buy/sell signs and sell command.
|
||||
economy-log-enabled: false
|
||||
|
||||
# Enable this to also log all transactions from other plugins through Vault.
|
||||
# This can cause the economy log to fill up quickly so should only be enabled for testing purposes!
|
||||
economy-log-update-enabled: false
|
||||
|
||||
# Minimum acceptable amount to be used in /pay.
|
||||
minimum-pay-amount: 0.001
|
||||
|
||||
|
|
@ -688,7 +694,7 @@ minimum-pay-amount: 0.001
|
|||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsHelp | #
|
||||
# | Help | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
|
|
@ -703,25 +709,25 @@ hide-permissionless-help: true
|
|||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsChat | #
|
||||
# | EssentialsX Chat | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# This section requires the EssentialsChat.jar to work.
|
||||
# You need to install EssentialsX Chat for this section to work.
|
||||
# See https://essentialsx.cf/wiki/Module-Breakdown.html for more information.
|
||||
|
||||
chat:
|
||||
|
||||
# If EssentialsChat is installed, this will define how far a player's voice travels, in blocks. Set to 0 to make all chat global.
|
||||
# If EssentialsX Chat is installed, this will define how far a player's voice travels, in blocks. Set to 0 to make all chat global.
|
||||
# Note that users with the "essentials.chat.spy" permission will hear everything, regardless of this setting.
|
||||
# Users with essentials.chat.shout can override this by prefixing text with an exclamation mark (!)
|
||||
# Users with essentials.chat.question can override this by prefixing text with a question mark (?)
|
||||
# You can add command costs for shout/question by adding chat-shout and chat-question to the command costs section."
|
||||
# Users with essentials.chat.shout can override this by prefixing their message with an exclamation mark (!)
|
||||
# Users with essentials.chat.question can override this by prefixing their message with a question mark (?)
|
||||
# You can add command costs for shout/question by adding chat-shout and chat-question to the command costs section.
|
||||
radius: 0
|
||||
|
||||
# Chat formatting can be done in two ways, you can either define a standard format for all chat.
|
||||
# Or you can give a group specific chat format, to give some extra variation.
|
||||
# For more information of chat formatting, check out the wiki: http://wiki.ess3.net/wiki/Chat_Formatting
|
||||
# For EssentialsX changes, take a look at the EssentialsX wiki: https://github.com/EssentialsX/Essentials/wiki
|
||||
|
||||
format: '<{DISPLAYNAME}> {MESSAGE}'
|
||||
#format: '&7[{GROUP}]&r {DISPLAYNAME}&7:&r {MESSAGE}'
|
||||
|
|
@ -733,18 +739,22 @@ chat:
|
|||
|
||||
# If you are using group formats make sure to remove the '#' to allow the setting to be read.
|
||||
# Note: Group names are case-sensitive so you must match them up with your permission plugin.
|
||||
|
||||
# You can use permissions to control whether players can use formatting codes in their chat messages.
|
||||
# See https://essentialsx.cf/wiki/Color-Permissions.html for more information.
|
||||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsProtect | #
|
||||
# | EssentialsX Protect | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# This section requires the EssentialsProtect.jar to work.
|
||||
# You need to install EssentialsX Protect for this section to work.
|
||||
# See https://essentialsx.cf/wiki/Module-Breakdown.html for more information.
|
||||
|
||||
protect:
|
||||
|
||||
# General physics/behavior modifications.
|
||||
# General physics/behavior modifications. Set these to true to disable behaviours.
|
||||
prevent:
|
||||
lava-flow: false
|
||||
water-flow: false
|
||||
|
|
@ -796,7 +806,7 @@ protect:
|
|||
drowned: false
|
||||
# Prevent mooshrooms changing colour when struck by lightning.
|
||||
mooshroom: false
|
||||
# Prevent the spawning of creatures.
|
||||
# Prevent the spawning of creatures. If a creature is missing, you can add it following the format below.
|
||||
spawn:
|
||||
creeper: false
|
||||
skeleton: false
|
||||
|
|
@ -874,26 +884,24 @@ protect:
|
|||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | EssentialsAntiBuild | #
|
||||
# | EssentialsX AntiBuild | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# This section requires the EssentialsAntiBuild.jar to work.
|
||||
# You need to install EssentialsX AntiBuild for this section to work.
|
||||
# See https://essentialsx.cf/wiki/Module-Breakdown.html and http://wiki.ess3.net/wiki/AntiBuild for more information.
|
||||
|
||||
# Disable various default physics and behaviors
|
||||
# For more information, visit http://wiki.ess3.net/wiki/AntiBuild
|
||||
|
||||
# Should people with build: false in permissions be allowed to build?
|
||||
# Should people without the essentials.build permission be allowed to build?
|
||||
# Set true to disable building for those people.
|
||||
# Setting to false means EssentialsAntiBuild will never prevent you from building.
|
||||
build: true
|
||||
|
||||
# Should people with build: false in permissions be allowed to use items?
|
||||
# Should people without the essentials.build permission be allowed to use items?
|
||||
# Set true to disable using for those people.
|
||||
# Setting to false means EssentialsAntiBuild will never prevent you from using items.
|
||||
use: true
|
||||
|
||||
# Should we tell people they are not allowed to build?
|
||||
# Should we warn people when they are not allowed to build?
|
||||
warn-on-build-disallow: true
|
||||
|
||||
# For which block types would you like to be alerted?
|
||||
|
|
@ -922,11 +930,12 @@ protect:
|
|||
|
||||
############################################################
|
||||
# +------------------------------------------------------+ #
|
||||
# | Essentials Spawn / New Players | #
|
||||
# | EssentialsX Spawn + New Players | #
|
||||
# +------------------------------------------------------+ #
|
||||
############################################################
|
||||
|
||||
# This section requires essentialsspawn.jar to work.
|
||||
# You need to install EssentialsX Spawn for this section to work.
|
||||
# See https://essentialsx.cf/wiki/Module-Breakdown.html for more information.
|
||||
|
||||
newbies:
|
||||
# Should we announce to the server when someone logs in for the first time?
|
||||
|
|
@ -959,9 +968,6 @@ spawn-join-listener-priority: high
|
|||
# When users die, should they respawn at their first home or bed, instead of the spawnpoint?
|
||||
respawn-at-home: false
|
||||
|
||||
# If no home is set, would you like to send the player to spawn? (Only applies to /home)
|
||||
spawn-if-no-home: true
|
||||
|
||||
# Teleport all joining players to the spawnpoint
|
||||
spawn-on-join: false
|
||||
# The following value of `guests` states that all players in group `guests` will be teleported to spawn when joining.
|
||||
|
|
|
|||
Loading…
Reference in a new issue