wudd/README.md

# WUDD - Wii U Disc Dumper

Inspired by [wudump](https://github.com/FIX94/wudump) from FIX94.

Features:
- Dump a Wii U Disc in WUD (uncompressed) or [WUX](https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) (loseless compression) format (including the game.key)
- Dump the GM Partitions (Game, Updates, DLCs) of an Wii U Disc as *.app,*.h3, .tmd, .tik, .cert files
- Supports dumping to SD (FAT32) and USB (NTFS only). When dumping to SD the files get slitted in 2 GiB parts. 

Files will be dumped to `/wudump/[DISC-ID]/`. The DiscID of a game can be found on the disc (e.g. WUP-P-ARDP for the EUR version of Super Mario 3D World).

## How to merge splitted files

When you dump a .wux or .wud to the SD card it gets splitted into 2 GiB parts (FAT32 limitation). To merge them you can use the `copy` cmd tool.

Example:
`copy /b game.wux.part1 + game.wux.part2 game.wux`

## Dependencies
Requires an [Environment](https://github.com/wiiu-env/EnvironmentLoader) (e.g. Tiramisu or Aroma) with [MochaPayload](https://github.com/wiiu-env/MochaPayload) (Nightly-MochaPayload-20220725-155554 or newer)

- [wut](https://github.com/devkitPro/wut)
- [libmocha](https://github.com/wiiu-env/libmocha)
- [libntfs](https://github.com/wiiu-env/libntfs)

## Buildflags

### Logging
Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`.

`make` Logs errors only (via OSReport).  
`make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).  
`make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).

If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fallback to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.

## Building using the Dockerfile

It's possible to use a docker image for building. This way you don't need anything installed on your host system.

```
# Build docker image (only needed once)
docker build . -t wudd-builder

# make 
docker run -it --rm -v ${PWD}:/project wudd-builder make

# make clean
docker run -it --rm -v ${PWD}:/project wudd-builder make clean
```

## Format the code via docker

`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source -i`
Update readme, rename to wudd 2021-10-16 13:27:19 +02:00			`# WUDD - Wii U Disc Dumper`
First commit 2021-10-09 00:58:55 +02:00
Update readme, rename to wudd 2021-10-16 13:27:19 +02:00			`Inspired by [wudump](https://github.com/FIX94/wudump) from FIX94.`
First commit 2021-10-09 00:58:55 +02:00
Update readme, rename to wudd 2021-10-16 13:27:19 +02:00			`Features:`
			`- Dump a Wii U Disc in WUD (uncompressed) or [WUX](https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) (loseless compression) format (including the game.key)`
Various improvements including: - Display name/type of the partition - Block home menu when launching via HBL - Use libmocha instead of libiosuhax, which should result in a small performance boost - Improve logging - Improve memory management - Add option to abort dumps - Slightly improve .wux handling 2022-07-26 09:24:06 +02:00			`- Dump the GM Partitions (Game, Updates, DLCs) of an Wii U Disc as .app,.h3, .tmd, .tik, .cert files`
Update readme, rename to wudd 2021-10-16 13:27:19 +02:00			`- Supports dumping to SD (FAT32) and USB (NTFS only). When dumping to SD the files get slitted in 2 GiB parts.`

			Files will be dumped to `/wudump/[DISC-ID]/`. The DiscID of a game can be found on the disc (e.g. WUP-P-ARDP for the EUR version of Super Mario 3D World).

			`## How to merge splitted files`

			When you dump a .wux or .wud to the SD card it gets splitted into 2 GiB parts (FAT32 limitation). To merge them you can use the `copy` cmd tool.

			`Example:`
Various improvements including: - Display name/type of the partition - Block home menu when launching via HBL - Use libmocha instead of libiosuhax, which should result in a small performance boost - Improve logging - Improve memory management - Add option to abort dumps - Slightly improve .wux handling 2022-07-26 09:24:06 +02:00			`copy /b game.wux.part1 + game.wux.part2 game.wux`
First commit 2021-10-09 00:58:55 +02:00
			`## Dependencies`
Various improvements including: - Display name/type of the partition - Block home menu when launching via HBL - Use libmocha instead of libiosuhax, which should result in a small performance boost - Improve logging - Improve memory management - Add option to abort dumps - Slightly improve .wux handling 2022-07-26 09:24:06 +02:00			`Requires an [Environment](https://github.com/wiiu-env/EnvironmentLoader) (e.g. Tiramisu or Aroma) with [MochaPayload](https://github.com/wiiu-env/MochaPayload) (Nightly-MochaPayload-20220725-155554 or newer)`
First commit 2021-10-09 00:58:55 +02:00
Update readme, rename to wudd 2021-10-16 13:27:19 +02:00			`- [wut](https://github.com/devkitPro/wut)`
Various improvements including: - Display name/type of the partition - Block home menu when launching via HBL - Use libmocha instead of libiosuhax, which should result in a small performance boost - Improve logging - Improve memory management - Add option to abort dumps - Slightly improve .wux handling 2022-07-26 09:24:06 +02:00			`- [libmocha](https://github.com/wiiu-env/libmocha)`
First commit 2021-10-09 00:58:55 +02:00			`- [libntfs](https://github.com/wiiu-env/libntfs)`

Various improvements including: - Display name/type of the partition - Block home menu when launching via HBL - Use libmocha instead of libiosuhax, which should result in a small performance boost - Improve logging - Improve memory management - Add option to abort dumps - Slightly improve .wux handling 2022-07-26 09:24:06 +02:00			`## Buildflags`

			`### Logging`
			Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`.

			`make` Logs errors only (via OSReport).
			`make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).
			`make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).

			`If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fallback to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.`

First commit 2021-10-09 00:58:55 +02:00			`## Building using the Dockerfile`

			`It's possible to use a docker image for building. This way you don't need anything installed on your host system.`

			```
			`# Build docker image (only needed once)`
Format the code via clang-format 2022-07-26 08:16:27 +02:00			`docker build . -t wudd-builder`
First commit 2021-10-09 00:58:55 +02:00
			`# make`
Format the code via clang-format 2022-07-26 08:16:27 +02:00			`docker run -it --rm -v ${PWD}:/project wudd-builder make`
First commit 2021-10-09 00:58:55 +02:00
			`# make clean`
Format the code via clang-format 2022-07-26 08:16:27 +02:00			`docker run -it --rm -v ${PWD}:/project wudd-builder make clean`
			```

			`## Format the code via docker`

			`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source -i`