summaryrefslogtreecommitdiff
path: root/server/frob/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'server/frob/README.md')
-rw-r--r--server/frob/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/server/frob/README.md b/server/frob/README.md
new file mode 100644
index 0000000..19fbe13
--- /dev/null
+++ b/server/frob/README.md
@@ -0,0 +1,19 @@
+# tmwAthena item frobber
+## Prerequisites
+- [Deno]
+
+## Compatibility
+- works with tmwAthena `v16.2.9 - v19.4.15`
+ - newer versions may modify the flatfile structure and break things
+
+## Usage
+- from `tmwa-server-data`:
+```
+# choose whatever syntax you prefer:
+make frob items="item[,item[,item...]]" # item list (csv)
+make frob items="item[ item[ item...]]" # item list
+make frob items="item-item" # item range
+make frob items="item..item" # item range
+```
+
+[Deno]: https://deno.land