HBM Revision History

Updates in Version 4.4 (2008/06/17)

• 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.
• Introduced countermeasures in homebuttonLib.vcmv[D].a against multiple initializations of sound threads when a delete function was not called.

Updates in Version 4.3 (2008/04/28)

• Changed the animation shown when the screen switches to the WiiWare Operations Guide.
• Corrected a bug that introduced noise to the Wii Remote's connection sound.
• Revised the sample program to also run on SDKs with the WBC library patch applied.
• The function reference has been revised.

Updates in Version 4.2 (2008/02/27)

• Fixed a bug where the shape of buttons in the WiiWare Operation Guide differed from their actual appearance.
• Corrected a problem with initialization of the homebuttonLib.nwm[D].a library.
• Changed the screen layouts for Chinese and Korean languages and updated shared content.
• Added a function for clearing the texture matrix to the sample.

Updates in Version 4.1.1 (2008/02/13)

• Fixed the problem where RVL_SDK/data/hbm/cnt/HomeButton_nwm.arc in Version 4.1 was substituted with older shared content data (from Version 4.0).
  The demo directory contained the correct HomeButton_nwm.arc in Version 4.1.
• Made revisions to the manual.

NOTE: The library was not changed in this revision.

Updates in Version 4.1 (2008/02/07)

• Added the Rumble Feature and sound to buttons in the WiiWare Operations Guide.
• Fixed a problem in the WiiWare Operations Guide that prevented animations in the upper area from lighting up.
• Fixed a problem in the WiiWare Operations Guide that caused layouts to be corrupted after RESET was pressed.
• Added HBMMSG_NOSAVE_ALL to HBMMSG_XXX enumerators.
• Made revisions to the manual.

Updates in Version 4.0.1 (2008/02/04)

• Updated the WiiWare shared data.

Updates in Version 4.0 (2008/02/01)

• Added support for Chinese language and Korean language country codes.
• Published the WiiWare libraries (homebuttonLib.nwm.a and homebuttonLib.nwmD.a).
• Updated the message resource files (home.csv and home_nosave.csv). Replace this data when updating to version 4.0 or later of the library.
• Added samples and made revisions.
  - Added settings in Chinese and Korean languages to shareddemo. To check this, set LANG_CHN and LANG_KOR as compile options.
  Deleted dvddata.zip. In its place, use content_data.zip (explained below).
  - Added networkmanual_tpl. This is a sample that displays a simple manual in TPL.
  - Added networkmanual_jpeg. This is a sample that displays a simple manual in JPEG.
• Prepared data/hbm/content_data.zip so the sample can be executed as a disc application from files in dvddata.
• Corrected a bug which turned Wii Remote sound OFF upon exit from HOME Menu.
  Note: If Wii Remote sound is not necessary after existing from HOME Menu, turn it off.
• Corrected a bug which occurred when KPADRead repeatedly returned WPAD_ERR_CORRUPTED.
• Made revisions to the manual.

Updates in Version 3.3 (2007/11/26)

• Made it possible to define the size of the sound thread stack as HBM_SND_THREAD_STACK_SIZE. Doing so increases the size of the library's HBM_MEM_SIZE_SOUND work memory.
• Corrected the lack of support for monaural in the console settings.
• Added support for special devices that connect to specific IDs.
• Added a process to the demo for cases when KPADRead returns 0.
• Made revisions to the manual.

Updates in Version 3.2 (2007/10/04)

• The HomebuttonSe.arc data in shareddemo did not include the Ver.3.0 sounds for VCMV, so it was replaced.
• Corrected an error in the makefile for shareddemo.
  *The content file specification for makeWad was incorrect, so unnecessary data was created in the shared content when a Wad file was created with that setting.

Updates in Version 3.2 (2007/10/02)

• Fixed a bug that caused the Wii Remote connection sounds and vibrations to persist when the HOME Menu was exited and then re-displayed.
• When HOME was activated during simple pairing, the process would get stuck on reconnection. That bug has been fixed.
• Added content data for the running of disc applications to shareddemo.
• Made revisions to the manual.

Updates in Version 3.1 (2007/09/03)

