readme-RVL_HBM_SDK-4_4-20080617.txt
1======================================================================
2HBM - HOME Menu Library version 4.4
3for Revolution SDK 3.1
42008/06/17
5======================================================================
6
7- Introduction
8- System Requirements
9- Installation and Running of the Demos
10- Incorporating Icons and Banners into Your Application
11- Method of Supporting Versions After 3.0
12- Revision History
13- Known Issues
14
15
16=======================================================================
17Introduction
18=======================================================================
19This package includes a sample library for implementing HOME Menu and sample demos that use this library.
20
21
22=======================================================================
23System Requirements
24=======================================================================
25Operation of this package has been confirmed for the following development environments.
26
27- Revolution SDK 3.1 Patch 4
28- CodeWarrior for Nintendo GameCube Version 3.0 Alpha 5 plus Patch 2
29
30In addition, you also need NDEV hardware and NDEV software.
31
32
33=======================================================================
34Installation and Running of the Demos
35=======================================================================
36To 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.)
37
38This package is not a patch. It will continue to be provided as a separate package in the future.
39
40The package includes the following demos:
41
42- hbm
43This demo uses the homebuttonLib version of the library.
44All processing, including the processing of sounds, is carried out inside the library.
45
46- rsodemo
47This sample converts the HOME Menu execution segment (including homebutton.a) into rso format, lays it out in Mem2, and then runs.
48
49- shareddemo
50This sample starts the HOME Menu from a NAND application.
51Resources used in the HOME Menu use files provided in Wii system memory as shared content.
52
53NOTE: NADK must be installed separately.
54
55- networkmanual_tpl
56This sample starts the HOME Menu from WiiWare.
57The Operations Guide is displayed as a TPL.
58Resources used in the HOME Menu use files provided in Wii system memory as shared content.
59
60NOTE: NADK must be installed separately.
61
62- networkmanual_jpeg
63This sample starts the HOME Menu from WiiWare.
64The Operations Guide is displayed as a JPEG using the JPEG codec library.
65Resources used in the HOME Menu use files provided in Wii system memory as shared content.
66
67NOTE: The NADK and JPEG codec libraries must be installed separately.
68
69
70=======================================================================
71Incorporating Icons and Banners into Your Application
72=======================================================================
73See "HBM Library Overview" in the HBM Library Function Reference.
74
75Use the same version of the library and data files.
76
77=======================================================================
78Method of Supporting Versions After 3.0
79=======================================================================
80Users who switch to an environment version 3.0 or later after using a package version prior to 3.0 should take the following steps.
81
82- All Libraries
83The 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.
84
85- Disk Applications
86Be sure to use the updated sound resource.
87
88- Channel Applications
89Since shared NAND content will be added when applying this update, ensure the following:
90
91- Always use RVL_SDK/data/hbm/cnt/HomeButton.arc and RVL_SDK/data/hbm/cnt/HomeButtonSe.arc when creating WAD files.
92- Do not use HomeButton*/Huf8_HomeButtonSe.brsar, which is inside RVL_SDK/data/hbm/cnt/HomeButton.arc.
93- Do not use the .csv files inside RVL_SDK/data/hbm/cnt/HomeButton.arc.
94
95For concrete methods of use, refer to shareddemo, provided with this package.
96
97
98=======================================================================
99Revision History
100=======================================================================
101
102* Updates from Version 4.3 (080428)
103- Corrected a problem with the pointer initialization value creeping toward the center when a Nintendo Classic Controller is connected and use_devtype is set to WPAD_DEV_CORE.
104- Introduced countermeasures in homebuttonLib.vcmv[D].a against multiple initializations of sound threads when a delete function was not called.
105
106
107=======================================================================
108Known Issues
109=======================================================================
110- None.
111
112