HBM Revision History

Updates in Version 4.7.3 (2010/07/30)

• Fixed a bug where WPADSetSimpleSyncCallback was set to an indeterminate value if HBMDelete was run without calling HBMInit after HBMCreate.
• Included the network.csv file that was revised in the HOME Menu Library Message Resource Patch (version 2010/07/02). Corrected line breaks at inappropriate locations in the French language version.

Updates in Version 4.7.2 (2010/05/19)

• Fixed a bug where the program would hang if the user pressed the Wii console's Reset button during the HOME Menu exit animation.
• Fixed a bug where the user-defined WPADSetSimpleSyncCallback was sometimes overwritten.

Updates in Version 4.7.1 (2010/02/24)

• Fixed a bug that caused execution to stop on assert at the next call to HBMInit if homebuttonLib.vcmv[D].a and reset did not use the OSRestart function.

Updates in Version 4.7 (2009/12/10)

• Revolution SDK 3.3 is now supported.
• Fixed bug after HBMDelete where remote callback references deallocated memory.
• Fixed problem in HBMInit where a warning was set to be displayed when using the WPAD callback setting function, even when the KPAD library is not used.
• Adjusted issue where gaps were sometimes visible in layout due to projection settings.
• The function reference has been revised.

Updates in Version 4.6 patch 1 (2009/06/03, unreleased)

• Fixed bug where dialog box character text size in homebuttonLib.nwm[D].a did not match that for homebuttonLib[D].a.
• Revised WhomebuttonLib.nwm[D].a to support Korean.
  Note: Added Korean-language content (HomeButton_nwmKOR.arc) to WiiWare Operations Guide.
  Note: network.csv has changed.

Updates in Version 4.6 (2009/02/12)

• Corrected a problem that occurred when resetting during the simple pairing process, where ending on HBMDelete after calling HBMStartBlackOut but without blacking out the screen would cause an assert.
• Corrected a problem where the program would freeze when the callback was called during execution of the AXRegisterCallback function during HBMCreateSound.
• Corrected a problem where Wii Remote images were displayed in the library operations guide when using the WiiWare-version homebuttonLib.nwm[D].a.
• Added HBMMSG_NOSAVE_DEFAULT to the HBMMSG_XXX constants. For details, see the HBMMSG_XXX enumerator in the Function Reference.
• Revised the sample demos.
  all: Corrected Wii Remote processing.
  hbm, rsodemo, sharddemo: Corrected mistakes in screen settings.
• Revised the Function Reference.
  Note: Deleted the Implementation Notes page because that information was covered in the Wii Programming Guidelines.

Updates in Version 4.5 (2008/09/24)

• A problem has been corrected where a WPADSetConnectCallback warning appeared on the screen if the KPAD library and HOME Button Menu are used together in a Revolution SDK 3.2 or later environment.^{See Note}※
• A problem has been corrected where a finger cursor was momentarily displayed in the middle of the screen when starting the HOME Button Menu.
• Revised the sample demo.
  All: Wii Remote processing has been changed in accordance with changes to the KPAD library under Revolution SDK 3.2.^※
  all: A problem with the method of using VIGetTvFormat has been corrected.
  rsodemo: The demo has been revised because default instruction code execution in MEM2 was prohibited under Revolution SDK 3.2.
  networkmanual_tpl, networkmanual_jpg: Comments have been added and processing revised to make the use of messageFlag, which adjusts the WiiWare manual button messages, easier to understand.
• The function reference has been revised.

Note: These revisions are not included in the HBM Library for Revolution SDK 3.1 version.

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 the HOME button 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 common 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)

• The size of HBM_MEM_SIZE_DVD, HBM_MEM_SIZE_MEMORY, and HBM_MEM_SIZE_NAND, increased in the previous version, have been reduced to the minimum size that can be currently executed under 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.
• The following shared content files have been replaced as a result of reviewing the content of messages when performing simple pairing of Wii Remotes.
  - homebutton/dvddata/HomeButton2/home.csv
- homebutton/dvddata/HomeButton2/home_nosave.csv
- homebutton/dvddata/HomeButton3/home.csv
- homebutton/dvddata/HomeButton3/home_nosave.csv

  Always be sure to update resource files used by each application.
  Of the files listed above, do not use those included in the common content for data/cnt/HomeButton.arc and NAND as they 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 button configuration data (config.txt) 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 had always been enabled even in applications that do not support the Classic Controller.
  This problem has been corrected.
