summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md')
-rw-r--r--Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md b/Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md
new file mode 100644
index 0000000..6772625
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/InfoReplacer/ReadMe.md
@@ -0,0 +1,39 @@
+# InfoReplacer #
+
+Replaces outgoing text prefixed by % with respective information. For a complete list of replacements, view [`reps.lua`](https://github.com/Windower/Lua/blob/4.1/addons/InfoReplacer/reps.lua).
+
+----
+
+### Commands: ###
+
+#### Show replacements ####
+
+```
+//inforeplacer list
+```
+
+Shows all (custom) replacement names.
+
+#### Set custom replacement ####
+
+```
+//inforeplacer set <name> <value>
+```
+
+Defines a custom replacement variable as the provided value.
+
+#### Set custom code replacement ####
+
+```
+//inforeplacer seteval <name> <code>
+```
+
+Defines a custom replacement variable as the provided Lua expression. This expression will be evaluated whenever it appears in the chat, so this can be used to print dynamic values.
+
+#### Remove custom replacement ####
+
+```
+//inforeplacer unset <name>
+```
+
+Deletes a previously defined custom replacement variable.