AutobootModule/README.md

54 lines
2.5 KiB
Markdown
Raw Normal View History

2022-02-02 19:57:14 +01:00
[![CI-Release](https://github.com/wiiu-env/AutobootModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/AutobootModule/actions/workflows/ci.yml)
2021-12-28 20:17:21 +01:00
# AutobootModule
2021-12-31 15:16:43 +01:00
This is a bootmenu targetted to be loaded with the [EnvironmentLoader](https://github.com/wiiu-env/EnvironmentLoader). It allows you to boot into the Wii U Menu, Homebrew Channel, vWii System Menu or vWii Homebrew Channel.
## Usage
2021-12-31 15:27:59 +01:00
Place the `99_autoboot` in the `[ENVIRONMENT]/modules/setup` folder and run the EnvironmentLoader.
2021-12-31 15:16:43 +01:00
- Requires the [HBLInstallerWrapper](https://github.com/wiiu-env/HBLInstallerWrapper) in the `[ENVIRONMENT]/modules/setup` folder.
2021-12-31 15:27:59 +01:00
- Requires the `homebrew_launcher.elf` in `sd:/wiiu/apps/homebrew_launcher/homebrew_launcher.elf`.
2021-12-31 15:16:43 +01:00
Hold START (+) on the Gamepad while launching this Environment to force open the Autoboot menu.
Press Y on the autoboot menu to set autobooting to this titles. To revert it, force open the menu by holding START (+) while launching the environment.
## Features
- Boot into Wii U Menu, Homebrew Channel, vWii System Menu or vWii Homebrew Channel.
- Full support of Quick Boot Menu of the Gamepad when coldbooting
- Set a autoboot title
2022-08-25 18:08:18 +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.
2021-12-31 15:16:43 +01:00
## Building
For building you just need [wut](https://github.com/devkitPro/wut/) installed, then use the `make` command.
## 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 autobootmodule-builder
# make
docker run -it --rm -v ${PWD}:/project autobootmodule-builder make
# make clean
docker run -it --rm -v ${PWD}:/project autobootmodule-builder make clean
```
2022-02-02 19:57:14 +01:00
## Format the code via docker
2023-03-16 12:41:19 +01:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source -i`
2022-02-02 19:57:14 +01:00
## Credits
- GaryOderNichts
- Maschell