Nmenu

Location

$REVOLUTION_SDK_ROOT/RVL/bin/tools/Nmenu.elf

Overview

In Nmenu you can import WAD files, execute imported applications, and delete imported applications. Additionally auto import, auto run, and auto import/run can be performed by specifying options at startup time. A variety of modes and startup options are described below.

Some of the operations have changed since version 2.0 of the NADK, corresponding to the addition of support for the Wii Remote.

Mode Description

1. IMPORT MODE

A list of the WAD files in <DvdRoot>/viewer can be viewed.

Select a WAD file using the Nintendo GameCube Controller or the Wii Remote +Control Pad up/down buttons, and press the A button to import. In Import Mode, the following information can be viewed (each file's information may be loaded by pressing the +Control Pad left/right buttons).

Application game code
Application game version
The game version is shown when the application has been imported. If not imported, "Not installed" is displayed.

Move to the next mode, Title List Mode, with the B button.

2. TITLE LIST MODE

A list of the imported applications can be viewed.

If content files are lacking, such as when they have been deleted from the Wii Menu, applications will be displayed as Incomplete. Select an application using the Controller up/down buttons, and press the A button to execute. An application shown as Incomplete cannot execute, so you will need to import that application again. In addition, when an application is incomplete, you may not be able to obtain the information displayed below, and instead only ? will be displayed.

An application can be deleted by pressing the X button on the Nintendo GameCube Controller or the 1 button on the Wii Remote. All the imported applications can be deleted by pressing the Y button on the Nintendo GameCube Controller or the 2 button on the Wii Remote. In Title List Mode, the following information can be viewed (information may be toggled using the Controller or +Control Pad left/right buttons, as with Import Mode).

Application game code
Application game version
Application company code
Number of contents used by the application (number of dedicated and shared contents)

The B button switches to SD Browser mode.

3. SD Browser Mode

A list of files on an SD Card can be seen when an SD Card is inserted. Any WAD files on the SD Card can also be imported. Only WAD files can be imported.

Files or directories can be selected using up/down on the Controller or +Control Pad. A selected directory can be opened with the A button, and the contents of that directory will be shown. If the selected item is a WAD file, it can be imported. A file or directory can be deleted by pressing the X button on the Nintendo GameCube Controller or the 1 button on the Wii Remote. It can be moved to the root directory by pressing the Y button on the Nintendo GameCube Controller or the 2 button on the Wii Remote. Return to Import Mode with the B button.

In any mode, OSReturnToMenu is called by pressing START on the Nintendo GameCube Controller or HOME on the Wii Remote.

Auto Import/Run

When starting Nmenu with ndrun, auto import and auto run can be performed by specifying the following options after -a. However, to use auto run by itself, the application must be imported in advance.

Starting with NADK version 2.0, options e and d have been added. Option e is used for simulating a MEM2 size of 128MB; d is used for debugging. These options can be enabled by specifying them together with the automatic execution option l (lower case L). Be aware that if the debugger option is specified but you are not performing debugger startup using CodeWarrior, the application will not start. The e and d options may be specified together.

`-i`	Continues to import specified `.wad` files automatically. The `.wad` files must be located in `${DvdRoot}/viewer`.
`-l`	Lowercase L ("`l`"). Continues to execute specified applications automatically. Note that what is specified is the initial code (for example: 0001) and not the name of a .`wad` file (for example: `cntdemo.wad`).The method was changed to the specification of the initial code beginning with NADK version 2.0. As mentioned above, if `e` is specified at the same time, a MEM2 size of 128MB will be simulated. If `d` is simultaneously specified, it will run in debugger startup mode.
`-il`	Continues to import and execute the specified `.wad` files automatically. Similarly, if `e` is simultaneously specified, simulation will be performed with a MEM2 size of 128MB. If `d` is simultaneously specified, it will run in debugger startup mode.

The following is the command for automatically importing and executing cntdemo.wad:
(This assumes cntdemo.wad is located in dvddata/viewer.)


% ndrun Nmenu.elf -a -il cntdemo.wad

The following is the command for automatically executing cntdemo.wad (Game Code 0001) with a MEM2 size of 128MB:
(This assumes cntdemo.wad has already been imported.)


% ndrun Nmenu.elf -a -le 0001

Nmenu.wad

Starting with Revolution SDK 3.2, a WAD file has been added to the package for Nmenu. Once the Nmenu WAD file has been imported as a Channel, procedures for starting discs and ELF files can be subsequently omitted.

The Nmenu.wad file has basically the same controls and specifications as the normal Nmenu.elf. However, there is no feature for importing from a disc and therefore no Import Mode. It will be set to Title List Mode at startup time. Import NAND applications from an SD Card in SD Browser Mode.

Import Errors and Error Handling Procedures

Error Codes Error Descriptions and Error Handling Procedures

-1010 An error writing to Wii console NAND memory. Occurs when there is insufficient available space in Wii console NAND memory. Check whether there is enough available space to import this WAD file. If there is enough space, restart Nmenu and try to import again.

-1022 This error is generated when inconsistencies are discovered between the WAD file header information and the content file itself. The error may occur for the following reasons.

The file may be corrupt. Try copying the file to DvdRoot/SD Card again or creating the WAD file again.

A blank file of 0 bytes may have been specified at the time of creation. Check whether a blank 0-byte DOL file or archive was specified at creation time due to a build or archive failure.

When the attempt was made to import a locally created data title, there might already have been a data title with the same game code. It might have been downloaded from a server with the e-commerce feature. You can import the file by first using Nmenu to delete that application, but note that this creates inconsistencies with the data on the server.

-1035 An attempt was made to import and overwrite a WAD file configured with a game version that cannot be downgraded. If you first use Nmenu to delete the application you can then import normally. You cannot resolve this problem by selecting Data Management from the Wii Menu and deleting the application.

-2011 The WAD file failed the validity check. The file may be corrupt. Try copying the file to DvdRoot/SD Card again or creating the WAD file again.

-3001 This error occurs when the header information in the WAD file is invalid. Check whether you tried importing a file that is not a WAD file because the extension was altered, for example, during renaming.

-3004 The file failed to open. Try starting Nmenu again. If this does not solve the problem, try changing to another SD Card.

-3005 The file failed to load. Try starting Nmenu again. If this does not solve the problem, try changing to another SD Card.

If import fails for reasons other than the above errors, or if the problems cannot be resolved using the methods mentioned above, please contact support@nintendo.com.

Restoring Corrupt Icons That Have Been Imported

Nmenu can delete titles with corrupt icons that have been imported to the development machine. If the Wii Menu is installed on the development machine, then Nmenu must start automatically. If you use Nmenu-for-corrupted-icon_xx.gcm then Nmenu can start automatically even if the Wii Menu has been imported. Nmenu will start even if you do not perform any operations on the Heath and Safety screen. After Nmenu starts, delete the problem titles.

Notes

The game version is also affected when a WAD file is imported in Nmenu, overwriting an earlier WAD file. To read about game version rules, see the Introduction.
By default, applications are generated with a game code of "0001" (0x30303031), so the application is overwritten when another is imported. To prevent overwriting, use the WAD_OPTION option in make (or the makeWad option) to specify a game code.
Note that if you start Nmenu with the Wii Menu installed and run Delete All, the Wii Menu uninstaller will be deleted as well. If it has been deleted, you can use the firmware update program (fwupdate), included in the Revolution SDK, to uninstall the Wii Menu. However, Channels will not be deleted by this method. Reinstall the Wii Menu and then uninstall the Channels using normal procedures.
Nmenu checks the available space in NAND memory when applications are being installed. It displays a warning if there is insufficient space, but you can choose to ignore the warning and continue the installation process. Note that in such cases the installation may encroach on space reserved by the system. This will not trigger any major problems such as corrupting the system. However, it may affect some applications that make use of this region. You can resolve the problem by uninstalling the installed applications.

Revision History

2010/01/06 Revised the note regarding available memory space.
2009/11/24 Added notes regarding available memory space.
2009/07/27 Added information about the cause and workaround for a -1010 error.
2009/07/06 Explained how to restore a corrupt icon that has been imported.
2009/04/07 Added import errors and error handing procedures.
2008/07/09 Added the Nmenu WAD file to the package. Added notes and workarounds related to Delete All on the Wii Menu.
2008/06/05 Added mention of the game version's effect on overwrite-imports in Nmenu.
2008/01/28 Added the process for handling cases where content files and system files have been deleted.
2008/01/11 Changed the description of the import error caused by differing game versions.
2007/11/20 Standardized use of "Nmenu."
2007/09/10 Added information on game versions. Deleted an explanation related to deleting shared content.
2007/05/10 Added the automatic execution option. Revised the Wii Remote operation methods.
2006/10/25 Added an SD Mode to Nmenu.
2006/09/15 Added a precaution regarding automatic execution.
2006/08/15 Initial version.

CONFIDENTIAL

Error Codes	Error Descriptions and Error Handling Procedures
-1010	An error writing to Wii console NAND memory. Occurs when there is insufficient available space in Wii console NAND memory. Check whether there is enough available space to import this WAD file. If there is enough space, restart Nmenu and try to import again.
-1022	This error is generated when inconsistencies are discovered between the WAD file header information and the content file itself. The error may occur for the following reasons. The file may be corrupt. Try copying the file to `DvdRoot/SD Card` again or creating the WAD file again. A blank file of 0 bytes may have been specified at the time of creation. Check whether a blank 0-byte DOL file or archive was specified at creation time due to a build or archive failure. When the attempt was made to import a locally created data title, there might already have been a data title with the same game code. It might have been downloaded from a server with the e-commerce feature. You can import the file by first using Nmenu to delete that application, but note that this creates inconsistencies with the data on the server.
-1035	An attempt was made to import and overwrite a WAD file configured with a game version that cannot be downgraded. If you first use Nmenu to delete the application you can then import normally. You cannot resolve this problem by selecting Data Management from the Wii Menu and deleting the application.
-2011	The WAD file failed the validity check. The file may be corrupt. Try copying the file to `DvdRoot/SD Card` again or creating the WAD file again.
-3001	This error occurs when the header information in the WAD file is invalid. Check whether you tried importing a file that is not a WAD file because the extension was altered, for example, during renaming.
-3004	The file failed to open. Try starting Nmenu again. If this does not solve the problem, try changing to another SD Card.
-3005	The file failed to load. Try starting Nmenu again. If this does not solve the problem, try changing to another SD Card.