Difference between revisions of "Homebrew development guide"
(Created page with "Please keep in mind the following: <div style="background-color:#fcfcfc; border: 1px solid #ccc; color:#000; margin-top: 15px; margin-bottom: 10px; padding: 8px; text-align:ce...") |
m |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | This article will go over the primary ways of developing various types of homebrew on the Wii U. | |
| − | |||
| − | |||
| − | |||
| − | + | == Configuring environment == | |
| + | Your first step is to install [https://devkitpro.org/wiki/devkitPro_pacman devkitPro pacman], downloading the Linux, OSX or Windows versions as appropriate for your setup. If you use the Windows installer, you don't need to tick any of the "<console> development" options. On Linux and OSX, pacman will be installed into your native terminal, while Windows users will find a new terminal named "msys2" that they will need to use. Once you're up and running, you can use one of <syntaxhighlight inline>dkp-pacman -S <package></syntaxhighlight> or <syntaxhighlight inline>pacman -S <package></syntaxhighlight> to install packages! Start off by installing <syntaxhighlight inline>devkitPPC</syntaxhighlight>, followed by <syntaxhighlight inline>devkit-env</syntaxhighlight> on Linux. | ||
| − | == | + | == Making Native Apps (wut) == |
| − | + | The best solution for making Wii U homebrew at this time is [https://github.com/decaf-emu/wut wut]; an actively-developed toolchain that can build native RPX apps. RPX apps have a high filesize limit, can be launched through HBL or installed to the System Menu as a channel, and can take advantage of many Nintendo features previously unavailable to homebrew. It's recommended to use wut for all new projects. | |
| + | |||
| + | You should be able to install the <syntaxhighlight inline>wut</syntaxhighlight> package. | ||
| + | |||
| + | There's plenty of examples of using wut, such as [https://github.com/decaf-emu/wut/tree/master/samples its own examples]; along with real-world apps. See [[#Guides]] for more info on getting started with wut. | ||
| + | |||
| + | === SDL === | ||
| + | There's also a port of SDL2 built on top of wut available to developers; with features like hardware acceleration and sound support. It's designed to be as close to the Switch port of SDL2 as possible, so often Switch and PC SDL2 apps can be used without any changes. It can be installed with <syntaxhighlight inline>wiiu-sdl2</syntaxhighlight> - real-world examples of use include [https://github.com/vgmoose/hb-appstore hb-appstore], [https://github.com/rw-r-r-0644/Fireplace-WiiU Fireplace-WiiU], [https://github.com/rw-r-r-0644/WiiU-Shell WiiU-Shell], and many others! | ||
| + | |||
| + | == Legacy methods == | ||
| + | The methods below are useful to know about in case you need to work with or learn from older code, though are generally unsupported and unmaintained. | ||
| − | == Making HBL | + | === Making HBL ELF apps === |
The [[Homebrew Launcher]] is an easy platform to target for development. The two below methods are useful for making console and GUI apps respectively. In particular, lib_easy is a good place to start. Apps compiled with this method are in the ELF format. | The [[Homebrew Launcher]] is an easy platform to target for development. The two below methods are useful for making console and GUI apps respectively. In particular, lib_easy is a good place to start. Apps compiled with this method are in the ELF format. | ||
| − | === Using lib_easy === | + | ==== Using lib_easy ==== |
[https://github.com/rw-r-r-0644/WiiU-HelloWorld-Easy lib_easy] by rw-r-r_0644 was designed to be a quick way to get familiar with programming on the Wii U. That link contains an example hello world project. After setting up your environment, you can compile the hello world project by cd-ing into the folder and running "make". | [https://github.com/rw-r-r-0644/WiiU-HelloWorld-Easy lib_easy] by rw-r-r_0644 was designed to be a quick way to get familiar with programming on the Wii U. That link contains an example hello world project. After setting up your environment, you can compile the hello world project by cd-ing into the folder and running "make". | ||
| − | An example of a homebrew app that was made using lib_easy is [[UClick]]. | + | An example of a homebrew app that was made using lib_easy is [[UClick]]. lib_easy is now deprecated in favor of wut. |
| − | === Using Dimok's libraries === | + | ==== Using Dimok's libraries ==== |
[[Dimok's libraries]] provide assistance with interacting with various parts of the Wii U. For some projects that use OSScreen to interact with the see [[Pong]], [[C@ve]], [[Snake]], or [[Space Game]]. (Specifically, you will want to look at [https://github.com/dimok789/pong_port this HBL pong port]). | [[Dimok's libraries]] provide assistance with interacting with various parts of the Wii U. For some projects that use OSScreen to interact with the see [[Pong]], [[C@ve]], [[Snake]], or [[Space Game]]. (Specifically, you will want to look at [https://github.com/dimok789/pong_port this HBL pong port]). | ||
Dimok's libs also provide many GX2 wrappers that provide a template for creating Homebrew Launcher-style GUIs. Examples of projects that utilize this include [[Homebrew Launcher]], [[CHIP-8_Emulator]], and [[Homebrew App Store]]. | Dimok's libs also provide many GX2 wrappers that provide a template for creating Homebrew Launcher-style GUIs. Examples of projects that utilize this include [[Homebrew Launcher]], [[CHIP-8_Emulator]], and [[Homebrew App Store]]. | ||
| − | = | + | === Making Userland Apps === |
| − | |||
| − | |||
| − | |||
| − | |||
| − | == Making Userland Apps == | ||
The userland environment does not require a kernel exploit to execute programs, but as a result is heavily limited. These apps hijack the browser, but don't go any further. [https://github.com/wiiudev/libwiiu libwiiu] is a good build system to use to produce .bin files which can be converted into mp4 payloads. It has detailed compilation instructions and many examples in the readme and repository. | The userland environment does not require a kernel exploit to execute programs, but as a result is heavily limited. These apps hijack the browser, but don't go any further. [https://github.com/wiiudev/libwiiu libwiiu] is a good build system to use to produce .bin files which can be converted into mp4 payloads. It has detailed compilation instructions and many examples in the readme and repository. | ||
| − | A lot of the earlier homebrew was initially made for this userland environment, although most of it has since been ported to HBL. | + | A lot of the earlier homebrew was initially made for this userland environment, although most of it has since been ported to HBL. [https://github.com/wiiudev/libwiiu/tree/master/osscreenexamples/pong Pong], [https://github.com/sonyusa/cave C@ve], and [https://github.com/vgmoose/space/tree/userland Space Game] are among those early apps. |
It isn't really recommended to use userland while a kernel exploit environment is available. It is heavily restricted to ~20KB payload files, no access to global variables, and no access to GX2 (OSScreen only). | It isn't really recommended to use userland while a kernel exploit environment is available. It is heavily restricted to ~20KB payload files, no access to global variables, and no access to GX2 (OSScreen only). | ||
== Guides == | == Guides == | ||
| − | [[User:QuarkTheAwesome|QuarkTheAwesome]] is working on a more in-depth guide to Wii U development, which is available [https://github.com/QuarkTheAwesome/ProgrammingOnTheU | + | [[User:QuarkTheAwesome|QuarkTheAwesome]] is working on a more in-depth guide to Wii U development using wut, which is available [https://github.com/QuarkTheAwesome/ProgrammingOnTheU here]. |
| − | |||
| − | |||
== Support == | == Support == | ||
| − | If you need help developing, here are a few | + | If you need help developing, here are a few channels that may be able to provide direct assistance. |
| − | * [https:// | + | * [https://discord.gg/Y6JwXpn fortheusers Discord] (formerly wiiubru) has a lot of key homebrew and toolchain devs |
| − | * [https://kiwiirc.com/client/irc. | + | * [https://kiwiirc.com/client/irc.efnet.org/wiiudev #wiiudev on irc.efnet.org] is a good place to talk about the hacking side of things |
Don't be afraid to ask! :) | Don't be afraid to ask! :) | ||
Latest revision as of 02:32, 15 June 2022
This article will go over the primary ways of developing various types of homebrew on the Wii U.
Configuring environment
Your first step is to install devkitPro pacman, downloading the Linux, OSX or Windows versions as appropriate for your setup. If you use the Windows installer, you don't need to tick any of the "<console> development" options. On Linux and OSX, pacman will be installed into your native terminal, while Windows users will find a new terminal named "msys2" that they will need to use. Once you're up and running, you can use one of dkp-pacman -S <package> or pacman -S <package> to install packages! Start off by installing devkitPPC, followed by devkit-env on Linux.
Making Native Apps (wut)
The best solution for making Wii U homebrew at this time is wut; an actively-developed toolchain that can build native RPX apps. RPX apps have a high filesize limit, can be launched through HBL or installed to the System Menu as a channel, and can take advantage of many Nintendo features previously unavailable to homebrew. It's recommended to use wut for all new projects.
You should be able to install the wut package.
There's plenty of examples of using wut, such as its own examples; along with real-world apps. See #Guides for more info on getting started with wut.
SDL
There's also a port of SDL2 built on top of wut available to developers; with features like hardware acceleration and sound support. It's designed to be as close to the Switch port of SDL2 as possible, so often Switch and PC SDL2 apps can be used without any changes. It can be installed with wiiu-sdl2 - real-world examples of use include hb-appstore, Fireplace-WiiU, WiiU-Shell, and many others!
Legacy methods
The methods below are useful to know about in case you need to work with or learn from older code, though are generally unsupported and unmaintained.
Making HBL ELF apps
The Homebrew Launcher is an easy platform to target for development. The two below methods are useful for making console and GUI apps respectively. In particular, lib_easy is a good place to start. Apps compiled with this method are in the ELF format.
Using lib_easy
lib_easy by rw-r-r_0644 was designed to be a quick way to get familiar with programming on the Wii U. That link contains an example hello world project. After setting up your environment, you can compile the hello world project by cd-ing into the folder and running "make".
An example of a homebrew app that was made using lib_easy is UClick. lib_easy is now deprecated in favor of wut.
Using Dimok's libraries
Dimok's libraries provide assistance with interacting with various parts of the Wii U. For some projects that use OSScreen to interact with the see Pong, C@ve, Snake, or Space Game. (Specifically, you will want to look at this HBL pong port).
Dimok's libs also provide many GX2 wrappers that provide a template for creating Homebrew Launcher-style GUIs. Examples of projects that utilize this include Homebrew Launcher, CHIP-8_Emulator, and Homebrew App Store.
Making Userland Apps
The userland environment does not require a kernel exploit to execute programs, but as a result is heavily limited. These apps hijack the browser, but don't go any further. libwiiu is a good build system to use to produce .bin files which can be converted into mp4 payloads. It has detailed compilation instructions and many examples in the readme and repository.
A lot of the earlier homebrew was initially made for this userland environment, although most of it has since been ported to HBL. Pong, C@ve, and Space Game are among those early apps.
It isn't really recommended to use userland while a kernel exploit environment is available. It is heavily restricted to ~20KB payload files, no access to global variables, and no access to GX2 (OSScreen only).
Guides
QuarkTheAwesome is working on a more in-depth guide to Wii U development using wut, which is available here.
Support
If you need help developing, here are a few channels that may be able to provide direct assistance.
- fortheusers Discord (formerly wiiubru) has a lot of key homebrew and toolchain devs
- #wiiudev on irc.efnet.org is a good place to talk about the hacking side of things
Don't be afraid to ask! :)