1===========================================================================
2 Nintendo Revolution SDK 3.3 + patch 2 build with CodeWarrior for Wii 1.0
3      August 23, 2010
4===========================================================================
5
6Table of Contents
7- Introduction
8- About the Firmware
9- Precautions
10- License Information
11- Voice Chat Icon
12- Revision History
13- System Requirements
14- Installation Procedure
15- Known Bugs
16- Documents to Read After this Document
17
18=======================================================================
19Introduction
20=======================================================================
21This package contains Revolution SDK 3.3 with patch 2 applied, and supports CodeWarrior for Wii 1.0.
22
23The 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.
24
25This version of the SDK has changed significantly from the previous version.
26There 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.
27
28(Note: "Revolution" is the codename for Wii.)
29
30=======================================================================
31About the Firmware
32=======================================================================
33Starting 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.
34
35  Firmware used by SDK 3.3 titles: 56.21.29
36
37=======================================================================
38Precautions
39=======================================================================
40-----------------------------------------------------------------------
41About the Guidelines
42-----------------------------------------------------------------------
43There are guidelines that must be adhered to when using this package.
44Please see the following documents for more information about these guidelines.
45
46Guidelines that must be reviewed
47 - Wii and Wii peripherals
48    Wii Programming Guidelines (and the Wii Message List)
49
50 - Strap Usage Screen (including for Wii Motion Plus), Wii Zapper Use Screen
51    Strap Usage Screen Manual
52    (/docs/en_US/Guidelines/Wii_Strap_Zapper_Reminder.pdf)
53
54 - Banners
55    Wii Programming Guidelines -  Logos Shown on Channel Preview Screen
56
57- Guidelines that must be reviewed if using those features
58 - Disc Spin-Off Channel (DISCNAND)
59    Wii Programming Guidelines - Disc Spin-Off Channel
60    (Also the Disc Spin-Off Channel chapter in the Wii Message List)
61
62 - Wii Speak (PMIC)
63   Wii Speak Programming Guidelines
64
65   The following guidelines must also be reviewed if using Voice Chat
66      Voice Chat Icon Specifications
67      (/docs/en_US/PMIC_Library_Guide/WiiSpeak_VoiceChatIcon.pdf)
68      Icon Data
69      (/docs/en_US/PMIC_Library_Guide/texture/)
70
71 - Wii MotionPlus (KPAD)
72    Wii MotionPlus Programming Guidelines
73
74-----------------------------------------------------------------------
75The libraries included in this SDK are all static modules
76-----------------------------------------------------------------------
77The libraries included in the Revolution SDK are all static modules.
78There are no relocatable modules. They cannot be made into relocatable modules.
79
80-----------------------------------------------------------------------
81There is no difference in behavior between the *.exe and *D.exe versions of programs inside the X86 folder
82-----------------------------------------------------------------------
83Some 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.
84
85-----------------------------------------------------------------------
86Running in the Wii Menu
87-----------------------------------------------------------------------
88Programs created using this SDK are compatible with the following version (or later) of the Wii Menu.
89
90* Wii Menu 3.0
91
92Abnormal behavior may occur in systems running earlier versions.
93
94=======================================================================
95License Information
96=======================================================================
97
98- The following files are found in this SDK:
99
100   /dvddata/axdemo/synth/GM16.DLS      : Roland DLS file
101   /dvddata/axdemo/synth/gm16adpcm.pcm : GM16.DLS converted for use with the Wii
102                                         (audio source file, ADPCM version)
103   /dvddata/axdemo/synth/gm16adpcm.wt  : GM16.DLS converted for use with the Wii
104                                         (table file, ADPCM version)
105   /dvddata/axdemo/synth/gm16pcm.pcm   : GM16.DLS converted for use with the Wii
106                                         (audio source file, PCM version)
107   /dvddata/axdemo/synth/gm16pcm.wt    : GM16.DLS converted for use with the Wii
108                                         (table file, PCM version)
109
110  To use all or part of the data from an application, you must comply with the Roland end-user license agreement.
111
112  The end-user license agreement is found in the following directory.
113
114   /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf
115   /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf
116
117  Contact information may be found in the following file.
118
119   /docs/en_US/License/Roland/Roland_contact_info.txt
120
121  Please read this agreement before using the data.
122
123- 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.
124
125   /docs/en_US/License/Dolby/DPL2_for_Wii.pdf
126
127The 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.
128  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.
129
130  Furthermore, the activities defined below are prohibited, even if the purpose is as described above.
131
132 (1) Reverse assembling, decompiling, reverse engineering, altering, or tampering of the library included in this package in whole or in part.
133
134 (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.
135
136 (3) Converting, revising, modifying, and reorganizing this package in whole or in part to create a new middleware product.
137
138 (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.
139
140 (5) Using this package in whole or in part to develop any products that have the same intended purpose or value as this package.
141
142=======================================================================
143Revision History
144=======================================================================
145For the revision history of this release, see /man/en_US/ReleaseNote.html.
146
147=======================================================================
148System Requirements
149=======================================================================
150See RVL_QuickStartGuide.pdf, provided separately, for details on system requirements for the Revolution SDK.
151
152Three USB ports are required to connect to a PC. (Although two ports are specified in some manuals, three USB ports are now required.)
153
154This version of the SDK only supports the commercial release versions of NDEV.
155Whenever possible, use the NDEV software package version 071002 or later.
156
157=======================================================================
158Installation Procedure
159=======================================================================
160First, expand this SDK package without overwriting other versions of the SDK. Next, install the firmware (56.21.29).
161
1621. Unpack the package in any directory (see note below) and specify the path to RVL_SDK/ using the environment variable REVOLUTION_SDK_ROOT.
163   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.)
164
165   REM ************************************************************
166   REM *
167   REM * Please specify your installation paths here:
168   REM *
169   REM ************************************************************
170   SET REVOLUTION_SDK_ROOT=C:\RVL_SDK
171
1722. Before executing any sample demos or other executable programs, be absolutely certain to update the NDEV firmware according to the following procedure.~~~~~~~~~~~~~~~~~~
173
174   In a typical environment, start the update program by launching the bash shell and entering and executing [fwupdate_56.21.29_xx].
175   (For xx, enter jp, us, eu, kr, or cn)
176
177   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.)
178
179   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.
180
181   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.
182
183Note: If you are running this SDK on Windows Vista, you need to unpack the SDK package below the User Account folder (C:\Users\<UserAccount>). For more information, see the Quick Start document, RVL_QuickStartGuide_3-3.pdf, which is provided separately from the SDK package.
184
185=======================================================================
186Currently Known Bugs
187=======================================================================
188Read about this in the Revolution SDK Technical Information section of /man/en_US/index.html.
189
190=======================================================================
191Documents to Read After This Document
192=======================================================================
193There are several documents we would like you to look at after reading this document.
194They can be found in the Revolution SDK.
195
196- Revolution SDK Roadmap (docs/en_US/Quickstart/RVL-SDK-RoadMap.pdf)    This document explains the layout of the Revolution SDK.
197
198- Document Roadmap (docs/en_US/Quickstart/RVL-SDK-DocumentMap.pdf)    This document explains the various documents contained in the Revolution SDK.
199