Here is an overview of each YAML file, this should give you the need-to-know about the options in each file.
If you feel like something is missing and needs to be added or clarified please Direct Message me and I will add it.
If you are looking for features that have to do with hooking plugins into SignUtils they have been moved,
click here; https://www.spigotmc.org/wiki/signutils-api-hooks
This is a quick overview of the;
Default Config.yml Configuration
- This should never be touched, modifying this will cause the config.yml file to break and regenerate.
- This identifies the language that the plugin will use as well as the lang file that it will generate.
- Current English is the only language currently supported, however, editing the en-lang.yml can allow you to modify the English language to what you prefer.
General: # These are typically general maintenance settings that do not affect functionality.
- Setting this to false will stop the plugin from checking for updates and notifying you if an update has been found upon starting the server, or reloading the server.
- This should always be kept true, this simply allows the plugin to anonymously send data of your server version, most used dependencies, java version, etc. A way to think of this is it being a statistics page. If you wish to not be included set this to false. This tool will be really useful in allowing me to increase the quality of the the plugin updates as well as supported Minecraft Versions.
- You can see the plugins stats page here; https://bstats.org/plugin/bukkit/SignUtils
- Setting this to false will simply make all text output from the plugin into console be in simple black and white, rather than the magical colors I have chosen.
Debugging: falsePermissions: # These permissions if enabled, determine whether the permission(s) is/are applied to certain players.
- Setting this to true may help identify a bug you found when reporting it to the developer, it creates more detailed logs and outputs in the console window for debugging later on.
- It is recommended to keep this false unless you are experiencing issues with the plugin and need help.
Commands-OP: falsesoftDepend: # These are optional dependencies, only enable these if you want to use them.
- Setting this to true will require ops to have each commands permissions or signutils.all or signutils.* in order to use each command. Ops will not get each command by default if this is set to true.
- signutils.(reload, updates, autoupdate, create, rank, rank.others) are no longer given to Opped players by default, you will now have to set Commands-OP in the config.yml to false to allow ops to get these commands by default (however this is the default selected setting, setting it to true will require ops to be given these permissions).
- Keeping this false will allow ops to execute the following commands by default, without permissions.
- signutils.(reload, updates, autoupdate, create, rank, rank.others).
- If you have BetterNick already on your server it is recommended to set this to true.
- This allows the plugin to easily find your original player name and UUID if you are nicknamed using BetterNick.
- If you have PlaceholderAPI already on your server it is recommended to set this to true.
- You can use all of these placeholders on ANY part of the plugin, and all parts of the plugin are hooked into PlaceholderAPI. This will allow the usage of every single PlaceholderAPI placeholder that you wish to use in any aspect of the plugin, including language messages.
- Example placeholder such as; %player_name%.
- If you have Vault already on your server it is recommended to set this to true.
- You can hook into Vault into the plugin which will utilize its properties for utility signs such as the rank utility which checks the player's involved group(s). Without this plugin being enabled and installed the plugin will disable the rank command and prevent the use and creation of any created signs utilizing the rank sign syntax.
This is a quick overview of the;
Default En-Lang.yml Configuration
Notes: If you don't want a message to be sent, fully remove it from below or make it blank. The information below will be listed without any message text so you can be shown exactly what each identifier means.
- This should never be touched, modifying this will cause the en-lang.yml file to break and regenerate.
Commands: # These messages are specific to the plugin commands.
- This is the prefix that will be sent at the beginning of every single message sent in the language file.
Default: # These are general messages sent from various command actions.
- This is the message sent when the executing user did not sent a proper plugin command, meaning the command does not exist.
- This is the message sent when the plugin configuration files are successfully reloaded.
- This is the message sent when the executing user is lacking the proper permissions for the plugin command.
- This is the message that is sent when the executor is not a player, which means this command is not available for the console window.
- This is the message sent when the %targetplayer% does not exist or was misspelt.
Updates: # These messages are sent in relation to the /signutils updates command.
- This is the message sent to the console window to log the %player% that requested to check for plugin updates.
- This is the message sent to the console window to log the %player% that requested to force update the plugin.
Signs: # These messages are specific to the plugins utility signs.
Default: # These are general messages sent when performing certain actions with utility signs.
- This message is sent when the player successfully creates a utility sign.
- This is the message sent when the user creating a sign is lacking the proper permissions for the utility sign.
- This is a message sent when the user is attempting to create a utility sign that is not enabled because it is lacking the %dependency%.
Rank: # These are messages specific to the Rank utility sign.
- This is the first line of text entered on a sign which lets SignUtils to know that you are attempting to create a Rank utility sign.
- Changing this means you will have to enter this line of text (Excluding Color Codes) on the first line of the sign to begin creating a utility sign.
- This is the first message sent when the player interacts with the Rank utility sign.
- Lets the executor know the exact player name of the displayed group(s).
- This is the second message sent when the player interacts with the Rank utility sign.
- Lets the player know the number of group(s) they are involved in.
- This is the third message sent when the player interacts with the Rank utility sign.
- Lets the player know the exact group(s) they are involved in.