Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bnnm committed Sep 8, 2023
1 parent e15a163 commit 3cb5151
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Examples of (slightly) advanced usage:
wwiser.pyz *.bnk
# create a list of missing name IDs
wwiser.py *.bnk -sl -sm
wwiser.py *.bnk -sl
# generate txtp, moving wem, using alt extensions if neede, unused and using sound dir
wwiser.py -d none *.bnk -g -gm -gae -gu -gw sound
Expand Down
4 changes: 2 additions & 2 deletions doc/NAMES.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ You need to start with a base word list and some imagination to guess how names

#### Quick guide
Typical use of *words.py*:
- use `wwiser.pyz *.bnk -sl -sm` + a base `wwnames.txt` (if you have one) to generate a clean `wwnames-banks-(date).txt` with valid words + missing FNV numbers
- use `wwiser.pyz *.bnk -sl` + a base `wwnames.txt` (if you have one) to generate a clean `wwnames-banks-(date).txt` with valid words + missing FNV numbers
- In the GUI you can create this list by loading banks, pressing the "*Redump clean wwnames.txt*" button and checking "*Also include missing IDs*"
- put that file (now base word list + reversable FNV numbers) with *words.py*
- by default it reads any and all `wwnames*.txt` in dir
Expand Down Expand Up @@ -252,7 +252,7 @@ Basically make a `wwnames.txt` list of things like `BGM_Vocal_Camp_Off`, include

You can have an extra `ww.txt` list (only reads words and ignores IDs), and `fnv.txt` (only reads ID numbers) too, or use those two instead of `wwnames.txt`. Include `formats.txt` to fine tune prefixes/suffixes.

FNV ID numbers must be plain `(number)` or `# (number)` (as the later is how it appears in `wwnames.txt`), and will ignore non-numbers and multiple numbers in the same line, or `(number): name` (*words.py* results). Remember missing names can be created with *wwiser* using `-sl -sm`.
FNV ID numbers must be plain `(number)` or `# (number)` (as the later is how it appears in `wwnames.txt`), and will ignore non-numbers and multiple numbers in the same line, or `(number): name` (*words.py* results). Remember missing names can be created with *wwiser* using `-sl`.

Internally *words.py* splits parts (`BGM`, `BGM_Vocal_Camp` `Vocal_Camp_Off`, `Vocal_Camp`, `Vocal`, etc) from lists and combines with formats (see below). It's best to start with all names we have (like `wwnames.txt` or even output straight from `strings2`). You can force generate internally combined words with a flag, but it'll make huge lists.

Expand Down

0 comments on commit 3cb5151

Please sign in to comment.