diff options
| author | rmichela <deltahat@gmail.com> | 2012-03-14 23:39:19 -0400 |
|---|---|---|
| committer | EvilSeph <evilseph@gmail.com> | 2012-03-16 02:44:05 -0400 |
| commit | 184faf1f299df4f821c287bc179f106c78efbbc5 (patch) | |
| tree | e5d5a1aceaca6a7ef3699c896270b73c3fa0b554 /src/main/resources | |
| parent | fc697a4f440829c6813b198b9e1e0a87789e042b (diff) | |
| download | craftbukkit-184faf1f299df4f821c287bc179f106c78efbbc5.tar craftbukkit-184faf1f299df4f821c287bc179f106c78efbbc5.tar.gz craftbukkit-184faf1f299df4f821c287bc179f106c78efbbc5.tar.lz craftbukkit-184faf1f299df4f821c287bc179f106c78efbbc5.tar.xz craftbukkit-184faf1f299df4f821c287bc179f106c78efbbc5.zip | |
[Bleeding] Added option to remove entire plugins from the help index using the help.yml file. Addresses BUKKIT-1178
Diffstat (limited to 'src/main/resources')
| -rw-r--r-- | src/main/resources/configurations/help.yml | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/src/main/resources/configurations/help.yml b/src/main/resources/configurations/help.yml index 715ddd3e..1a4ac9fc 100644 --- a/src/main/resources/configurations/help.yml +++ b/src/main/resources/configurations/help.yml @@ -3,10 +3,15 @@ # or extracted from your installed plugins. You only need to modify this file if you wish to add new help pages to # your server or override the help pages of existing plugin commands. # -- -# This file is divided up into two parts: general-topics and command-topics respectively. Examples are given below. -# Color codes are allowed. When amending command topic, the string <text> will be replaced with the existing value -# in the help topic. +# This file is divided up into the following parts: +# -- general-topics: lists admin defined topics +# -- amend-topics: lists topic amendments to apply to existing help topics +# -- ignore-plugins: lists any plugins that should be excluded from help +# general-topics and command-topics respectively. +# Examples are given below. Color codes are allowed. When amending command topic, the string <text> will be replaced +# with the existing value in the help topic. # -- +# Each general topic will show up as a separate topic in the help index along with all the plugin command topics. # general-topics: # rules: # shortText: Rules of the server @@ -16,8 +21,16 @@ # 3. No swearing. # permission: topics.rules # -- +# Topic amendments are used to change the content of automatically generated plugin command topics. # amended-topics: # /stop: # shortText: Stops the server cold....in its tracks! # fullText: <text> - This kills the server. # permission: you.dont.have +# -- +# Any plugin in the ignored plugins list will be excluded from help. The name must match the name displayed by +# the /plugins command. Ignore "Bukkit" to remove the standard bukkit commands from the index. +# ignore-plugins: +# - PluginNameOne +# - PluginNameTwo +# - PluginNameThree |