summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md')
-rw-r--r--Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md b/Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md
new file mode 100644
index 0000000..aef96a2
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/SpellBook/readme.md
@@ -0,0 +1,37 @@
+# SpellBook
+
+This addon helps you find missing spells. You can search by job and level,
+or by category.
+
+## Usage
+Spent jp can be specified for spells learned from Gifts by entering a value of 100-1500.
+Spells are never given as Gifts for less than 100 jp and values under 100 are treated as level.
+
+
+```
+//spbk help
+```
+Show help text.
+```
+//spbk [current]
+```
+Show learnable spells based on current main and sub job and level/jp.
+```
+//spbk <main|sub> [<level|spent jp|all>]
+```
+Show missing spells for current main or sub job. Defaults to the job\'s current level/jp.
+```
+//spbk <job> [<level|spent jp|all>]
+```
+Show missings spells for specified job and level. Defaults to the job\'s level/jp.
+```
+//spbk <category> [all]
+```
+Show learnable spells by category. Limited to spells which are learnable, unless all is added after the category.
+
+Categories: whitemagic, blackmagic, songs, ninjustu, summoning, bluemagic, geomancy, trusts, all (Trusts are not included in all)
+
+
+## Credits
+
+Inspired by the SpellCheck addon by Zubis