summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md')
-rw-r--r--Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md b/Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md
new file mode 100644
index 0000000..63ec719
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/NoCampaignMusic/README.md
@@ -0,0 +1,27 @@
+# FFXI - No Campaign Music
+
+Prevents all campaign battle music from playing in Final Fantasy XI, so you can listen to that sweet music that is normally obnoxiously interrupted.
+
+## Load
+
+```
+//lua load ncm
+```
+
+## Campaign notifications
+
+If you want to know when campaign is happening, you can toggle notifications:
+
+```
+//ncm notify
+```
+
+## Note
+
+When campaign music is prevented from playing (whether it's as you zone in, or campaign starts in the zone) a message will log to the chatlog stating "Prevented campaign music." This not only confirms the addon is working, but shows you there's a campaign active should you want to take part.
+
+## Contributing
+
+If you notice something not quite right, please [raise an issue](https://github.com/xurion/ffxi-no-campaign-music/issues).
+
+Or better yet, [pull requests](https://github.com/xurion/ffxi-no-campaign-music/pulls) are welcome!