• Removed the library source from public availability.
• Discontinued support for sound playback by the library itself. Accordingly, the manual_sound sample has been removed.
• Fixed a bug which, depending on the compilation environment, caused a value of zero to be passed to std::log10 in the SetVolumeAllSeq function.
• Removed GXSetCullMode (GX_CULL_NONE) called by the setAdjustFlag function because it is not necessary.
• When redundant calls were made to MIXInit() the volume-changing feature would not operate properly. To fix this problem, the specification has been changed so MIXInit() is not called inside the HBM library.
• Added text to the manual about the sound-fade process when entering the HOME Menu, noting that the fade process for effects should also finish by the time the sound-fade process has finished.

Updates in Version 3.0.1 (2007/07/18)

• Sound data for VCMV was not included in the common sound resource (HomeButtonSe.arc) so the files were updated.
• The shareddemo sample was revised because it was referencing now-prohibited CSV files in the common resource.
• The samples hbm, manual_sound and shareddemo were revised because they were calling the HBMDelete and HBMDeleteSound functions for memory that had been deallocated.

Updates in Version 3.0 (2007/07/10)

• Changed the package structure to comply with the SDK instead of NW4R. Accordingly, homebuttonMini was removed.
• The common sound resource was changed from being a NW4R archive (HomeButtonSe.brsar) to being a standard archive (HomeButtonSe.arc).
• Added the demo rsodemo, which uses the RSO library to dynamically load the HBM library.
• Added the demo shareddemo, which uses the shared content in NAND.
• Changed the fade-out feature of the HBMSetBlackOutColor function so it only affects resets.
• Added the HBMSetVIBlack function.
• Removed the HBMCreateDvdSound, HBMCreateMemorySound and HBMCreateNandSound functions and combined them into HBMCreateSound.
• Corrected a bug that prevented the callback set by WPADSetExtensionCallback from being saved and reconfigured.
• Revised the GX settings of the HBMDraw function.

Updates in Version 2.8.1 (2007/05/08)

• In the previous version, the sizes of HBM_MEM_SIZE_DVD, HBM_MEM_SIZE_MEMORY, and HBM_MEM_SIZE_NAND were increased. In this update, they have been reduced to the minimum size that can be currently executed in NintendoWare. There is no guarantee of margin anticipated in future releases of NintendoWare, so take note when NintendoWare is updated.

Updates in Version 2.8 (2007/04/28)

• Changed the HOME Menu library build environment to Revolution SDK 2.4 Patch 4 and NintendoWare Revolution 070316.
• GXSetCullMode is now set for each rendering.
• Increased the sizes of HBM_MEM_SIZE_DVD, HBM_MEM_SIZE_MEMORY and HBM_MEM_SIZE_NAND to match the NintendoWare sound library.

Updates in Version 2.7 (2007/03/23)

• Changed the HOME Menu library build environment to Revolution SDK 2.4 Patch 3 and NintendoWare for Revolution 070316.
• Because the content of messages generated during simple pairing of Wii Remotes has been revamped, the following shared resource files have been replaced:
  
  - homebutton/dvddata/HomeButton2/home.csv
  - homebutton/dvddata/HomeButton2/home_nosave.csv
  - homebutton/dvddata/HomeButton3/home.csv
  - homebutton/dvddata/HomeButton3/home_nosave.csv
  
  You must also update the resource files used by each application.
  Do not use the files from this list that are included in data/cnt/HomeButton.arc and in the shared content of NAND, because hey have not been updated. (Instead, separately load the files that have been updated.)
• Added the member configBufSize to the HBMDataInfo structure.
  Specify the file size of config.txt, which is the file with the button configuration data for the HOME Menu.
• rsodemo was temporarily deleted from the demos because of the discovery of a number of fatal problems.

Updates in Version 2.6 (2007/02/05)

• The Home Button of the Classic Controller was always enabled, even in applications that do not support the Classic Controller.
  This problem has been corrected.
• Sometimes the system would hang if the HBMStartBlackOut function was called consecutively.
  This problem has been corrected.
