Skip to content
This repository was archived by the owner on Mar 3, 2026. It is now read-only.

Commit 9142b1e

Browse files
committed
README changes
1 parent 903b531 commit 9142b1e

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# HxCompileU
1+
<h1 align="center">HxCompileU</h1>
2+
<h2 align="center">A tool for creating homebrew for the Wii U using Haxe</h2>
3+
24
![mainImage](https://github.com/Slushi-Github/hxCompileU/blob/main/docs/readme/MainImage.png)
35

4-
Using this small utility you can compile code from Haxe to PowerPC and finally the Nintendo Wii U using [DevKitPro](https://devkitpro.org/) and [reflaxe/C++](https://github.com/SomeRanDev/reflaxe.CPP), for creating homebrew for the Wii U.
6+
Using this utility you can compile code from Haxe to the Nintendo Wii U using [DevKitPro](https://devkitpro.org) and [Reflaxe/C++](https://github.com/SomeRanDev/reflaxe.CPP), for creating homebrew for the Wii U using Haxe.
57

68
Officially there are supported libraries to be used in conjunction with HxCompileU:
79

@@ -13,27 +15,26 @@ Officially there are supported libraries to be used in conjunction with HxCompil
1315
- [HxU_SDL_FontCache](https://github.com/Haxe-WiiU/HxU_SDL_FontCache): SDL_FontCache @:native bindings for Haxe to do homebrew on Wii U.
1416
- [HxU_Jansson](https://github.com/Haxe-WiiU/HxU_Jansson): Jansson @:native bindings for Haxe to do homebrew on Wii U.
1517
- [HxU_Vorbis](https://github.com/Haxe-WiiU/HxU_Vorbis): Vorbis @:native bindings for Haxe to do homebrew on Wii U.
16-
- [Leafy Engine](https://github.com/Slushi-Github/leafyEngine): A 2D engine for the Wii U made with Haxe and based on [HaxeFilxel](http://haxeflixel.com/).
18+
- [Leafy Engine](https://github.com/Slushi-Github/leafyEngine): A 2D engine for the Wii U made with Haxe and based on [HaxeFilxel](http://haxeflixel.com).
1719

1820
## How?
19-
The magic really comes from [reflaxe.CPP](https://github.com/SomeRanDev/reflaxe.CPP), being an alternative to [HXCPP](https://github.com/HaxeFoundation/hxcpp) when you want to compile Haxe to C++.
21+
The magic really comes from [Reflaxe/C++](https://github.com/SomeRanDev/reflaxe.CPP), being an alternative to [HXCPP](https://github.com/HaxeFoundation/hxcpp) when you want to compile Haxe to C++.
2022
By default, if you would try to make Haxe with [HXCPP](https://github.com/HaxeFoundation/hxcpp) compile to PowerPC... the results are not nice, there are many errors. With [Reflaxe/C++](https://github.com/SomeRanDev/reflaxe.CPP) we avoid this because it generates a cleaner code without dependencies!
2123

22-
This project is simple... But it works!
23-
2424
This program what it does, is that by means of some data stored in a JSON file (``hxCompileUConfig.json``), it generates a MakeFile and a [HXML](https://haxe.org/manual/compiler-usage-hxml.html) file with those data of the JSON, of normal first it will try to execute the [HXML](https://haxe.org/manual/compiler-usage-hxml.html) with Haxe, [Reflaxe/C++](https://github.com/SomeRanDev/reflaxe.CPP) is in charge of generating the C++ code, if the compilation with Haxe is successful, it executes the MakeFile with Make and starts the normal compilation of a C++ code, if this is also successful, that's it, you have your homebrew for the Nintendo Wii U made with Haxe!
2525

26-
### Plugins?
27-
Currently there is only support focused on creating homebrew applications for the Wii U, but I are working on support for creating [WUPS](https://github.com/wiiu-env/WiiUPluginSystem) plugins using this utility, but I do not assure interest that this is entirely possible
28-
2926
## Why?
3027
Well, since I got a Nintendo Wii U a while ago I've been interested in bringing Haxe to this console.
3128
Officially it's not possible mainly due to Nintendo NDA (Non-Disclosure Agreement) issues, and that actually it can't even be developed for this console anymore.
3229

3330
So... why not experiment to do it taking advantage of the homebrew that exists for the Wii U? hehe! well this is the project for it!
3431

35-
# Usage
32+
### Plugins?
33+
Currently there is only support focused on creating homebrew applications for the Wii U, but I are working on support for creating [WUPS](https://github.com/wiiu-env/WiiUPluginSystem) plugins using this utility, but I do not assure interest that this is entirely possible
3634

35+
-----
36+
37+
# Usage
3738
The basic usage of HxCompileU is as follows:
3839

3940
You need:
@@ -49,7 +50,7 @@ You need:
4950

5051
- [HxU_WUT](https://github.com/Haxe-WiiU/HxU_WUT)
5152

52-
First, you need compilate this project, or you can use the precompiled version that is in the [releases](https://github.com/Slushi-Github/hxCompileU/releases), or you can download it from the [GitHub Actions](https://github.com/Slushi-Github/hxCompileU/actions).
53+
First, you need compilate this project, or you can use the precompiled version that is in the [releases](https://github.com/Slushi-Github/hxCompileU/releases), or you can download it from the [GitHub Actions](https://github.com/Slushi-Github/hxCompileU/actions). I recommend using the [GitHub Actions](https://github.com/Slushi-Github/hxCompileU/actions) option.
5354

5455
```bash
5556
# Just clone the repository
@@ -103,7 +104,7 @@ After that, you will get your executable ``haxeCompileU`` in the "export" folder
103104

104105
-----
105106

106-
### You can also use the following command to start a UDP server to view the logs from the Wii U:
107+
#### You can also use the following command to start a UDP server to view the logs from the Wii U:
107108

108109
``{haxeCompileUProgram} --udpServer``
109110

0 commit comments

Comments
 (0)