• There were instances of the system hanging 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 the 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, a portion of the loaded resource data was being overwritten and changed. This was fixed. (It not necessary to reload resource data when HBMCreate is executed subsequent times.)
• There was a part of the homebutton sample with a memory leak. It was fixed.

Updates in Version 2.5 (2006/12/25)

• The build environment for the HOME Button Menu library has been ported to Revolution SDK 2.4 and NintendoWare for Revolution 061030.
• Version information can now be embedded in the library. When the application starts, the console screen displays information for the HBM library.
• Depending on the screen mode of the application, the top and bottom portions of the screen were not rendered correctly, because only 456 lines were rendered for the HOME Menu.
  This problem has been corrected.
• Rumble of the Wii Remote is now forcibly terminated in the HBMStartBlackOut function.
• In some cases, running Reconnect caused the connected Wii Remote to 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.
• In addition to animation playback speed, frameDelta settings are now reflected on fade effects and various timers.
• 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 a bug that prevented fadeout processing from processing normally when the culling mode was GX_CULL_BACK.
• Fixed a bug that caused the upper screen HOME Menu bar to be shown as selected (blue in color) after certain operations, even though it was not selected.
• Fixed a bug that occasionally prevented the Wii console from returning from the Reconnect screen after certain operations.
• Fixed the following bug: in the Reconnect screen, the Wii Remote speaker would not play the connection sound at the correct time when homebuttonMiniLib.a was used.

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)

• Fixed a bug that prevented reconnecting animation from stopping when the animation playback speed was changed.

* 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.
• Changed the function called when Reconnect is selected (from WPADStartSimpleSync to WPADStartFastSimpleSync).
• Revised the convention of using MEM2 for a variable, function argument, and buffer names for sound.
• Expanded functions, definitions, variables, etc., to support use of online manuals.
  In addition, included a built library for online manuals in the package.
• Updated the sound resource data.
• Included screen layouts and sound resources in the package in shared content format. (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 caused the Wii Remote Rumble feature to occasionally continue to vibrate for a few seconds when Reconnect was selected.
• Fixed a bug that caused the system state to become illegal when a battery was pulled at the same time that Reconnect was selected.
• Fixed a bug that caused the frame of the Close button to occasionally blink red when the HOME Menu was opened and then immediately closed.
• A bug has been corrected where the HOME Button Menu would occasionally close if a normally paired remote controller was reconnected while the HOME Button Menu was open.
• Fixed a bug that caused an occasional freeze when RESET on the console was pressed immediately after the HOME Menu started up.

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 of more than one Wii Remote overlap, the one 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.
• With the introduction of sound_callback, related implementations have been deleted because event_callback has become unnecessary.
• Fixed a bug that caused a letter icon to be displayed, depending on the condition of memory, even though no message had been received.
• Fixed a bug that prevented return to the previous screen when four Wii Remotes were connected and Reconnect was selected.
• Fixed a bug that caused the system to freeze when HBMStartBlackOut was called immediately after the HOME Menu had 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 switches for completely separating sound processing from homebuttonMiniLib. Remove USE_NW4R_SOUND, defined in homebutton/include/HBMConfig.h, as necessary.
  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.
  - Retry restart every 100 ms if simple pairing fails to start.
• Changed the timing for sending audio data to the speaker so that it is adjusted using WPADCanSendStreamData.
• 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, exit Reconnect and return to Wii Remote Settings if there is any key input from an already-connected Wii Remote.
  - However, key input is ignored for the first three seconds.
  - Retry restart every 100 ms if simple pairing fails to start.
• Fixed a bug for the allocator in the layout library added in the 2006/09/15 version.
• Sometimes the "HOME Menu" bar on top of the screen would flash red when exiting the HOME Button Menu. This has been corrected.
• Fixed a bug that reversed Spanish and Italian text resources.
• 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.
• Made the memory allocator of the NW4R layout library specifiable (this is used inside homebuttonMiniLib).
  Set for both HBMDataInfo.pAllocator when you want to use a particular allocator and for HBMDataInfo.mem when you want to use memory allocated by the application.
  The allocator set for nw4r::lyt is used when neither of these has been set (NULL).
• A problem that caused incorrect initialization of alarms when using the Wii Remote speaker has been corrected.