Improve config comments & ordering #6108
Conversation
This makes a bit more logical sense in the ordering
This adds slightly more logical ordering to the sign list, keeping them in related groups while sorting them alphabetically. Full alphabetical feels a bit messy, but could still be a valid option.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the configuration file comments for EssentialsX, enhancing clarity, consistency, and punctuation across several resource files.
- Enhanced phrasing and punctuation in kit configuration.
- Standardized comment styles in custom item, worth, and teleport configurations.
- Updated URLs and command syntax for clarity.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Essentials/src/main/resources/kits.yml | Improved comment phrasing and ordering |
| Essentials/src/main/resources/custom_items.yml | Updated comment clarity on alias limitations |
| Essentials/src/main/resources/worth.yml | Refined wording of worth configuration comments |
| Essentials/src/main/resources/tpr.yml | Clarified command syntax in the teleport config |
|
|
||
| # Items not listed in this file will not be sellable on the server | ||
| # Setting the worth to 0 will sell items for free, delete the item or set to -1 to disable. | ||
| # Determines the value of items on the server. |
There was a problem hiding this comment.
This file could do with updating to only use 1.13+ names. Pre-flattening examples could be limited to a comment?
There was a problem hiding this comment.
Good idea, I'd have to learn how the file actually works first though 😂
| change-displayname: true | ||
|
|
||
| # This option will cause Essentials to show players' displaynames instead of usernames when tab completing Essentials commands. | ||
| # This option will cause Essentials to show players' display names instead of usernames when tab completing Essentials commands. |
There was a problem hiding this comment.
I'd be tempted to remove this option - it breaks things more often than it's useful. (I think this used to tab complete nicknames without prefixes/suffixes, but now includes those - so maybe that's a separate bug?)
| spawnmob-limit: 10 | ||
|
|
||
| # Shall we notify users when using /lightning? | ||
| # Shall Essentials notify smitten players when /lightning is used? |
There was a problem hiding this comment.
| # Shall Essentials notify smitten players when /lightning is used? | |
| # Should Essentials notify smitten players when /lightning is used? |
| # Commands in this list, will tell Essentials to 'not give up' the command to other plugins. | ||
| # In this state, which plugin 'wins' appears to be almost random. | ||
| # When a command conflicts with another plugin, Essentials will, by default, try to force the OTHER plugin to take priority. | ||
| # Commands in this list will tell Essentials not to "give up" the command to other plugins. |
There was a problem hiding this comment.
| # Commands in this list will tell Essentials not to "give up" the command to other plugins. | |
| # Adding commands to this list will tell Essentials not to "give up" the command to other plugins. |
| # Essentials' colored sign support will be enabled when any sign type is enabled. | ||
| # 'color' is not an actual sign type; it enables using color codes on signs when the correct permissions are given. |
There was a problem hiding this comment.
| # Essentials' colored sign support will be enabled when any sign type is enabled. | |
| # 'color' is not an actual sign type; it enables using color codes on signs when the correct permissions are given. | |
| # 'color' is not an actual sign type; it enables using color codes on signs when the correct permissions are given. | |
| # Essentials' colored sign support can only be enabled when any other sign type is enabled. |
I'm not sure if this order makes it clearer, or if it'd be better the original way around?
| # Don't forget to remove the # in front of the line. | ||
| # For more information, visit https://essentialsx.net/wiki/Locale.html | ||
| #locale: en | ||
|
|
||
| # Should EssentialsX use player's language instead of the server's when sending messages? | ||
| # Should Essentials use player's language instead of the server's when sending messages? |
There was a problem hiding this comment.
| # Should Essentials use player's language instead of the server's when sending messages? | |
| # Should Essentials use the player's language instead of the server's when sending messages? |
| sleep-ignores-vanished-player: true | ||
|
|
||
| # Set the player's list name when they are AFK. This is none by default which specifies that Essentials | ||
| # Change the player's list (not tab) name when they are AFK. This is none by default, which specifies that Essentials |
There was a problem hiding this comment.
Unclear what "not tab" is referring to - tab completion or tab list?
| # Give someone permission to teleport to a world with essentials.worlds.<worldname> | ||
| # This does not affect the /home command, there is a separate toggle below for this. | ||
| # Set to true to enable per-world permissions for teleporting between worlds with Essentials commands. | ||
| # This applies to /world, /back, /tp[a|o|here|all] but not warps. |
There was a problem hiding this comment.
The previous version of this line was probably slightly more accurate :p
| # 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. | ||
| # If Essentials Chat is installed, this sets how many blocks a player's chat will travel. Set to 0 for global chat. |
There was a problem hiding this comment.
I'd prefer to keep the EssentialsX name in any references to module names, to prevent someone looking for module jars from upstream.
(I'm a little mixed on removing the EssentialsX branding in general, but that's probably a separate discussion)
| # You can specify a format for each group. | ||
| # You can also specify a format for each group. | ||
| # If using group formats, remove the # to activate the setting. | ||
| # Note: Group names are case-sensitive, so you must match them up with your permissions plugin. |
There was a problem hiding this comment.
Possibly worth a note on LuckPerms group aliases - aliases change the Vault group name
This PR significantly overhauls the comments of the EssentialsX configuration files, ensuring consistency, clarity, and overall improved grammar (validated by Grammarly and LLMs). There are still a few things that must be completed before this is ready to be merged, but no further significant changes are expected. A couple of options have been moved entirely to make more logical sense, but this will not affect any compatibility.
Remaining tasks:
Separate commit: Add 'default' comment to every option(decided this is unnecessary and instead added a link to the default config)