![]() Command topics are created from the plugin's command descriptions in the file.Four different type of topics are created: The Bukkit help system automatically populates the internal help index with topics derived from the loaded plugins. Preview of Default Alias Topics Automatically Generated Help Topics The color code escape character is "&" followed by a Minecraft color or formatting code. Only general topics and index topics will remain.Įxample command-topics-in-master-index: true Text Color And FormattingĪll text fields in help.yml support Minecraft color codes. The automatically generated help topics will still be available to the /help command and can be included in custom index topics, but they will no longer be shown in the default help index. If you still want automatically generated help topics for plugin commands but do not want them filling up your default help index, set command-topics-in-master-index to false. Ignore "All" to completely disable automatic help topic generation. Ignore "Bukkit" to skip the standard Bukkit commands. Ignored plugin names must exactly match the plugin name as displayed in the /plugins command. The ignored plugins list is a list of plugins that the help system will skip when generating automatic help topics. ShortText: Stops the server cold.in its tracks! permission: (string) A new permission node to apply to the topic.fullText: (string) The new full text for the topic.shortText: (string) The new short text for the topic.This topic name must match the name used to display the help topic exactly. Topic Name: (string) This is the name of the topic you wish to amend.Note: When amending a topic's short or full text, you can use the string "" to insert the existing topic text. You can use topic amendments to complete the help topics for plugins that do not yet properly support the Bukkit help system or augment those topics with your own commentary. Topic amendments are used to modify or replace the contents or permission requirement for any automatically generated help topic. Preamble: Moderator - do not abuse these commands Use the same name here as you would use to display a topic in the /help command. Any command that can be displayed using the /help command can be included here. commands: (string list) A list of help topic names included in the index.preamble: (string) A message to display on the first page of an index topic before any of the topics in the index.shortText: (string) The short text is a brief description of a topic displayed when an index topic is included in another index topic.Note: To override the default help index displayed when /help is called with no arguments, create an index topic called "Default". When an index topic is displayed, the user's permission set is compared against the permission requirements of each topic in the index and any that do not match are omitted. Index topics are automatically security trimmed so that no player sees any commands requiring permissions they do not have. Index topics are added to the internal help index as separate items along with all the plugin command topics. Index topics are similar to general topics, except instead of displaying pages of information they display a list of more help topics. ![]() If left blank (Ex: permission: ), the help topic will be visible to all players. permission: (string) The permission node required to see a help topic.The help system will automatically break it up into multiple pages. fullText: (string) The full text is the full description of a help topic displayed when the user requests the help topic.shortText: (string) The short text is a brief description of a topic displayed next to the topic name in help indexes.Use the actual name of your topic instead. Note: "Topic Name" is not the name of a yaml key. Spaces are allowed and can be used to create sub-topics. Topic Name: (string) This is the name the /help command will use to locate a topic.General topics are added the internal help index as separate items along with all the plugin command topics. The general-topics section is made up of a list of topics with attributes describing them. The headings listed below are the top-level keys in the YAML file. You only need to modify help.yml if you wish to add new help pages, add new index topics, or override the help pages of existing plugin commands. Help topics for all plugin commands are automatically provided by or extracted from your installed plugins. By default you should not need to modify help.yml. ![]()
0 Comments
Leave a Reply. |