1 files changed, 49 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/autojoin/readme.md b/Data/BuiltIn/Libraries/lua-addons/addons/autojoin/readme.md
new file mode 100644
index 0000000..a37ff91
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/autojoin/readme.md
@@ -0,0 +1,49 @@
+# AutoJoin
+
+Once loaded, will automatically join party and alliance invites. It will not process the invite if the treasure pool is not empty. It will also wait until the treasure pool is cleared to join, although it can be forced by typing `/join` normally.
+
+### Modes
+
+AutoJoin can operate in two modes (can be changed in the settings file):
+
+* Whitelist mode [default]
+Will only join invites from people you have specifically whitelisted. See below for whitelist commands.
+
+* Blacklist mode
+Will always join, except invites from people you blacklisted. Note that this is _not_ your FFXI blacklist, but another blacklist you have to create for this.
+
+### Commands
+
+All commands are prefaced with `//autojoin`, or `//aj`.
+
+#### Mode switch
+
+```
+//autojoin mode [[b|black|blist|blacklist]|[w|white|wlist|whitelist]]
+```
+
+If no mode is specified, the current mode will be printed.
+
+#### Add names to blacklist/whitelist
+
+```
+//autojoin [[b|black|blist|blacklist]|[w|white|wlist|whitelist]] [[+|a|add]|[-|r|remove]] [name [...]]
+```
+
+Will add or remove the specified names to the blacklist or whitelist. If no names are specified, it will print out the current blacklist or whitelist.
+
+#### Print current settings
+
+```
+//autojoin status
+```
+
+Shows the current mode, the people on the blacklist and whitelist, as well as if auto-decline for blacklisted people is activated.
+
+#### Save settings
+
+```
+//autojoin save
+```
+
+Saves current settings for all characters. This will overwrite all user-defined settings. Nothing is needed to save settings for the current character, that happens automatically any time a setting is changed.