Skip to content

Commit

Permalink
README: document new wad functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
vs49688 committed Jan 20, 2021
1 parent 28c8712 commit e34fabf
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ For encoding/decoding of Argonaut ASF and BRP files, please see [FFmpeg](https:/

### Usage
```
Usage: croctool map decompile <input-file.map> [<output-file.json|->]
Usage: croctool map decompile <input-file.map> [output-file.json|-]
croctool map compile <input-file.json|-> <output-file.map>
croctool map convert [--rebase [-]<000-899>] <input-file.map> <output-file.map>
croctool map unwad <input-file.wad> <base-name>
croctool crocfile dump <CROCFILE.DIR> [<output-file.json|->]
croctool crocfile extract <CROCFILE.DIR> <CROCFILE.DAT|CROCFILE.1> [<outdir>]
croctool mod burst2obj <input-file.mod> [<output-dir>]
croctool crocfile dump <CROCFILE.DIR> [output-file.json|-]
croctool crocfile extract <CROCFILE.DIR> <CROCFILE.DAT|CROCFILE.1> [output-dir]
croctool mod burst2obj <input-file.mod> [output-dir]
croctool wad extract <base-name> <file-name> [output-dir|-]
croctool wad extract-all <base-name> [output-dir]
croctool wad dump-index <index-name.idx> [output-file.json]
```

#### map decompile
Expand Down Expand Up @@ -52,6 +55,25 @@ The directory must exist beforehand.

Material handling isn't supported yet.

#### wad extract

Extract a named file from a given WAD/IDX pair.
* `base-name` should be given as the WAD/IDX path WITHOUT the extension.
* If `output-dir` isn't specified, it will write to the current working directory.
* If `output-dir` is `-`, then the file contents will be written to stdout.
* Otherwise, the file will be placed in `output-dir`.

#### wad extract-all

Extract all files from a given WAD/IDX pair.
* `base-name` should be given as the WAD/IDX path WITHOUT the extension.
* If `output-dir` isn't specified, the files will be written to the current working directory.
* Otherwise, the files will be placed in `output-dir`.

#### wad dump-index

Dump an IDX file to JSON.

## Notes

* Odd padding in PSX maps
Expand Down

0 comments on commit e34fabf

Please sign in to comment.