An open API service indexing awesome lists of open source software.

https://github.com/dkosmari/papaya-hud

An Aroma plugin to show a HUD on the Wii U.
https://github.com/dkosmari/papaya-hud

wiiu wiiu-homebrew wiiu-plugin

Last synced: about 1 month ago
JSON representation

An Aroma plugin to show a HUD on the Wii U.

Awesome Lists containing this project

README

        

# Papaya HUD

This is a HUD (Heads-Up Display) plugin for the Aroma environment on the Wii U.





## Features

Supported stats:

- Current time, console uptime, game play time.

- Frames per second.

- CPU utilization, for all 3 PowerPC cores, and the ARM core.

- GPU utilization. Note: this will lower the frame rate for some games.

- Network profile (WiFi SSID, Ethernet, or none).

- Network bandwidth.

- Filesystem performance.

- Button presses per second.

- Battery level.

You can also use a button shortcut to toggle the HUD on or off. By default it's **TV + L**
on the gamepad, but you can change it in the plugin config menu (**L + DOWN + SELECT**).

> The toggle state is **NOT** saved when using the toggle shortcut; this is done on purpose,
> in case the game/app crashes when the HUD is turned on. The settings are only saved when
> using the plugin config menu.

The HUD color is also configurable. You can press **Y** while changing the color, to
switch between RGB and hex mode.

> Note that any option can be reset back to the default value by pressing **X** while
> editing it.

## Building

This plugin can be built in 3 different ways: locally, with Docker, or through Github Actions.

### Local build instructions

This is an Automake package that's intended to be cross-compiled using devkitPro's
environment. Besides the base Wii U packages (installable through `dkp-pacman`), you will
also need to manually install the dependencies:

- [wut](https://github.com/devkitPro/wut/) (because the latest devkitPro package is
outdated.)

- [libbuttoncombo](https://github.com/wiiu-env/libbuttoncombo)

- [libmappedmemory](https://github.com/wiiu-env/libmappedmemory)

- [libnotifications](https://github.com/wiiu-env/libnotifications)

- [WiiUPluginSystem](https://github.com/wiiu-env/WiiUPluginSystem)

To get the Papaya HUD source, either extract a release tarball (.tar.gz), or clone the
code with git (remember to clone with the `--recurse-submodules` option.)

Build steps (skip step 0 if you used a release tarball):

0. `./bootstrap`

1. `./configure --host=powerpc-eabi CXXFLAGS="-Os -ffunction-sections -fipa-pta"`

2. `make`

3. (Optional) If your Wii U is named `wiiu` in your local network, you can also run:

- `make run` (will temporarily load the plugin into Aroma without installing it,
requires `wiiload` package from devktiPro)

- `make install` (requires `curl` from your system)

- `make uninstall` (requires `curl` from your system)

### Docker build instructions

If you have Docker, just run the `./docker-build.sh` script.

### Github Actions build instructions

If you fork the repository, you can create builds using Github Actions:

1. Click on **Actions**.

- If prompted, enable actions for your fork.

2. Click on **Build**, on the left.

3. Click on **Run workflow** on the right, then again on the **Run workflow** button.

4. Wait a few seconds and refresh the page. You will see the **Build** action being
queued and executed.

5. After the build finishes (the status icon turns green), refresh the page. You can find
the `.wps` file listed as an artifact, at the bottom.