summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md')
-rw-r--r--Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md b/Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md
new file mode 100644
index 0000000..ac11513
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/highlight/readme.md
@@ -0,0 +1,15 @@
+
+##Description
+This addon highlights the names of the people in your party, and highlights their name when it appears in chat.
+
+The colors you select in this file will override any colours specified by other addons, for instance, Rolltracker and Battlemod
+
+##Features
+The colors of this addon are based on the default Battlemod colors, and they will be pulled in from your battlemod file. If you do not use battlemod, it will pull the colors from settings file in the data folder.
+
+It also changes any common mispellings of peoples names, or nicknames uses into their correct name, and colours them accordingly. This feature will eventually plugin to the chatmon functionality.
+
+##Previous Mentions
+
+Highlight also tracks when people mentions you. You can view these back at any time by typing //highlight view <optional number of views>.
+If you want to add these mentions to a text file you can do this by typing //highlight write. \ No newline at end of file