• Added a sample demo supporting relocatable modules.
• Added screen settings supporting PAL mode to all the sample demos.
• Revised [HBM Library Overview] in the function reference and added a general implementation method during I/O. Refer to this document to see the list of functions that should be called when starting the HOME Menu and the functions that should be reset upon exiting.
• During execution of HBMCreate, some of the loaded resource data were overwritten or changed. That has been corrected. (It not necessary to reload resource data when HBMCreate is executed subsequent times.)
• There was place with a memory leak in the homebutton sample. This was fixed.

Updates in Version 2.5 (2006/12/25)

• Changed the build environment for the HOME Menu library to Revolution SDK 2.4 and NintendoWare for Revolution 061030.
• Version information can now be embedded in the library. When an application starts, the console screen displays various information as the library [HBM].
• Because only 456 lines were rendered for the HOME Menu, the top and bottom portions of the screen were not rendered correctly sometimes, depending on the screen mode of the application.
  This problem has been corrected.
• Rumble of the Wii Remote is now forcibly terminated in the HBMStartBlackOut function.
• Under certain conditions, when [Reconnect] was executed the connected Wii Remote would continue to rumble for longer than intended.
  This problem has been corrected.
• Certain matrix computations made use of uninitialized variables, and as a result sometimes illegal behaviors would occur, depending on the memory status.
  This problem has been corrected.
• The following revisions were made to the sample demos:
  - Added quit / reset processes.
  - Added support for the Classic Controller
  - Added a sound process
  - Enabled KPAD coordinate correction
  - Output simple operating instructions to the console
• Sound is now controlled directly from AX in the build/demos/homebutton/homebutton demo (whereas before NW4R was used for the demo sound control).
• Revised the outdated text about sound control in the [HBM Library Overview] section of the Function Reference.

Updates in Version 2.4.x (2006/11/21)

• The fix in version 2.2.x for the bug that occasionally prevented the Wii console from returning from the Reconnect screen was incomplete. This has been reexamined and corrected.
• When used with certain libraries, the system sometimes froze when sound processing was called from multiple threads simultaneously.
  This problem has been corrected.
• The frameDelta settings are now reflected in fade effects and various timers, in addition to the animation playback speed.
• When HBMMSG_NOSAVE_WIIMENU or HBMMSG_NOSAVE_RESET was specified for the messageFlag member of the HBMDataInfo structure, the "Do not confirm save" message was not displayed correctly in German or Dutch languages. This problem has been corrected.

Updates in Version 2.3.x (2006/11/11)

• Fixed the bug that prevented fadeout from processing normally when the culling mode was GX_CULL_BACK.
• Fixed the bug that caused the HOME Menu bar in the upper screen to be shown in blue (as if selected) after certain operations, even though it was not selected.
• Fixed the bug that occasionally prevented the Wii console from returning from the Reconnect screen after certain operations.
• When homebuttonMiniLib.a was used, the Wii Remote speaker would not play the connection sound at the correct time in the Reconnect screen. That bug has been fixed.

Updates in Version 2.2.x (2006/11/06)

• Fixed a bug that caused WPAD callbacks to stop on ASSERT if issued after quitting the HOME Menu.

Updates in Version 2.1.x (2006/11/02)

• When the animation playback speed was changed the Reconnect animation would not stop. That bug has been fixed.

* Officially renamed the 061004 stable version as Ver.1.0.0 and the 061023 expanded features version as Ver.2.0.0.

Updates in Version 061023

• During the termination process, Alarm would not be deallocated. This bug has been fixed.
• Enabled separate selection of warning messages about saving when [To Wii Menu] and [Reset] buttons are pressed.
• When Reconnect is selected, the WPADStartFastSimpleSync function is now called (instead of the WPADStartSimpleSync function).
• Revised the convention of using "MEM2" in sound-related variable names, function argument names and buffer names.
• Expanded functions, definitions and variables to support the use of online manuals. In addition, included a build library for online manuals in the package.
• Updated the sound resource data.
• Included screen layouts and sound resources in shared content format in the package. (homebutton/data/cnt/HomeButton.arc)

Updates in Version 061004

• Fixed a bug that occasionally froze the system when RESET on the console was pressed immediately after [Reconnect] was selected.
• Updated the implementation specifications.

Updates in Version 061001

