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 -- able to fit in one screen -- for the WiiWare Operations Guide (maximum size: 554 × 256 pixels).<br>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>For details, see <B>Creating Screens for the Operations Guide</B> in the <EM>WiiWare Online Manual Guidelines</EM> package. 60<li>JPEG codec library (TMCC JPEG, henceforth referred to as the JPEG library).)<br>Essential if you will be using JPEG images. 61</ul> 62<a id="intro_1" name="intro_1"></a> 63<h2>Incorporating Into WiiWare</h2> 64<p>For basic uses, it is incorporated the same way that the regular HOME Menu is incorporated into applications.</p> 65<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> 66<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> 67<ul> 68<li>Initializing additional content every time: 69 <ol style="padding-top:10px;"> 70<li>Load a resource with <CODE>HBMCreate()</CODE>. 71<li>Load additional content and set the resources to the library using <CODE>HBMCreateEx()</CODE>. 72<li>Use <CODE>HBMInit()</CODE> to initialize internal library variables. 73<li>Use <CODE>HBMDraw()</CODE> to display the HOME Menu. 74<li>Exit the HOME Menu, then free the additional resources using <CODE>HBMDeleteEx()</CODE>. 75<li>When the game ends, use <CODE>HBMDelete()</CODE> to free the resources. 76 <dl> 77<dt style="padding:0px;margin:0px;">To re-display, repeat from step 2. 78<dt style="padding:0px;margin:0px;">Note: 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.) 79 </dl> 80 </ol> 81<li style="padding-top:10px;">Making additional content resident: 82 <ol style="padding-top:10px;"> 83<li>Load all resources by initializing the game and other measures. 84<li>Use <CODE>HBMCreate()</CODE> and <CODE>HBMCreateEx()</CODE> to load the resources. 85<li>HOME is pressed. 86<li>Use <CODE>HBMInit()</CODE> to initialize internal library variables. 87<li>Use <CODE>HBMDraw()</CODE> to display the HOME Menu. 88<li>Exit from HOME Menu. 89 <dl> 90<dt style="padding:0px;margin:0px;">To re-display, repeat from step 3. 91 </dl> 92<li>When the game ends, use <CODE>HBMDelete()</CODE> to free the resources. 93 </ol> 94</ul> 95<a id="intro_2" name="intro_2"></a> 96<h2>Linking the Libraries</h2> 97<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> 98<pre>// Define USE_FOR_NETWORKMANUAL 99CCFLAGS += -DUSE_FOR_NETWORKMANUAL</pre> 100<p> </p> 101<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> 102<pre>// Link to homebuttonLib.nwm.a instead of homebuttonLib.a 103REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/homebuttonLib.nwm$(LIBSUFFIX) 104 105// Not necessary if NOT using the JPEG library 106REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/libTMCC_JPEG.a</pre> 107<br> <a id="intro_3" name="intro_3"></a> 108<h2>How to Use</h2> 109<ul> 110<li>Be sure to execute <CODE>HBMCreateEx()</CODE> after running <CODE>HBMCreate()</CODE> and before running <CODE>HBMInit()</CODE>. 111<li>The buffer secured by <CODE>HBMCreateEx()</CODE> is released by <CODE>HBMDelete()</CODE> or <CODE>HBMCreateEx()</CODE>. 112<li>The <CODE>HBMDeleteEx()</CODE> function releases only the items added by the <CODE>HBMCreateEx()</CODE> function. Use them as required by an application. 113<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. 114<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. 115</ul> 116<a id="intro_4" name="intro_4"></a> 117<h2>Sample Demos</h2> 118<ul> 119<li>networkmanual_tpl<br>The data in the TPL file below is displayed as the WiiWare Operations Guide. The background is transparent.<br><br> $RVL_SDK/dvddata/hbmdemo/sample.tpl (302 KB)<br><br> 120<li>networkmanual_jpeg<br>Using the JPEG library, the JPEG files below are displayed as the WiiWare Operations Guide. The background is not transparent.<br><br> $RVL_SDK/dvddata/hbmdemo/sample.jpg (125 KB)<br> $RVL_SDK/dvddata/hbmdemo/s_sample.jpg (12 KB) 121</ul> 122<br> <a id="contents" name="contents"></a> 123<h4>Shared contents data</h4> 124<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> 125<h2>Data inside HomeButton.arc</h2> 126<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> 127<ul> 128 <li>config.txt : The button settings file 129 <li>homeBtnIcon.tpl : The Home Menu disabled icon 130 <li>Huf8_SpeakerSe.arc : Wii Remote speaker data 131 <li>LZ77_homeBtn.arc : Japanese layout data 132 <li>LZ77_homeBtn_ENG.arc : English layout data 133 <li>LZ77_homeBtn_FRA.arc : French layout data 134 <li>LZ77_homeBtn_GER.arc : German layout data 135 <li>LZ77_homeBtn_ITA.arc : Italian layout data 136 <li>LZ77_homeBtn_NED.arc : Dutch layout data 137 <li>LZ77_homeBtn_SPA.arc : Spanish layout data 138</ul> 139<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> 140<ul> 141<li>home.csv : Dialog message. (Instead of this, directly incorporate <CODE>$RVL_SDK/dvddata/hbm/HomeButton*/home.csv</CODE> into your application.) 142<li>home_nosave.csv : Dialog message. (Instead of this, directly incorporate <CODE>$RVL_SDK/dvddata/hbm/HomeButton*/home_nosave.csv</CODE> into your application.) 143<li>Huf8_HomeButtonSe.arc : The HOME Menu sound data.(Instead of this, use the files in <CODE>$RVL_SDK/data/cnt/HomeButtonSe.arc</CODE>. 144</ul> 145<p>Use <CODE>HomeButtonCHN.arc</CODE> and <CODE>HomeButtonKOR.arc</CODE> exclusively.</p> 146<h2>Data Inside HomeButtonCHN.arc</h2> 147<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> 148<ul> 149<li>config.txt : The button settings file 150<li>homeBtnIcon.tpl : The Home Menu disabled icon 151<li>Huf8_SpeakerSe.arc : Wii Remote speaker data 152<li>LZ77_homeBtn_CHN.arc : Chinese layout data 153</ul> 154<p>Please use <CODE>HomeButton.arc</CODE> and <CODE>HomeButtonKOR.arc</CODE> exclusively.</p> 155<h2>Data inside HomeButtonKOR.arc</h2> 156<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> 157<ul> 158<li>config.txt : The button settings file 159<li>homeBtnIcon.tpl : The Home Menu disabled icon 160<li>Huf8_SpeakerSe.arc : Wii Remote speaker data 161<li>LZ77_homeBtn_KOR.arc : Korean layout data 162</ul> 163<p>Use <CODE>HomeButton.arc</CODE> and <CODE>HomeButtonCHN.arc</CODE> exclusively.</p> 164<h2>Data Inside HomeButtonSe.arc</h2> 165<p>This contains the HOME Menu sound data.<br>The data is located under the <CODE>HomeButtonSe</CODE> directory.</p> 166<ul> 167<li>Huf8_HomeButtonSe.arc : The HOME Menu sound data 168</ul> 169<h2>Data Inside HomeButton_nwm.arc</h2> 170<p>This contains the layout data for WiiWare in each language.<br>The data is located under the <CODE>HomeButton3</CODE> directory.</p> 171<ul> 172 <li>LZ77_homeBtn_nwm_jpn.arc : Japanese layout data for WiiWare 173 <li>LZ77_homeBtn_nwm_eng.arc : English layout data for WiiWare 174 <li>LZ77_homeBtn_nwm_fra.arc : French layout data for WiiWare 175 <li>LZ77_homeBtn_nwm_ger.arc : German layout data for WiiWare 176 <li>LZ77_homeBtn_nwm_ita.arc : Italian layout data for WiiWare 177 <li>LZ77_homeBtn_nwm_ned.arc : Dutch layout data for WiiWare 178 <li>LZ77_homeBtn_nwm_spa.arc : Spanish layout data for WiiWare 179</ul> 180<h2>Revision History</h2> 181<dl class="history"> 182<DT>2008/04/28<DD>Added mention of the dialog message to <STRONG>How to Use</STRONG>. 183 <dt>2008/02/01 184<dd>Initial version. 185</dl> 186<hr><p>CONFIDENTIAL</p></body> 187</html>
