readme-RVL_HBM_SDK-4_5-20080924.txt
1======================================================================
2HBM - HOME Menu Library version 4.5
3for Revolution SDK 3.2
42008/09/24
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.2 patch 1
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
43 This demo uses the homebuttonLib version of the library.
44 All 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, places it in Mem1, and then runs.
48
49- shareddemo
50 This sample starts the HOME Menu from a NAND application.
51 Resources 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
56 This sample starts the HOME Menu from WiiWare.
57 The Operations Guide is displayed as a TPL.
58 Resources 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
63 This sample starts the HOME Menu from WiiWare.
64 The Operations Guide is displayed as a JPEG using the JPEG codec library.
65 Resources 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
83 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.
84
85- Disk Applications
86 Be sure to use the updated sound resource.
87
88- Channel Applications
89 Since 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.4 (version 080617)
103- 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.*
104- A problem has been corrected where a finger cursor was momentarily displayed in the middle of the screen when starting the HOME Button Menu.
105- Revised the sample demo.
106 all: Wii Remote processing has been changed in accordance with changes to the KPAD library under Revolution SDK 3.2.
107 all: A problem with the method of using VIGetTvFormat has been corrected.*
108 rsodemo: The demo has been revised because default instruction code execution in MEM2 was prohibited under Revolution SDK 3.2.
109 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.
110- Revised the function reference.
111
112* These revisions are not included in the HBM Library for Revolution SDK 3.1.
113
114
115=======================================================================
116Known Issues
117=======================================================================
118- None.
119
120