======================================================================
HBM - HOME Menu Library version 4.5
for Revolution SDK 3.2
2008/09/24
======================================================================

- Introduction
- System Requirements
- Installation and Running of the Demos
- Incorporating Icons and Banners into Your Application
- Method of Supporting Versions After 3.0
- Revision History
- Known Issues


=======================================================================
Introduction
=======================================================================
This package includes a sample library for implementing HOME Menu and sample demos that use this library.


=======================================================================
System Requirements
=======================================================================
Operation of this package has been confirmed for the following development environments.

- Revolution SDK 3.2 patch 1
- CodeWarrior for Nintendo GameCube version 3.0 alpha 5 plus patch 2

In addition, you also need NDEV hardware and NDEV software.


=======================================================================
Installation and Running of the Demos
=======================================================================
To build the demos, overwrite and copy this package into the Revolution SDK root directory, and then run "make" in the build/demos/hbmdemo directory. (No special environment variables need to be specified.)

This package is not a patch. It will continue to be provided as a separate package in the future.

The package includes the following demos:

- hbm
    This demo uses the homebuttonLib version of the library.
    All processing, including the processing of sounds, is carried out inside the library.

- rsodemo
This sample converts the HOME Menu execution segment (including homebutton.a) into rso format, places it in Mem1, and then runs.

- shareddemo
    This sample starts the HOME Menu from a NAND application.
    Resources used in the HOME Menu use files provided in Wii system memory as shared content.
  
NOTE: NADK must be installed separately.

- networkmanual_tpl
    This sample starts the HOME Menu from WiiWare.
    The Operations Guide is displayed as a TPL.
    Resources used in the HOME Menu use files provided in Wii system memory as shared content.
  
NOTE: NADK must be installed separately.

- networkmanual_jpeg
    This sample starts the HOME Menu from WiiWare.
    The Operations Guide is displayed as a JPEG using the JPEG codec library.
    Resources used in the HOME Menu use files provided in Wii system memory as shared content.
  
NOTE: The NADK and JPEG codec libraries must be installed separately.


=======================================================================
Incorporating Icons and Banners into Your Application
=======================================================================
See "HBM Library Overview" in the HBM Library Function Reference.

Use the same version of the library and data files.

=======================================================================
Method of Supporting Versions After 3.0
=======================================================================
Users who switch to an environment version 3.0 or later after using a package version prior to 3.0 should take the following steps.

- All Libraries
    The HBMCreate***Sound function has been combined with HBMCreateSound; sound data that was read internally can now be used as is. Until HBMDeleteSound is called, do not free the memory into which a sound file has been read.

- Disk Applications
    Be sure to use the updated sound resource.

- Channel Applications
    Since shared NAND content will be added when applying this update, ensure the following: 

- Always use RVL_SDK/data/hbm/cnt/HomeButton.arc and RVL_SDK/data/hbm/cnt/HomeButtonSe.arc when creating WAD files. 
- Do not use HomeButton*/Huf8_HomeButtonSe.brsar, which is inside RVL_SDK/data/hbm/cnt/HomeButton.arc. 
- Do not use the .csv files inside RVL_SDK/data/hbm/cnt/HomeButton.arc.

For concrete methods of use, refer to shareddemo, provided with this package.


=======================================================================
Revision History
=======================================================================

* Updates from version 4.4 (version 080617)
- A problem has been corrected where a <CODE>WPADSetConnectCallback</CODE> warning was displayed on the screen if the KPAD library and HOME Menu were used together in a Revolution SDK 3.2 or later environment.*
- A problem has been corrected where a finger cursor was momentarily displayed in the middle of the screen when starting the HOME Button Menu.
- Revised the sample demo.
    all: Wii Remote processing has been changed in accordance with changes to the KPAD library under Revolution SDK 3.2.
    all: A problem with the method of using VIGetTvFormat has been corrected.*
    rsodemo: The demo has been revised because default instruction code execution in MEM2 was prohibited under Revolution SDK 3.2.
    networkmanual_tpl, networkmanual_jpg:Comments have been added and processing revised to make the use of messageFlag, used to adjust the WiiWare manual page button message, easier to understand.
- Revised the function reference.

* These revisions are not included in the HBM Library for Revolution SDK 3.1.


=======================================================================
Known Issues
=======================================================================
- None.