WiiWare Support Guide

The WiiWare-Compatible HOME Menu

Detailed manuals for WiiWare are available over the network.
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.

Incorporating the WiiWare-Compatible HOME Menu

• What You Need to Prepare
• Incorporating into WiiWare
• Linking the Libraries
• How to Use
• Dialog Box Message Prior to Transitioning to Online Manual
• Sample Demos

What You Need to Prepare

• Image data -- able to fit in one screen -- for the WiiWare Operations Guide (maximum size: 554 × 256 pixels).
  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.
  For details, see Creating Screens for the Operations Guide in the WiiWare Online Manual Guidelines package.
• JPEG codec library (TMCC JPEG, henceforth referred to as the JPEG library).
  Essential only if you will be using JPEG images.

Incorporating Into WiiWare

For basic uses, it is incorporated the same way that the regular HOME Menu is incorporated into applications.

Link the homebuttonLib.nwm[D].a file and embed the shared resource data contained in the data/home/cnt directory into the application's project. (In contrast to regular disc applications, a resource file for simple documents is added.)
Note: The homebuttonLib[D].a library, which is used by disc applications, is not used with WiiWare.

Call HBMCreateEx between the calls to HBMCreate and HBMInit.

• Initializing add-on content every time:
  1. Create an instance with the HBMCreate function.
  2. Create a sound instance with the HBMCreateSound function.
  3. Detect that HOME has been pressed.
  4. Load additional content and set that content to the library using the HBMCreateEx function.
  5. Use the HBMInit function to initialize internal library variables.
  6. Use the HBMDraw function to display the HOME Menu.
  7. Exit the HOME Menu and then delete the additional content settings from the library using the HBMDeleteEx function.To re-display, return to step 3.
  8. When the game ends, use the HBMDelete and HBMDeleteSound functions to release the instances.

     Note: If everything is to be initialized every time, call the HBMDeleteSound and HBMDelete functions in step 7 and then return to step 1. (Step 8 becomes no longer necessary.)

• Making add-on content resident:
  1. Load all resources by initializing the game and other measures.
  2. Create instances with the HBMCreate, HBMCreateEx, and HBMCreateSound functions.
  3. HOME is pressed.
  4. Use the HBMInit function to initialize internal library variables.
  5. Use the HBMDraw function to display the HOME Menu.
  6. Exit from HOME Menu.

     To re-display, return to step 3.

  7. When the game ends, use the HBMDelete and HBMDeleteSound functions to release the instances. Note: The HBMDelete function also frees add-on content, so the HBMDeleteEx function is not necessary.

Linking the Libraries

Before including Revolution/hbm.h, define USE_FOR_NETWORKMANUAL or set the following definition in makefile:

// Define USE_FOR_NETWORKMANUAL
CCFLAGS += -DUSE_FOR_NETWORKMANUAL

For makefile, refer to the networkmanual_jpeg demo if using a JPEG image; otherwise, refer to the networkmanual demo.
Note: If you are using the conventional library (homebuttonLib[D].a) remove the link.

// Link to homebuttonLib.nwm.a instead of homebuttonLib.a
REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/homebuttonLib.nwm$(LIBSUFFIX)

// Not necessary if NOT using the JPEG library
REVOLUTION_LIBS += $(INSTALL_ROOT)/lib/libTMCC_JPEG.a

How to Use

• Be sure to execute HBMCreateEx after running HBMCreate and before running HBMInit.
• The buffer secured by the HBMCreateEx function is released by the HBMDelete or HBMDeleteEx function.
• The HBMDeleteEx function releases only the items added by the HBMCreateEx function. Use them as required by an application.
• Using HBMDataInfo's messageFlag, you can change the dialog message's save data warning shown when the View Detailed Instructions button is pressed.
• If the HOME Menu quits because the player has pressed the View Detailed Instructions button, HBMGetSelectBtnNum will return the value of 4. If this happens, execute OSLaunchManualViewer and start up the online manual.

Dialog Box Message Prior to Transitioning to Online Manual

When the player opens the Online Manual with the View Detailed Instructions button, a dialog message is displayed before execution transitions to the manual. This message can be changed using the messageFlag member of the HBMCreate function's HBMDataInfo argument.

Note: The messageFlag setting may cause a warning to be displayed even if home_nosave.csv has been loaded in msgBuf.

Sample Demos

• networkmanual_tpl
  The data in the TPL file below is displayed as the WiiWare Operations Guide. The background is transparent.
  
  $RVL_SDK/dvddata/hbmdemo/sample.tpl (302 KB)
  
  
• networkmanual_jpeg
  Using the JPEG library, the JPEG files below are displayed as the WiiWare Operations Guide. The background is not transparent.
  
  $RVL_SDK/dvddata/hbmdemo/sample.jpg (125 KB)
  $RVL_SDK/dvddata/hbmdemo/s_sample.jpg (12 KB)

