1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<meta http-equiv="Content-Style-Type" content="text/css">
6<link rel="stylesheet" type="text/css" href="CSS/revolution.css">
7<base target="main">
8<style type="text/css" media="all">
9<!--
10@import url("css/hbm_common.css");
11h4 {
12  font-size: x-large;
13  border-bottom: 3px double #000;
14}
15PRE
16{
17  font-family			: "Courier New", monospace;
18  font-weight			: normal;
19  font-size			: 10pt;
20  margin				: 0px 20px 10px 30px;
21  padding				: 2px 4px 2px 4px;
22  background-color	: #eee;
23}
24ul.list {
25  margin:20px 20px;
26}
27ul.list li{
28  float:left;
29}
30ul.list li a{
31  color:#060;
32  width: 310px;
33  display:block;
34}
35ul.list li a:active,ul.list li a:hover{
36  color:#0c0;
37}
38-->
39</style>
40<title>HBM WiiWare Support Guide</title>
41</head>
42<body>
43<h1>WiiWare Support Guide</h1>
44<br> <br>
45<h2>The WiiWare-Compatible HOME Menu</h2>
46<p>A detailed manual about WiiWare is available on the Internet.<br><br>The WiiWare-Compatible HOME Menu is specifically designed for WiiWare. It adds a simple WiiWare Operations Guide to the standard HOME Menu, because the user needs to go through the HOME Menu to view manuals from within the WiiWare application. For additional details, refer to other WiiWare documents.</p>
47<a id="intro" name="intro"></a>
48<h4>Incorporating the WiiWare-Compatible HOME Menu</h4>
49<ul class="list">
50  <li><a href="#intro_0">What You Need to Prepare</a>
51  <li><a href="#intro_1">Incorporating into WiiWare</a>
52  <li><a href="#intro_2">Linking the Libraries</a>
53  <li><a href="#intro_3">How to Use</a>
54  <li><a href="#intro_4">Sample Demos</a>
55</ul>
56<br style="clear:both;"> <a id="intro_0" name="intro_0"></a>
57<h2>What You Need to Prepare</h2>
58<ul class="index">
59  <li>Image data for the simple manual page (a maximum of 554 x 256 pixels in size) that can fit on a single screen.<br>
60  The image data passed to the library is a direct color texture. It is okay if the image data for the Operations Guide is smaller than this prescribed size.<br>
61  For details, see <B>Creating Screens for the Operations Guide</B> in the <EM>WiiWare Online Manual Guidelines</EM> package.
62  <li>JPEG codec library (TMCC JPEG, henceforth referred to as the JPEG library).<br>
63  This is required only if using JPEG images.
64</ul>
65<a id="intro_1" name="intro_1"></a>
66<h2>Incorporating into WiiWare</h2>
67<p>For basic uses, it is incorporated the same way that the regular HOME Menu is incorporated into applications.</p>
68<p>Link the <CODE>homebuttonLib.nwm[D].a</CODE> file and embed the shared resource data contained in the <CODE>data/home/cnt</CODE> directory into the application's project.  (In contrast to regular disc applications, a resource file for simple documents is added.)<br>Note: The <CODE>homebuttonLib[D].a</CODE> library, which is used by disc applications, is not used with WiiWare.</p>
69<p>Call <a href="hbm_HBMCreateEx.html"><CODE>HBMCreateEx</CODE></a> <B>between</B> the calls to <a href="hbm_HBMCreate.html"><CODE>HBMCreate</CODE></a> and <a href="hbm_HBMInit.html"><CODE>HBMInit</CODE></a>.</p>
70<ul>
71  <li>Initializing additional content every time:
72  <ol style="padding-top:10px;">
73    <li>Load a resource with <CODE>HBMCreate</CODE>.
74    <li>Load additional content and set the resources to the library using <CODE>HBMCreateEx</CODE>.
75    <li>Use the <CODE>HBMInit</CODE> function to initialize internal library variables.
76    <li>Use the <CODE>HBMDraw</CODE> function to display the HOME Menu.
77    <li>Exit the HOME Menu and then free the additional resources using <CODE>HBMDeleteEx</CODE>.
78    <li>When the game ends, use the <CODE>HBMDelete</CODE> function to free the resources.
79    <dl>
80      <dt style="padding:0px;margin:0px;">To re-display, repeat from step 2.
81      <dt style="padding:0px;margin:0px;"><B>Note:</B> If everything is to be initialized every time, call <CODE>HBMDelete</CODE> in step 5 and then return to step 1.  (Step 6 is no longer necessary.)
82    </dl>
83  </ol>
84  <li style="padding-top:10px;">Making additional content resident:
85  <ol style="padding-top:10px;">
86    <li>Load all resources by initializing the game and other measures.
87    <li>Use <CODE>HBMCreate</CODE> and <CODE>HBMCreateEx</CODE> to load the resources.
88    <li>HOME is pressed.
89    <li>Use the <CODE>HBMInit</CODE> function to initialize internal library variables.
90    <li>Use the <CODE>HBMDraw</CODE> function to display the HOME Menu.
91    <li>Exit from HOME Menu.
92    <dl>
93      <dt style="padding:0px;margin:0px;">To re-display, repeat from step 3.
94    </dl>
95    <li>When the game ends, use the <CODE>HBMDelete</CODE> function to free the resources.
96  </ol>
97</ul>
98<a id="intro_2" name="intro_2"></a>
99<h2>Linking the Libraries</h2>
100<p>Before <B>including</B> <CODE>Revolution/hbm.h</CODE>, define <CODE>USE_FOR_NETWORKMANUAL</CODE> or set the following definition in <CODE>makefile</CODE>:</p>
101<pre>// Define USE_FOR_NETWORKMANUAL
102CCFLAGS += -DUSE_FOR_NETWORKMANUAL</pre>
103<p> </p>
104<p>For <CODE>makefile</CODE>, refer to the <I>networkmanual_jpeg</I> demo if using a JPEG image; otherwise, refer to the <I>networkmanual</I> demo.<br>Note: If you are using the conventional library (<CODE>homebuttonLib[D].a</CODE>) remove the link.</p>
105<pre>// Link to homebuttonLib.nwm.a instead of homebuttonLib.a
106REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/homebuttonLib.nwm$(LIBSUFFIX)
107
108// Not necessary if NOT using the JPEG library
109REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/libTMCC_JPEG.a</pre>
110<br> <a id="intro_3" name="intro_3"></a>
111<h2>How to Use</h2>
112<ul>
113  <li>Be sure to execute <CODE>HBMCreateEx</CODE> after running <CODE>HBMCreate</CODE> and before running <CODE>HBMInit</CODE>.
114  <li>The buffer secured by <CODE>HBMCreateEx</CODE> is released by <CODE>HBMDelete</CODE> or <CODE>HBMCreateEx</CODE>.
115  <li>The <CODE>HBMDeleteEx</CODE> function releases only the items added by the <CODE>HBMCreateEx</CODE> function. Use them as required by an application.
116  <li>Using <a href="hbm_HBMDataInfo.html">HBMDataInfo</a>'s <CODE>messageFlag</CODE>, you can change the dialog message's save data warning shown when the <STRONG>View Detailed Instructions</STRONG> button is pressed.
117  <li>If the HOME Menu quits because the player has pressed the <STRONG>View Detailed Instructions</STRONG> button, <CODE>HBMGetSelectBtnNum</CODE> will return the value of 4. If this happens, execute <CODE>OSLaunchManualViewer</CODE> and start up the online manual.
118</ul>
119<a id="intro_4" name="intro_4"></a>
120<h2>Sample Demos</h2>
121<ul>
122  <li>networkmanual_tpl<br>
123  The data in the TPL file below is displayed as a simple manual page. The background is transparent.<br>
124  <br>
125  $RVL_SDK/dvddata/hbmdemo/sample.tpl (302 KB)<br>
126  <li>networkmanual_jpeg<br>
127  Using the JPEG library, the JPEG files below are displayed as a simple manual page. The background is not transparent.<br>
128  <br>
129  $RVL_SDK/dvddata/hbmdemo/sample.jpg (125 KB)<br>
130  $RVL_SDK/dvddata/hbmdemo/s_sample.jpg (12 KB)
131</ul>
132<br> <a id="contents" name="contents"></a>
133<h4>Shared contents data</h4>
134<p>The directory structure of the shared contents can be viewed by unzipping <CODE>data/hbm/contents_data.zip</CODE> under <CODE>RVL_SDK</CODE>.<br>Verify by comparing against the description given below.</p>
135<h2>Data inside HomeButton.arc</h2>
136<p>This contains the layout data for each language, the HOME Menu disabled icon, the Wii Remote speaker data, and the <CODE>config</CODE> file.<br>For each file, data for two-button configuration is in the <CODE>HomeButton2</CODE> directory, and data for three-button configuration is in the <CODE>HomeButton3</CODE> directory.</p>
137<ul>
138  <li>config.txt: The button settings file
139  <li>homeBtnIcon.tpl: The Home Menu disabled icon
140  <li>Huf8_SpeakerSe.arc: Wii Remote speaker data
141  <li>LZ77_homeBtn.arc: Japanese layout data
142  <li>LZ77_homeBtn_ENG.arc: English layout data
143  <li>LZ77_homeBtn_FRA.arc: French layout data
144  <li>LZ77_homeBtn_GER.arc: German layout data
145  <li>LZ77_homeBtn_ITA.arc: Italian layout data
146  <li>LZ77_homeBtn_NED.arc: Dutch layout data
147  <li>LZ77_homeBtn_SPA.arc: Spanish layout data
148</ul>
149<p>Note that content of the files given below is outdated, and that <font color="red"><B>the use of these files is prohibited at this time</B></font>.</p>
150<ul>
151  <li>home.csv: Dialog messages (instead, embed <CODE>$RVL_SDK/dvddata/hbm/HomeButton*/home.csv</CODE> directly in the application)
152  <li>home_nosave.csv: Dialog messages (instead, embed <CODE>$RVL_SDK/dvddata/hbm/HomeButton*/home_nosave.csv</CODE> directly in the application)
153  <li>Huf8_HomeButtonSe.arc: HOME Button Menu sound data (instead, use the files in <CODE>$RVL_SDK/data/cnt/HomeButtonSe.arc</CODE>)
154</ul>
155<p>Use <CODE>HomeButtonCHN.arc</CODE> and <CODE>HomeButtonKOR.arc</CODE> exclusively.</p>
156<h2>Data Inside HomeButtonCHN.arc</h2>
157<p>This contains the layout data for Chinese language, the HOME Menu disabled icon, the Wii Remote speaker data, and the <CODE>config</CODE> file.<br>For each file, data for two-button configuration is in the <CODE>HomeButton2</CODE> directory, and data for three-button configuration is in the <CODE>HomeButton3</CODE> directory.</p>
158<ul>
159  <li>config.txt: The button settings file
160  <li>homeBtnIcon.tpl: The Home Menu disabled icon
161  <li>Huf8_SpeakerSe.arc: Wii Remote speaker data
162  <li>LZ77_homeBtn_CHN.arc: Chinese layout data
163</ul>
164<p>Please use <CODE>HomeButton.arc</CODE> and <CODE>HomeButtonKOR.arc</CODE> exclusively.</p>
165<h2>Data inside HomeButtonKOR.arc</h2>
166<p>This contains the layout data for the Korean language, the HOME Menu disabled icon, the Wii Remote speaker data and the <CODE>config</CODE> file.<br>For each file, data for two-button configuration is in the <CODE>HomeButton2</CODE> directory, and data for three-button configuration is in the <CODE>HomeButton3</CODE> directory.</p>
167<ul>
168  <li>config.txt: The button settings file
169  <li>homeBtnIcon.tpl: The Home Menu disabled icon
170  <li>Huf8_SpeakerSe.arc: Wii Remote speaker data
171  <li>LZ77_homeBtn_KOR.arc: Korean layout data
172</ul>
173<p>Use <CODE>HomeButton.arc</CODE> and <CODE>HomeButtonCHN.arc</CODE> exclusively.</p>
174<h2>Data Inside HomeButtonSe.arc</h2>
175<p>This contains the HOME Menu sound data.<br>The data is located under the <CODE>HomeButtonSe</CODE> directory.</p>
176<ul>
177  <li>Huf8_HomeButtonSe.arc: The HOME Menu sound data
178</ul>
179<h2>Data Inside HomeButton_nwm.arc</h2>
180<p>This contains the layout data for WiiWare in each language.<br>The data is located under the <CODE>HomeButton3</CODE> directory.</p>
181<ul>
182  <li>LZ77_homeBtn_nwm_jpn.arc: Japanese layout data for WiiWare
183  <li>LZ77_homeBtn_nwm_eng.arc: English layout data for WiiWare
184  <li>LZ77_homeBtn_nwm_fra.arc: French layout data for WiiWare
185  <li>LZ77_homeBtn_nwm_ger.arc: German layout data for WiiWare
186  <li>LZ77_homeBtn_nwm_ita.arc: Italian layout data for WiiWare
187  <li>LZ77_homeBtn_nwm_ned.arc: Dutch layout data for WiiWare
188  <li>LZ77_homeBtn_nwm_spa.arc: Spanish layout data for WiiWare
189</ul>
190<h2>Revision History</h2>
191<dl class="history">
192  <DT>2008/04/28<DD>Added mention of the dialog message to <STRONG>How to Use</STRONG>.
193  <dt>2008/02/01
194  <dd>Initial version.
195</dl>
196<hr><p>CONFIDENTIAL</p></body>
197</html>