Update the readme

This commit is contained in:
Maschell 2019-06-04 13:33:49 +02:00
parent 3715b757ab
commit 56840994fd

View File

@ -8,6 +8,7 @@ Loading NUS Contents from different sources. Currently implemented:
* Files from the NUS Server (Only the part that are needed will be downloaded) * Files from the NUS Server (Only the part that are needed will be downloaded)
* .woomy files (https://github.com/shinyquagsire23/makefst) * .woomy files (https://github.com/shinyquagsire23/makefst)
* WUD Images. Also compressed (.wux https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) and splitted WUD's (parts dumped from wudumper) * WUD Images. Also compressed (.wux https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) and splitted WUD's (parts dumped from wudumper)
* .wumad files
@ -34,7 +35,7 @@ For WUD files, following additional operations are possible:
<!-- The core module --> <!-- The core module -->
<dependency> <dependency>
<groupId>de.Maschell.JNUSLib</groupId> <groupId>de.Maschell.JNUSLib</groupId>
<artifactId>sdcf4j-core</artifactId> <artifactId>JNUSLib</artifactId>
<version>%version OR commit%</version> <version>%version OR commit%</version>
</dependency> </dependency>
``` ```
@ -91,6 +92,17 @@ WUDInfo wiKiosk = WUDLoader.loadDev("game.wux");
List<NUSTitle> titlesFromWUD = WUDLoader.getGamePartionsAsNUSTitles(wudInfo, commonKey); List<NUSTitle> titlesFromWUD = WUDLoader.getGamePartionsAsNUSTitles(wudInfo, commonKey);
``` ```
#### wumad
```
/ Loading a wumad
WumadInfo wumadInfo = WumadLoader.load(new File("game.wud"));
// Get NUSTitles from wumad
List<NUSTitle> titlesFromWumad = WumadLoader.getGamePartionsAsNUSTitles(wumadInfo, commonKey);
```
Once the title is loaded, you can use one of the services to extract and decrypt files. Once the title is loaded, you can use one of the services to extract and decrypt files.
### Decryption: ### Decryption:
@ -103,6 +115,9 @@ FSTDataProvider fstdataprovider = new FSTDataProviderNUSTitle(nustitle);
List<FSTDataProvider> partitionsFromWUD = WUDLoader.getPartitonsAsFSTDataProvider(wudInfo, commonKey); List<FSTDataProvider> partitionsFromWUD = WUDLoader.getPartitonsAsFSTDataProvider(wudInfo, commonKey);
// the includes all non-nustitles like the SI or UP partitions. // the includes all non-nustitles like the SI or UP partitions.
// When loading from a Wumad, you can get the data of all partitions via
List<FSTDataProvider> partitionsFromWumad = WumadLoader.getPartitonsAsFSTDataProvider(wumadInfo, commonKey);
FSTEntry fstRoot = fstdataprovider.getRoot(); FSTEntry fstRoot = fstdataprovider.getRoot();
FSTEntry appxml = FSTUtils.getFSTEntriesByRegEx(fstdataprovider.getRoot(), ".*app.xml").get(0); // get all .rpx files FSTEntry appxml = FSTUtils.getFSTEntriesByRegEx(fstdataprovider.getRoot(), ".*app.xml").get(0); // get all .rpx files