summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgumi <git@gumi.ca>2019-07-04 20:04:02 -0400
committergumi <git@gumi.ca>2019-07-04 20:04:02 -0400
commit30f65ba374f5dd11785925c52864b7545c1773b6 (patch)
treef5094c40fa6765da5f01f9a71e4291c3de966ad0
parenta7adab09d7f94afd80742ae38052d8b7e6b73f8d (diff)
downloadtools-30f65ba374f5dd11785925c52864b7545c1773b6.tar.gz
tools-30f65ba374f5dd11785925c52864b7545c1773b6.tar.bz2
tools-30f65ba374f5dd11785925c52864b7545c1773b6.tar.xz
tools-30f65ba374f5dd11785925c52864b7545c1773b6.zip
[frob] add more details to the readme
-rw-r--r--server/frob/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/server/frob/README.md b/server/frob/README.md
index 19fbe13..88c6880 100644
--- a/server/frob/README.md
+++ b/server/frob/README.md
@@ -1,19 +1,21 @@
# tmwAthena item frobber
## Prerequisites
-- [Deno]
+- [Deno] `v0.X`
+ - must be in your `$PATH`
## Compatibility
- works with tmwAthena `v16.2.9 - v19.4.15`
- - newer versions may modify the flatfile structure and break things
+ - newer versions may modify the flatfile structure and break the regexes
## Usage
- from `tmwa-server-data`:
-```
+```sh
# 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
+make frob items="item,item item-item item" # mixed
```
[Deno]: https://deno.land