PatchMemoryRelocationsModule/README.md

43 lines
2.0 KiB
Markdown
Raw Normal View History

2022-02-04 16:42:24 +01:00
[![CI-Release](https://github.com/wiiu-env/PatchMemoryRelocationsModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/PatchMemoryRelocationsModule/actions/workflows/ci.yml)
2020-06-10 16:27:42 +02:00
# PatchMemoryRelocationsModule
Replaces the usage of `MEMAllocFromDefaultHeap`, `MEMAllocFromDefaultHeapEx` and `MEMFreeToDefaultHeap` with similar function from the MemoryMappingModule in the currently running modules.
2022-01-30 16:59:24 +01:00
## Usage
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
1. Copy the file `PatchMemoryRelocationsModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`.
2020-06-10 16:27:42 +02:00
2022-05-12 23:59:47 +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).
2020-06-27 12:41:59 +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 patchmemoryrelocationsmodule-builder
# make
docker run -it --rm -v ${PWD}:/project patchmemoryrelocationsmodule-builder make
# make clean
docker run -it --rm -v ${PWD}:/project patchmemoryrelocationsmodule-builder make clean
```
2022-02-04 16:42:24 +01:00
## Format the code via docker
2023-03-17 18:58:25 +01:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source -i`
2022-02-04 16:42:24 +01:00
2020-06-10 16:27:42 +02:00
# Dependencies:
2020-06-27 12:41:50 +02:00
- [wut](https://github.com/decaf-emu/wut)
2020-06-10 16:27:42 +02:00
- [WUMS](https://github.com/wiiu-env/WiiUModuleSystem)
- [MemoryMappingModule](https://github.com/wiiu-env/MemoryMappingModule) & [libmappedmemory](https://github.com/wiiu-env/libmappedmemory)