homebrew_launcher/README.md

62 lines
2.7 KiB
Markdown
Raw Normal View History

2016-05-08 22:31:59 +02:00
# WiiU Homebrew Launcher
2016-05-08 22:37:08 +02:00
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
2016-05-08 22:31:59 +02:00
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.
2016-05-08 22:31:59 +02:00
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:
2016-05-08 22:31:59 +02:00
- 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
2016-05-08 22:37:08 +02:00
#### Building the Homebrew Launcher
2016-05-08 22:31:59 +02:00
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 [libogc](https://github.com/dimok789/homebrew_launcher/releases/download/v1.0/libogc.7z) and [portlibs](https://github.com/dimok789/homebrew_launcher/releases/download/v1.0/portlibs.7z) 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".
2016-05-08 22:37:08 +02:00
#### Building an application / homebrew (ELF) for the Homebrew Launcher
2016-05-08 22:31:59 +02:00
For an example on how to build an application for the HBL check out the [Hello World example](https://github.com/dimok789/hello_world) application or the port of the libwiiu application [Pong](https://github.com/dimok789/pong_port) 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>
2016-05-08 22:31:59 +02:00
#### 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.