summaryrefslogtreecommitdiffstats
path: root/src/main/resources
diff options
context:
space:
mode:
authorrmichela <deltahat@gmail.com>2012-03-16 00:41:13 -0400
committerEvilSeph <evilseph@gmail.com>2012-03-16 03:12:48 -0400
commit4589e943f6796f96a3cab0b1ea2563bc9a357b15 (patch)
tree8585f9057629c5b21694c1511a1fb102a66abd10 /src/main/resources
parent46429c6cb948f5338f253c1e22cce459704d773b (diff)
downloadcraftbukkit-4589e943f6796f96a3cab0b1ea2563bc9a357b15.tar
craftbukkit-4589e943f6796f96a3cab0b1ea2563bc9a357b15.tar.gz
craftbukkit-4589e943f6796f96a3cab0b1ea2563bc9a357b15.tar.lz
craftbukkit-4589e943f6796f96a3cab0b1ea2563bc9a357b15.tar.xz
craftbukkit-4589e943f6796f96a3cab0b1ea2563bc9a357b15.zip
[Bleeding] Added support for color codes in help.yml. Addresses BUKKIT-1191
Diffstat (limited to 'src/main/resources')
-rw-r--r--src/main/resources/configurations/help.yml23
1 files changed, 12 insertions, 11 deletions
diff --git a/src/main/resources/configurations/help.yml b/src/main/resources/configurations/help.yml
index 5e6ed5b9..d7f363b1 100644
--- a/src/main/resources/configurations/help.yml
+++ b/src/main/resources/configurations/help.yml
@@ -1,36 +1,37 @@
# This is the help configuration file for Bukkit.
+#
# By default you do not need to modify this file. Help topics for all plugin commands are automatically provided by
# 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 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.
-# --
+#
+# Examples are given below. When amending command topic, the string <text> will be replaced with the existing value
+# in the help topic. Color codes can be used in topic text. The color code character is & followed by 0-F.
+#
# Set this to true to list the individual command help topics in the master help.
# command-topics-in-master-index: true
-# --
+#
# 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
# fullText: |
-# 1. Be kind to your fellow players.
-# 2. No griefing.
-# 3. No swearing.
+# &61. Be kind to your fellow players.
+# &B2. No griefing.
+# &D3. 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: