Skip to content

Commit d8c4396

Browse files
committed
add quickstart for subtexture extraction
1 parent f10c7be commit d8c4396

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,18 @@ I can then distribute Launch_patch.pkg and Launch_patch.pkg_manifest. To apply t
4141

4242
This will replace any entries in the package with any matching entries in the patches and append any new entries in the patches. More than one patch can be applied at a time (later ones take precedence if there are conflicts).
4343

44+
To **extract** every subtexture instead of packed atlases use the `-s` or `--subtextures` flag.
45+
46+
deppth2 ex -s Launch.pkg
47+
48+
This doesn't extract lower mip textures by default as they are irrelevant for most use cases. If you need to extract them you can use the `--include-mip` flag.
49+
4450
## Deppth2 API
4551

4652
The Deppth2 module exposes functions that perform the actions described above, plus a fourth (which is also part of the CLI) to list the contents of a package. It's basically just a programmer interface for the same things the CLI does -- the latter is just a wrapper for the former.
4753
```py
4854
list(name, *patterns, logger=lambda s: None)
49-
extract(package, target_dir, *entries, subtextures=False, logger=lambda s: None)
55+
extract(package, target_dir, *entries, subtextures=False, logger=lambda s: None, include_mip=False)
5056
pack(source_dir, package, *entries, logger=lambda s: None)
5157
patch(name, *patches, logger=lambda s : None)
5258
```

0 commit comments

Comments
 (0)