=========================================================================== Nintendo Revolution SDK 3.3 + patch 2 build with CodeWarrior for Wii 1.0 August 23, 2010 =========================================================================== Table of Contents - Introduction - About the Firmware - Precautions - License Information - Voice Chat Icon - Revision History - System Requirements - Installation Procedure - Known Bugs - Documents to Read After this Document ======================================================================= Introduction ======================================================================= This package contains Revolution SDK 3.3 with patch 2 applied, and supports CodeWarrior for Wii 1.0. The Revolution SDK contains libraries, tools, and documents required to develop Wii applications. It also includes the source code for many demo programs that you can build and run to test different functionality. This version of the SDK has changed significantly from the previous version. There is no longer full compatibility for modules built with earlier versions of the SDK. For details about what has changed, read man/en_US/ReleaseNote.html. (Note: "Revolution" is the codename for Wii.) ======================================================================= About the Firmware ======================================================================= Starting with SDK version 3.3, the Extended Firmware is now integrated with the Standard Firmware. All titles using SDK 3.3 use the following version of the firmware. Firmware used by SDK 3.3 titles: 56.21.29 ======================================================================= Precautions ======================================================================= ----------------------------------------------------------------------- About the Guidelines ----------------------------------------------------------------------- There are guidelines that must be adhered to when using this package. Please see the following documents for more information about these guidelines. Guidelines that must be reviewed - Wii and Wii peripherals Wii Programming Guidelines (and the Wii Message List) - Strap Usage Screen (including for Wii Motion Plus), Wii Zapper Use Screen Strap Usage Screen Manual (/docs/en_US/Guidelines/Wii_Strap_Zapper_Reminder.pdf) - Banners Wii Programming Guidelines - Logos Shown on Channel Preview Screen - Guidelines that must be reviewed if using those features - Disc Spin-Off Channel (DISCNAND) Wii Programming Guidelines - Disc Spin-Off Channel (Also the Disc Spin-Off Channel chapter in the Wii Message List) - Wii Speak (PMIC) Wii Speak Programming Guidelines The following guidelines must also be reviewed if using Voice Chat Voice Chat Icon Specifications (/docs/en_US/PMIC_Library_Guide/WiiSpeak_VoiceChatIcon.pdf) Icon Data (/docs/en_US/PMIC_Library_Guide/texture/) - Wii MotionPlus (KPAD) Wii MotionPlus Programming Guidelines ----------------------------------------------------------------------- The libraries included in this SDK are all static modules ----------------------------------------------------------------------- The libraries included in the Revolution SDK are all static modules. There are no relocatable modules. They cannot be made into relocatable modules. ----------------------------------------------------------------------- There is no difference in behavior between the *.exe and *D.exe versions of programs inside the X86 folder ----------------------------------------------------------------------- Some of the programs located inside the X86 folder exist in two versions (*.exe and *D.exe). For example, both "makeo.exe" and "makeoD.exe" are in the folder. There is no difference between the two programs. The *D.exe version remains in order to maintain compatibility with past systems. ----------------------------------------------------------------------- Running in the Wii Menu ----------------------------------------------------------------------- Programs created using this SDK are compatible with the following version (or later) of the Wii Menu. * Wii Menu 3.0 Abnormal behavior may occur in systems running earlier versions. ======================================================================= License Information ======================================================================= - The following files are found in this SDK: /dvddata/axdemo/synth/GM16.DLS : Roland DLS file /dvddata/axdemo/synth/gm16adpcm.pcm : GM16.DLS converted for use with the Wii (audio source file, ADPCM version) /dvddata/axdemo/synth/gm16adpcm.wt : GM16.DLS converted for use with the Wii (table file, ADPCM version) /dvddata/axdemo/synth/gm16pcm.pcm : GM16.DLS converted for use with the Wii (audio source file, PCM version) /dvddata/axdemo/synth/gm16pcm.wt : GM16.DLS converted for use with the Wii (table file, PCM version) To use all or part of the data from an application, you must comply with the Roland end-user license agreement. The end-user license agreement is found in the following directory. /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf Contact information may be found in the following file. /docs/en_US/License/Roland/Roland_contact_info.txt Please read this agreement before using the data. - The audio library of this SDK supports Dolby Surround and Dolby Pro Logic II. To use these features in a game, you must have a license agreement with Dolby. Please read the following file before using these features. /docs/en_US/License/Dolby/DPL2_for_Wii.pdf The JPEG Codec Library in this SDK can be used only for the purpose of encoding and decoding data provided by application developers and operators. But note there is no guarantee that all JPEG files can be decoded. Encoding and decoding of data other than that prepared by the application developer or operator (such as that of an end user) is prohibited. Encoding and decoding of data whose source or pathway cannot be guaranteed is also prohibited. Furthermore, the activities defined below are prohibited, even if the purpose is as described above. (1) Reverse assembling, decompiling, reverse engineering, altering, or tampering of the library included in this package in whole or in part. (2) Assigning, loaning, distributing, disclosing of this package in whole or in part, and re-licensing, offering as collateral and transferring the ownership of this package in whole or in part to a third party. (3) Converting, revising, modifying, and reorganizing this package in whole or in part to create a new middleware product. (4) Using this package in whole or in part to develop, manufacture, or sell any software program that resembles this package, that provides similar functions, or that can be used in place of this package. (5) Using this package in whole or in part to develop any products that have the same intended purpose or value as this package. ======================================================================= Revision History ======================================================================= For the revision history of this release, see /man/en_US/ReleaseNote.html. ======================================================================= System Requirements ======================================================================= See RVL_QuickStartGuide.pdf, provided separately, for details on system requirements for the Revolution SDK. Three USB ports are required to connect to a PC. (Although two ports are specified in some manuals, three USB ports are now required.) This version of the SDK only supports the commercial release versions of NDEV. Whenever possible, use the NDEV software package version 071002 or later. ======================================================================= Installation Procedure ======================================================================= First, expand this SDK package without overwriting other versions of the SDK. Next, install the firmware (56.21.29). 1. Unpack the package in any directory (see note below) and specify the path to RVL_SDK/ using the environment variable REVOLUTION_SDK_ROOT. To use the startup batch file (RVL_NDEV.bat) included in the SDK, be sure to edit the location in the batch file where the environment variable is specified. (See the example below.) REM ************************************************************ REM * REM * Please specify your installation paths here: REM * REM ************************************************************ SET REVOLUTION_SDK_ROOT=C:\RVL_SDK 2. Before executing any sample demos or other executable programs, be absolutely certain to update the NDEV firmware according to the following procedure.~~~~~~~~~~~~~~~~~~ In a typical environment, start the update program by launching the bash shell and entering and executing [fwupdate_56.21.29_xx]. (For xx, enter jp, us, eu, kr, or cn) If the environment is customized or if things do not go smoothly using the method just described, from the RVL_SDK/RVL/bin/tools directory, execute ODEM -r -l swupdate_56.21.29_xx.gcm . (For xx, enter jp, us, eu, kr, or cn.) Once the update is complete, "SWUpdate Successful" appears on the screen. The NDEV firmware is updated to Firmware 56.21.29 and DEVKIT BOOT PROGRAM v1.22A. If the versions already installed are more recent than these versions, the message "Import: *** ...failed" will display, and the update process will fail. However, this is not a problem, and you can continue. Note: If you are running this SDK on Windows Vista, you need to unpack the SDK package below the User Account folder (C:\Users\). For more information, see the Quick Start document, RVL_QuickStartGuide_3-3.pdf, which is provided separately from the SDK package. ======================================================================= Currently Known Bugs ======================================================================= Read about this in the Revolution SDK Technical Information section of /man/en_US/index.html. ======================================================================= Documents to Read After This Document ======================================================================= There are several documents we would like you to look at after reading this document. They can be found in the Revolution SDK. - Revolution SDK Roadmap (docs/en_US/Quickstart/RVL-SDK-RoadMap.pdf) This document explains the layout of the Revolution SDK. - Document Roadmap (docs/en_US/Quickstart/RVL-SDK-DocumentMap.pdf) This document explains the various documents contained in the Revolution SDK.