MLlib

	MLlib
General
Author(s)	Minishlink
Type	Framework library
Version	1.0
Links
	Download
	Website
	Discussion
	Source

The MLlib (or Minishlink's Library) is a simple library to develop on Nintendo Wii. Technically, it's a wrapper of libogc and others librairies. Coding with this lib on Wii is way easier and faster now ! :-) I created this because I needed a library with I could code with easy functions. It uses GX for drawing, libpng for handling PNG, and libs of libogc...

Features

Proper code so that it's nice to see;
Easy for all;
Friendly functions;
Handles drawing (lol);
Sprite system;
Handles PNG images, BMP soon;
Write graphically text;
MP3 system;
MOD system;
Input (Wiimote, Nunchuk, and extensions...) system;
And much more...

How to install ?

On Windows

First you need to have devKitPro installed. Go install it ! ;)

Then, libpng for Wii must be installed.

Download it at my FTP.
Extract it and place the .a in "devkitpro\libogc\lib\wii" and the folder "png" in "devkitpro\libogc\include".
It's done !

Now the MLlib.

Download the MLlib on the Google Code MLlib page
Extract the arhive and place the 3 folders where you want (recommended in C:\devkitPro)
Info : "MLlib" folder is where the library is; "MLlib_" folder is where the source is (you can delete it if you want); "MLlib_Others" is where the template, examples, ressources are.
Set the environment variable "MLPATH" to your path to the MLlib. (eg. "/c/devkitPro/MLlib" because it must be linux-style) To do that, open the Start menu, right-click on Computer -> Properties, then go to the advanced settings -> environments variables. Set it there. It's recommended to restart the computer.
It should be done ! Go explore examples ! :D (test if it works via an example)

On Linux

First you need to have devKitPro installed. Go install it ! ;)

Then, libpng for Wii must be installed.

Download it at my FTP.
Extract it and place the .a in "devkitpro/libogc/lib/wii" and the folder "png" in "devkitpro/libogc/include".
It's done !

Now the MLlib.

Download the MLlib on the Google Code MLlib page
Extract the archive and place the 3 folders where you want (recommended in /home/user/devkitpro)
Info : "MLlib" folder is where the library is; "MLlib_" folder is where the source is (you can delete it if you want); "MLlib_Others" is where the template, examples, ressources are.
Set the environment variable "MLPATH" to your path to the MLlib. (eg. "/home/username/devkitpro/MLlib") To do that, open and type in a new console:

export MLPATH=/path/to/MLlib

It should be done ! Go explore examples ! :D (test if it works via an example)

On Mac OS X

You should be able to do it if you read Windows/Linux instructions. Updated tutorial will coming soon though, with Mac OS X ;)

Notes

Quickstart

For a quickstart, see the section How to install ? and go see the examples in the "MLlib_Others" folder ! ;)

Tutorials and Wiki

Some tutorials and more info are available at the MLlib Wiki.

Documentation

Online documentation is available here.

Error when compiling the template/examples ?

To test correctly the examples and the template, make sure you have done a "make clean" before, because it will give you the error

make[1]: *** No rule to make target `/home/minishlink/devkitpro/MLlib_Others/template/source/main.c', needed by `main.o'. Stop.

if you don't do this ! :p

Makefile & Commands

Editing Makefile

In order to use the MOD part of the MLlib, you need to uncomment the line "USE_MOD" at the top of the Makefile. It's the same thing when you need to compile code that uses MP3 or FAT.

Make

Compiles the project.

Make clean

Cleans the project, it destroys dependancies too.

Make run

It sends the app/game previously compiled to the Wii via the wiiload program. It's quiet useful because you don't need to type "wiiload projectXYZ.dol", "make run" is faster ! You have to put the original Wiiload program (eg. the command-line program, which is provided with Twilight Hack or HBC) in the system folder of your OS. Example : "C:\Windows\System32" for Windows ; "/usr/bin" for Linux ; "??? #FixIt" for MaxOSX.

Wiiload program can be downloaded here or in the Hackmii Installer (beta 3 or newer).

Make all

It cleans the project, then compiles and then sends to the Wii.

Bugs & Suggestions

If you have any bugs or suggestions, feel free to report them on Google Code.

Special Thanks

Chaosteil
Cid2Mizard
Crayon
Dhewg
Dykam
EvilSpoon
Feesh
Mollusk
Morukutsu
NoNameNo
Svpe
T4ils
WntrMute
Zeblackos

and these communities :

www.dev-fr.org + IRC Channel #dev-fr
www.nintendomax.com
www.wiibrew.org + IRC Channel #wiidev
www.wiigen.fr

Update History

1.0 - May 31, 2009

First public release