WUMSLoader/README.md

54 lines
2.4 KiB
Markdown
Raw Normal View History

2022-02-04 21:44:03 +01:00
[![CI-Release](https://github.com/wiiu-env/WUMSLoader/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/WUMSLoader/actions/workflows/ci.yml)
# Wii U Module System Loader
This is a payload that should be run with [EnvironmentLoader](https://github.com/wiiu-env/EnvironmentLoader).
2020-04-28 14:43:07 +02:00
## Usage
Put the `10_wums_loader.rpx` in the `fs:/vol/external01/wiiu/environments/[ENVIRONMENT]/modules/setup` folder of your sd card and use the `EnvironmentLoader` to run this setup payload.
2020-04-28 14:43:07 +02:00
Put modules (in form of `.wms` files) that should be used a main()-hook into `fs:/vol/external01/wiiu/environments/[ENVIRONMENT]/modules/`.
2020-04-28 14:43:07 +02:00
The area between `0x00809000` and `0x00FFF000` will be used.
2020-04-28 14:43:07 +02:00
2022-05-08 19:22:38 +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.
2020-04-28 14:43:07 +02:00
## Building
Make you to have [wut](https://github.com/devkitPro/wut/) and [WiiUModuleSystem](https://github.com/wiiu-env/WiiUModuleSystem) installed and use the following command for build:
2020-04-28 14:43:07 +02:00
```
make install
```
2020-06-25 19:13:12 +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)
docker build . -t wumsloader-builder
2020-06-25 19:13:12 +02:00
# make
docker run -it --rm -v ${PWD}:/project wumsloader-builder make
2020-06-25 19:13:12 +02:00
# make clean
docker run -it --rm -v ${PWD}:/project wumsloader-builder make clean
2020-06-25 19:13:12 +02:00
```
2022-02-04 21:44:03 +01:00
## Format the code via docker
2023-03-18 14:50:15 +01:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./wumsloader/src -i --exclude ./wumsloader/src/elfio -i`
2020-06-25 19:13:12 +02:00
2020-04-28 14:43:07 +02:00
## Credits
- Maschell
2020-04-28 14:43:07 +02:00
- Copy paste stuff from dimok
- Copy pasted the solution for using wut header in .elf files from [RetroArch](https://github.com/libretro/RetroArch)
2022-05-08 19:22:38 +02:00
- Copy pasted resolving the ElfRelocations from [decaf](https://github.com/decaf-emu/decaf-emu)