• Updated the screen layout and sound resource data.
• Fixed a bug that on rare occasions caused the Wii Remote to continue to rumble for a few seconds when [Reconnect] was selected.
• Fixed a bug that on rare occasions caused an illegal system state when the battery was removed at the same time [Reconnect] was selected.
• Fixed a bug that on rare occasions caused the frame of the Close button to blink red when the HOME Menu was opened and then immediately closed.
• Fixed a bug that on rare occasions closed the HOME Menu if it was open when a registered Wii Remote was reconnected.
• Fixed a bug that on rare occasions caused the system to freeze when RESET on the console was pressed immediately after the HOME button was started.

Updates in Version 060930

• Added support for Revolution SDK 2.2 Patch 6.

Updates in Version 060929

• Added support for Revolution SDK 2.2 Patch 5.
• The Wii Remote now rumbles when the cursor hovers over an item on the HOME Menu.
• If the cursors from multiple Wii Remotes overlap on the screen, the Wii Remote with the lowest number is now displayed on top.
• Updated the screen layout resource data.
• Fixed a bug that caused the cursor to momentarily disappear when starting the HOME Menu.

Updates in Version 060928

• Added support for Revolution SDK 2.2 Patch 4.
• The amount of memory allocated when using HBMCreateMemorySound has been reduced to 100 KB.
• Updated the screen layout and sound resource data.
• Now that sound_callback has been introduced, event_callback has become unnecessary so related implementations have been deleted.
• Fixed a bug that, depending on the condition of memory, caused the mail 'letter' icon to be displayed even though no message had been received.
• Fixed a bug that prevented return to the previous screen when four Wii Remotes were attached and [Reconnect] was selected.
• Fixed a bug that caused the system to freeze when HBMStartBlackOut was called immediately after the HOME Menu was started.
• Created an Overview page for the Function Reference that includes implementation-related information.
• Updated the implementation specifications.

Updates in Version 060925

• Added support for Revolution SDK 2.2 Patch 2.
• Created a switch for completely separating the sound processing from homebuttonMiniLib. If necessary, remove the USE_NW4R_SOUND definition from homebutton/include/HBMConfig.h.
  Since sound_callback is now called at the time of every sound process, be sure to implement sound processes that are suitable for your situations.
• Further changed the specifications for simple pairing when [Reconnect] is selected:
  - Simple pairing is accepted for 60 seconds after [Reconnect] is selected.
  - Simple pairing is canceled as soon as there is key input from a connected controller or four Wii Remotes have been connected.
  - If simple pairing fails to start for any reason, the task is retried every 100 ms.
• WPADCanSendStreamData is now used to adjust the timing for sending audio data to the speaker.
• Updated the sound data.
• Updated [HOME Menu Implementation Specifications].
• Made other miscellaneous changes and bug fixes.

Updates in Version 060919

• Changed the specifications for simple pairing when [Reconnect] is selected:
  - Simple pairing is accepted for the 10 seconds since the last connection.
  - During this time, the process will quit Reconnect and return to the Wii Remote Settings if there is key input from any connected Wii Remote.
  - However, key input is ignored for the first three seconds.
  - If simple pairing fails to start for any reason, the task is retried every 100 ms.
• Corrected a problem with the allocator in the layout library added in Version 060915.
• Corrected a problem that caused the HOME Menu bar at the top of the screen to occasionally flash red when exiting from the HOME Menu.
• The Spanish and Italian text resources were reversed. This has been corrected.
• Changed the term "controller" in English text resources to "Wii Remote."

Updates in Version 060915

• Replaced the layout data.
• Added a callback to be called when fadeout starts. What gets called is the callback specified by the HBMEV_BEGIN_BLACKOUT argument.
• Added the HBMSetBlackOutColor function for changing the screen color during fadeout.
• It is now possible to specify the memory allocator of the NW4R layout library used inside homebuttonMiniLib. If you want to use a specific allocator, set it to HBMDataInfo.pAllocator. If you want to use the memory allocated by the application, set it to HBMDataInfo.mem.
  If neither setting is configured (i.e., when set to NULL), the allocator set to nw4r::lyt is used.
• When the Wii Remote speaker was used the alarm would be initialized incorrectly. That problem has been fixed.

CONFIDENTIAL