homebrew_launcher/README.md
dimok789 9bf14c87ab - added channel contents and meta files to build the HBL channel (big thanks to cathor and Maschell for their work on the artwork, boot sound and boot video. Every part of it is created with open source software.)
- added Makefile target to build official HBL channel
- fixed issue when launching system menu from homebrew applications
- adapted README to include proper links for portlibs

NOTE:
To build the HBL channel it is necessary to encrypt the channel with the Wii U common key for the Wii U to be able to decrypt it. Therefore a full channel release can not be distributed and everyone has to build it from sources. The key has to be saved in a file with the name "encryptKeyWith" in string/ascii format (not binary) on the root of the HBL source path. Once that is done the command "make install_channel" can be used to build the channel files (java is required for that process). To install the output "install_channel" and run the HBL channel a signature check patched firmware is necessary such as iosuhax. Big thanks to the developer of NUSPacker at this point ;).

Some homebrews will not work properly as they depend on the launcher title ID to be Mii Maker (e.g. ddd). These homebrews need to be adapted by their developers to accept the HBL title id 00050000-13374842. Additionally HBL provides much more access rights than Mii Maker does. Therefore several applications such as wupinstaller can be simplified because a launch of other titles is not necessary anymore.
2016-11-16 00:44:58 +01:00

2.9 KiB

WiiU Homebrew Launcher

The Homebrew Launcher is a WiiU homebrew that lists homebrew applications located on a SD card and permits launching them (similar to the Homebrew Channel of the Wii).

Usage

To use the Homebrew Launcher (or HBL, for short) you must copy homebrew_launcher.elf into SD:/wiiu/apps/homebrew_launcher/homebrew_launcher.elf, and run the installer throught your WiiU browser.

The apps that will be listed are should be in the following path /wiiu/apps/homebrew_name/some_elf_name.elf on the root of the SD card. A meta.xml and an icon.png (256x96) are optional. Here is an example:

  • sd:/
    • wiiu/
      • apps/
      • homebrew_launcher/
        • homebrew_launcher.elf
        • meta.xml
        • icon.png
      • loadiine_gx2/
        • loadiine_gx2.elf
        • meta.xml
        • icon.png
      • ddd/
        • ddd.elf
        • meta.xml
        • icon.png
      • ftpiiu/
        • ftpiiu.elf
        • meta.xml
        • icon.png

Building the Homebrew Launcher

To build the main application devkitPPC is required as well as some additionally libraries. If not yet done export the path of devkitPPC and devkitPro to the evironment variables DEVKITPRO and DEVKITPPC. Additionally you will need to include the portlibs packages in your devkitPro path.

All remaining is to enter the main application path and enter "make". You should get a homebrew_launcher.elf and a homebrew__launcher_dbg.elf in the main path.

To compile the installer application enter the "installer" path on the source code and type "make".

Building an application / homebrew (ELF) for the Homebrew Launcher

For an example on how to build an application for the HBL check out the Hello World example application or the port of the libwiiu application Pong for HBL.

Meta XML

The meta.xml is optional and can be put in the same path as the homebrew ELF file to display additional information about the homebrew.

Here is a XML example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<app version="1">
<name>name</name>
<coder>coder<coder>
<version>app version</version>
<release_date>app release date</release_date>
<short_description>short description</short_description> 
<long_description>long description</long_description> 
</app>

Icon PNG

The icon.png has to be of the resolution 256 x 96 and can be placed in the same path as the homebrew ELF file. This file is optional and shows an icon for the homebrew inside the homebrew launcher.

Credits

  • Dimok
  • many contributors with their pull requests
WUT RPX toolchain which is used to build RPX version of HBL
  • exjam
  • shinyquagsire23
  • several more contributors
HBL channel artwork / boot sound and video
  • cathor
  • Maschell