Shared contents data

The directory structure of the shared contents can be viewed by unzipping data/hbm/contents_data.zip under RVL_SDK.
Verify by comparing against the description given below.

Data inside HomeButton.arc

This contains the layout data for each language, the HOME Menu disabled icon, the Wii Remote speaker data, and the config file.
For each file, data for two-button configuration is in the HomeButton2 directory, and data for three-button configuration is in the HomeButton3 directory.

• config.txt: The button settings file
• homeBtnIcon.tpl: The Home Menu disabled icon
• Huf8_SpeakerSe.arc: Wii Remote speaker data
• LZ77_homeBtn.arc: Japanese layout data
• LZ77_homeBtn_ENG.arc: English layout data
• LZ77_homeBtn_FRA.arc: French layout data
• LZ77_homeBtn_GER.arc: German layout data
• LZ77_homeBtn_ITA.arc: Italian layout data
• LZ77_homeBtn_NED.arc: Dutch layout data
• LZ77_homeBtn_SPA.arc: Spanish layout data

Note that content of the files given below is outdated, and that the use of these files is prohibited at this time.

• home.csv: Dialog messages (instead, embed $RVL_SDK/dvddata/hbm/HomeButton*/home.csv directly in the application)
• home_nosave.csv: Dialog messages (instead, embed $RVL_SDK/dvddata/hbm/HomeButton*/home_nosave.csv directly in the application)
• Huf8_HomeButtonSe.arc: HOME Menu sound data (instead, use the files in $RVL_SDK/data/cnt/HomeButtonSe.arc)

Use of HomeButtonCHN.arc and HomeButtonKOR.arc is mutually exclusive. You cannot use both at the same time.

Data Inside HomeButtonCHN.arc

This contains the layout data for Chinese language, the HOME Menu disabled icon, the Wii Remote speaker data, and the config file.
For each file, data for two-button configuration is in the HomeButton2 directory, and data for three-button configuration is in the HomeButton3 directory.

• config.txt: The button settings file
• homeBtnIcon.tpl: The HOME Menu Prohibited icon
• Huf8_SpeakerSe.arc: Wii Remote speaker data
• LZ77_homeBtn_CHN.arc: Chinese layout data

Use of HomeButton.arc and HomeButtonKOR.arc is mutually exclusive. You cannot use both at the same time.

Data Inside HomeButtonKOR.arc

This contains the layout data for the Korean language, the HOME Menu disabled icon, the Wii Remote speaker data and the config file.
For each file, data for two-button configuration is in the HomeButton2 directory, and data for three-button configuration is in the HomeButton3 directory.

• config.txt: The button settings file
• homeBtnIcon.tpl: The HOME Menu Prohibited icon
• Huf8_SpeakerSe.arc: Wii Remote speaker data
• LZ77_homeBtn_KOR.arc: Korean layout data

Use of HomeButton.arc and HomeButtonCHN.arc is mutually exclusive. You cannot use both at the same time.

Data Inside HomeButtonSe.arc

This contains the HOME Menu sound data.
The data is located under the HomeButtonSe directory.

• Huf8_HomeButtonSe.arc: The HOME Menu sound data

Data Inside HomeButton_nwm.arc

This contains the layout data for WiiWare in each language.
The data is located under the HomeButton3 directory.

• LZ77_homeBtn_nwm_jpn.arc: Japanese layout data for WiiWare
• LZ77_homeBtn_nwm_eng.arc: English layout data for WiiWare
• LZ77_homeBtn_nwm_fra.arc: French layout data for WiiWare
• LZ77_homeBtn_nwm_ger.arc: German layout data for WiiWare
• LZ77_homeBtn_nwm_ita.arc: Italian layout data for WiiWare
• LZ77_homeBtn_nwm_ned.arc: Dutch layout data for WiiWare
• LZ77_homeBtn_nwm_spa.arc: Spanish layout data for WiiWare

Use homeBtn_nwm_kor.arc exclusively.

Data Inside homeBtn_nwm_kor.arc

This contains the layout data for WiiWare in Korean.
The data is located under the HomeButton3 directory.

• LZ77_homeBtn_nwm_kor.arc: Korean layout data for WiiWare

Revision History

2009/11/10

Corrected the explanation in Incorporating Into WiiWare.

Added Korean WiiWare Layout Data.

2009/04/16

Corrected spelling errors.

2009/01/30

Corrected the procedures in Incorporating Into WiiWare.

Added Dialog Box Message Prior to Transitioning to Online Manual.

2008/04/28

Added mention of the dialog message to How to Use.

2008/02/01

Initial version.

CONFIDENTIAL