AromaBasePlugin/README.md
2023-03-16 12:41:31 +01:00

56 lines
2.5 KiB
Markdown

# Aroma Base Plugin
Provides some simple patches for Wii U Menu and checks for Aroma updates.
## Installation
(`[ENVIRONMENT]` is a placeholder for the actual environment name.)
1. Copy the file `AromaBasePlugin.wps` into `sd:/wiiu/environments/[ENVIRONMENT]/plugins`.
2. Requires the [WiiUPluginLoaderBackend](https://github.com/wiiu-env/WiiUPluginLoaderBackend) in `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
3. Requires the [CURLWrapperModule](https://github.com/wiiu-env/CURLWrapperModule) in `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
4. Requires the [NotificationModule](https://github.com/wiiu-env/NotificationModule) in `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
5. Requires the [RPXLoadingModule](https://github.com/wiiu-env/RPXLoadingModule) in `sd:/wiiu/environments/[ENVIRONMENT]/modules`.
## Usage
Via the plugin config menu (press L, DPAD Down and Minus on the GamePad, Pro Controller or Classic Controller) you can configure the plugin. The available options are the following:
- **Wii U Menu patches**:
- Avoid "Format" dialog on Wii U Menu (UStealth): (Default is false)
- Skips the "Format"-nag when launching the Wii U Menu with a non-formatted external drive.
- Skip "Shutdown warning" on boot: (Default is true)
- Hide the "Shutdown warning" after shutting the console down by pressing the power button for 4 seconds.
- **Other patches**:
- Allow error notifications (Default is true)
- Fix connecting to a 3DS in Mii Maker: (Default is true)
- Forces "nn::ndm::SuspendDaemonsAndDisconnectIfWireless" to always return success, this fixes connecting to the 3DS in Mii Maker.
## Building
For building you need:
- [wups](https://github.com/wiiu-env/WiiUPluginSystem)
- [wut](https://github.com/decaf-emu/wut)
- [libnotifications](https://github.com/wiiu-env/libnotifications)
- [librpxloader](https://github.com/wiiu-env/librpxloader)
- [libcurlwrapper](https://github.com/wiiu-env/libcurlwrapper)
## 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 aroma-base-plugin-builder
# make
docker run -it --rm -v ${PWD}:/project aroma-base-plugin-builder make
# make clean
docker run -it --rm -v ${PWD}:/project aroma-base-plugin-builder make clean
```
## Format the code via docker
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src --exclude ./src/utils/json.hpp -i`