Documente Academic
Documente Profesional
Documente Cultură
Overview
The System Config Tool is a GUI tool that developers and testers use to set up system
configurations, manage applications, and save data necessary for game development on a devkit
(CAT-DEV or CAT-R).
When the boot mode is set to NAND, the configuration files are stored on NAND in the devkit. The
configuration files are initialized when a system firmware update takes place.
When the boot mode is set to PCFS, the configuration files are stored in the NAND emulation
directory, $CAFE_SLC_DIR/sys/proc/prefs on the host PC and in the NAND in the devkit.
The system configuration is initialized if the files in $CAFE_SLC_DIR/sys/proc/prefs are
updated or manually deleted. Implementing a new version of the SDK does not format the settings if
the developer defined CAFE_SLC_DIR to be the same directory as the previous SDK location on
the host PC.
NOTE: If the System Config Tool settings are set while in NAND boot mode and the user then
switches to PCFS boot mode, the System Config Tool will use the settings that reside
on the host PC (PCFS mode). There are two sets of System Config Tool settings at
any given time; one set on the host PC, and one set in the CAT-DEV's internal NAND
storage.
For information about how to change boot modes, see Change CAT-DEV Boot Modes.
Revision History
2014/06/09 Added table of features and links.
2014/05/21 Added list of features and links.
2014/03/20 Added note on SysConfigTool settings.
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Run and Use the System Config
Tool
System Config Tool Options
You may use arguments to provide options when starting the System Config Tool.
Options
-h, -? This option displays help for System Config Tool options.
-i init_filename This option specifies the System Config Tool initialization script file name.
-I If this option is specified, the System Config Tool initialization script is NOT loaded.
-c "shell_cmd args ..." This option runs a shell command. This is useful for automating the System Config Tool CUI. You may
select multiple arguments as shown below1:
-k up -k a
1The System Config Tool supports a maximum of 15 arguments when using the -c or -k option. For more information, see caferun.
OR
To use the cafediscrun command and the application name, at the command prompt, type the following:
$ cafeon
You may use a Wii Remote, Wii Controller Pro, or Wii U GamePad (DRC) to navigate the menus as follows.
Button Navigation
+Control Pad Move the cursor up, down, left, and right.
A Button Select a setting, move to the submenu, and confirm setting changes.
B Button Go back to the previous menu, and cancel setting changes.
Depending on the menu, a software keyboard may be used and/or buttons other than those listed in the table may be available. Information about how to
use the software keyboard or buttons is displayed in the message field at the bottom of the screen or in a pop-up window.
1. Highlight the setting, and then press the A Button on the key pad.
Root Menu
2. The text turns yellow, and the entry enclosed in brackets may be modified.
3. To change the entry, press up/down on the +Control Pad until the desired entry is displayed, and then press the A Button to save the entry.
4. When you finish changing entries, press the B Button to exit the setting. If you press the B Button after making a change and before you press the A
Button, the change is not saved.
Root Menu
2. Press the A Button on the key pad, and the submenu is displayed.
3. Select the option to change, and then press the A Button.
If the option has an asterisk (*) on the left, you may change the entry directly.
If the option has an arrow (⇒) on the left, there is another submenu with more options available. Repeat step 2 until the displayed options have
asterisks to the left.
4. Select the entry to change, and then press the A Button. The entry is enclosed in brackets and may be modified.
5. Press up/down on the +Control Pad until the desired entry is displayed, press the A Button to save the entry, and then press the B Button.
6. When you finish changing settings, press the B Button to exit the setting the submenu. If you press the B Button after making a change and before you
press the A Button to save the change, the change is not saved.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/04/15 Added a section for boot options.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Calendar,
Language, and Regional Settings
Root Menu
Calendar
You may set the date and time for the system. Applications may use the date and time setting to
determine gameplay for a specific season, day, and time of day. In the Root Menu, select Calendar,
and then set the correct date (MM/DD/YYYY) and time. The time setting uses a 24-hour clock.
Language
This option applies to the language used in the system. If the language setting in the System Config
Tool is set to Japanese, the Japanese language is used. If any other language is selected, English is
used.
When changing the language in the language setting for the Wii U console, the language used on
the GamePad (DRC) may be changed at the same time. A pop-up message is displayed that asks if
you want to switch the DRC language also. If you select Yes, it takes a few seconds to change.
Regional Settings
Regional information identifies a platform region for the service division that is offered by Nintendo.
A game region is used to exercise application execution control. The Wii U console uses both
platform region and game region. The application or game uses game region only.
Information about regional settings is described in the Definition and Use of Region page.
Game Region
The game region identifies the regions where the application may be run on the Wii U. If the region
for the game is in the list of supported regions in the Game Region menu, the game may be played
on that Wii U. For example, if all regions are selected by setting all of the fields listed in the table, an
application with a region setting of any region may run on the Wii U.
NOTE: The game region for the console may not be obtained from the game application.
You may set the game region for the console. Setup options are:
Platform Region
The platform region (product area) identifies the Division for the services that are provided by
Nintendo. For example, the installed Wii U Menu and the ability to connect to the Nintendo eShop
vary by Wii U platform regions.
You may set the platform region. Only one platform region may be set. Setup options are:
Country
You may set the country in which the user resides. Only one country information is stored per Wii U
console. Setup options are as follows:
For a complete list of country codes and country names, see the Wii U country list spreadsheet.
NOTE: The game application may not use the country code to check the region.
The relation between the country code and the region may be modified during a
system update.
setconfig
Cafe SDK has a script to set up these configures.
Option Description
platform 0:JPN 1:USA 2:EUR 3:AUS 4:TWN 5:KOR 6:CHN
region
game region 1(bit0):JPN 2(bit1):USA 4(bit2):EUR 8(bit3):AUS 16(bit4):TWN 32(bit5):KOR
64(bit6):CHN
language 0:JPN 1:ENG 2:FRN 3:GER 4:ITA 5:SPA 6:CHN 7:KOR 8:DUT 9:PRT 10:RUS
11:TWN
country Country ID (e.g. 1:JP 49:US 77:FR 78:DE 110:GB etc)
For a complete list of country IDs, see the Wii U country list spreadsheet.
Also setconfig script sets up calender as the current date and time automatically.
Revision History
2015/02/09 Updated screen shots.
2014/11/05 Added information about setconfig script.
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Title Launcher
You may view and run the list of executable titles, patches, and add-on content. When you select Title Launcher in the Root Menu, and then press the A
Button, the Title Launcher menu is displayed with a list of installed titles. When you select a title in the list, and then press the A Button, information about
that title is displayed in the Title Information screen. Press the A Button again to start the title.
Title Information
You may "pre-mount" an image when starting the System Config Tool by specifying the HDD bank number. For example:
or
Applications associated with device type odd0x may run from the specified HDD bank.
To install, uninstall, and move titles, use the Title Manager menu. To switch to the Title Manager menu from this menu, press the Y Button. You may also
access the Title Manager menu by selecting Data Manager in the Root Menu of System Config Tool.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Data Manager
The following table lists the tasks that you may perform with each of the menu options in the Data Manager Menu.
Title Manager
In the Title Manager Menu, you may install, uninstall, copy, and move titles. You may also initialize the title version table.
Install titles
You may install a title to the system NAND or USB storage from an SD card that is inserted in Wii U or from the emulation NAND MLC
directory on the host PC. You may also install multiple titles in the same directory at the same by selecting multiple images to install.
Install Menu
To install a title
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Title Manager, and then press the A Button.
3. In the Title Manager menu, select Install, and then press the A Button.
4. In the Install menu, select the device where title to install is located, and then press the A Button.
5. In the Install menu, select the install directory, and the press the A Button.
6. Select the title or titles that you want to install, press the R Button on the back or side of the controller, depending on which controller that
you are using, and then press the A Button to confirm. A windows displays the installation progress on the GamePad, monitor, or TV.
NOTE: If the device is not recognized, it is not available for you to select.
If you get "MCP INSTALL RVAL (-262228)" error, uninstall the title that has same title id as the title that you want to install
before installing the selected title.
SD card and NAND MLC (emulation) are not recognized and are not selectable.
During development, application installation may fail unexpectedly. If the following conditions exist when the System Config Tool attempts to
install an application, the installation process fails.
The production Wii U Menu reports the amount of free space to the nearest 1 GB. When this number is rounded up to the nearest 1 GB,
there may appear to be sufficient space for the application when there is not.
The application is larger than the available space on USB storage.
To help ensure a successful installation, check the amount of free space on the USB storage device in the System Config Tool. The System
Config Tool reports the amount of free space to the nearest 0.1 GB. If the reported amount of free space is less than the free space that is
required by the application (within the reported resolution), the installation will fail.
On a production unit, Nintendo eShop verifies the true amount of available free space before beginning to install an application. If there is not
enough available free space, the installation process does not start.
Uninstall titles
You may uninstall titles on the system NAND and USB storage. Game titles, patches, and add-on content on NAND (MLC) or USB may be
uninstalled. You may uninstall multiple titles at the same time by selecting multiple titles.
To uninstall a title
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Title Manager, and then press the A Button.
3. In the Title Manager menu, select Uninstall, and then press the A Button.
4. Select the title or titles that you want to install, press the R Button on the back or side of the controller, depending on which controller that
you are using, and then press the A Button to confirm. A windows displays the progress on the GamePad, monitor, or TV.
NOTE: If the device is not recognized, it is not available for you to select.
Copy titles
You may copy titles on the system NAND and USB storage. Game titles, patches, and add-on content on NAND (MLC) or USB may be
copied. You may copy multiple titles at the same time by selecting multiple titles.
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Title Manager, and then press the A Button.
3. In the Title Manager menu, select Copy, and then press the A Button.
4. In the Title Manager - Copy menu, select the device where you want to copy the data, and then press the A Button.
5. Select the title or titles that you want to copy, press the R Button on the back or side of the controller, depending on which controller that
you are using, and then press the A Button to confirm. A windows displays the copy progress.
NOTE: If the device is not recognized, it is not available for you to select.
Move titles
You may move titles on the system NAND and USB storage. Game titles, patch, and add-on content on NAND (MLC) or USB may be moved.
If you select multiple titles, you may move multiple titles at the same time.
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Title Manager, and then press the A Button.
3. In the Title Manager menu, select Move, and then press the A Button.
4. In the Select Destination Device menu, select the device where you want to move the data, and then press the A Button.
5. Select the title or titles that you want to move, press the R Button on the back or side of the controller, depending on which controller that
you are using, and then press the A Button to confirm.
NOTE: If the device is not been recognized, it is not available for you to select.
Also, by pressing ZR Button, you can switch the display of quota size from the value in the meta.xml to the actual size. Normally, the quota
size in the meta.xml is the same as the actual size. However, if meta.xml is modified via an update after creating save data, the quota size in
the meta.xml may not be the same as the actual size.
When NAND is selected, the location where you may view save data depends on the NAND Emulation Mode setting. Regardless of the
setting NAND Emulation Mode setting, you may view the content of the USB storage device.
If you export from the title list, the entire save data of a tittle should be exported; if you export from the list of save data per account, the save
data for the specified account should be exported.
When exporting save data, there are 2 ways: to archive data into one or use FAT32 viewable on PC.
The exported save data is saved using the following naming standard:
When exporting non-common save data, if common save data also exists for the same title, the common save data is also exported. The
common save data is saved using the following naming standard:
When exporting save data, the meta directory with the corresponding Title ID is exported automatically. The System Config Tool does not
display the meta directory. The meta directory is saved using the following naming standard:
When exporting in FAT32 format, as with archive format, common save data and meta directory should also be exported automatically. Also,
when exporting in FAT32 format, header information file to be used along with actual data when importing should be generated.
Actual data should be stored under the following folder in the same structure as NAND/USB.
Each header information file (.nsifile) used when importing should be stored under the following name:
NOTE: Files in NAND on the host PC are not compatible with files on System NAND because NAND on the host PC does not support
some information such as the permissions for a file or the owner ID. For this reason, importing save data into System NAND that
was exported from NAND on the host PC is not supported.
There is no issue with importing save data into host PC NAND that was exported from System NAND.
You can extract save data from a save data binary file (cfexxx.bin) by Wii U Save Data Extractor on your PC.
1. Select Save Data Manager from the root menu; select Import from SD Card.
2. At the time of exporting, you should see a screen where you can select a serial number of the console that contains save data. Select the
serial number of the console from which you wish to import save data.
3. The list of title IDs should be displayed. After selecting the import target device from Target Device. select save data you wish to import.
Press X Button to import the save data for all titles selected. Also, press A Button to move to the screen where you can separately import
save data per account of titles selected. (Explained in 4.)
4. You can import accounts selected via Target Account on the per-account import screen. If automatic detection is selected, accounts in the
event of each save data being exported should be selected. (Even if the console has no corresponding account, import will be forced to
take place.)
When importing non-common save data, if common save data also exists for the same title, the common save data is also imported. The
common save data is saved using the following naming standard:
When importing save data, the meta directory with the corresponding Title ID is imported automatically. The System Config Tool does not
display the meta directory. The meta directory is saved using the following naming standard.
NOTE: If you use the host PC to copy save data, you should also copy the cfemeta- file with the corresponding Title ID.
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Save Data Manager, and then press the A Button.
3. In the Save Data Manager menu, select Move Save Data, and then press the A Button.
4. In the Select Destination Device menu, select the device where you want to move the data, and then press the A Button.
5. Select the title or titles that you want to move, press the Y Button.
Move Save Data
IMPORTANT: Only save data for the account that exists on the system may be moved. If there is save data that does not have a
corresponding account, it is deleted when you attempt to move it.
Fill-up Tool
The Fill-up Tool generates a large number of save directories to fill up NAND or external USB storage fully. Use this tool to check the behavior
after NAND or external USB storage are full.
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Save Data Manager, and then press the A Button.
3. In the Save Data Manager menu, select Fill-up Tool, and then press the A Button.
4. In the Fill-up Tool, select the Target Device, specify the Rest Size, select Start Fill-up, and then press the A Button.
How to view save data on the system NAND by making changes to NAND Emulation Mode
For security reasons, you may not directly view files in save data that is stored on the system NAND. To view what is on the system NAND,
follow the instructions below to copy or move save data from the system NAND to host PC NAND.
The copied or moved save data is stored under ($CAFE_ROOT)/data/mlc/usr/save/<TitleID Hi>/<TitleID Lo>/.
Also, if you move save data in CAFE_SAVE_DIR on host PC to host PC NAND. System Config Tool can see it. In such a case, arrange data
as follows:
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select File System Viewer, and then press the A Button.
3. In the File System Viewer menu, select the device where you want to view the file system, and then press the A Button.
4. Use the +Control Pad and the A Button to drill down through the file system.
5. Press the Y Button to check files under the current directory for corruption and save the result on the SD card.
6. Press the R Button to save all files under the current directory onto the SD card.
1. In the Root Menu, select Data Manager, and then press the A Button.
2. In the Data Manager menu, select Format External USB Storage, and then press the A Button.
3. In the Format External USB Storage menu, select the device that you want to format, and then press the A Button.
4. Press the A Button again to confirm and start the formatting process.
Revision History
2013/10/15 Added information about Wii U Save Data Extractor.
2013/10/15 Updated for SDK 2.10.03
2013/07/26 Added a note to Export Save Data to an SD Card.
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Display and
Audio
You may set up the display and audio output for the TV and the DRC. The settings go into effect
after restarting the application.
GamePad
DRC Sound
You may set the DRC sound format. There are 3 settings to choose from: MONO, STEREO, and
SURROUND.
TV
NTSC or PAL
You may select the Wii U display region. NTSC or PAL may be specified on development machines
only. The setting for the product version is determined by its destination.
Connection Mode
You may set up the TV display and sound output from the Wii U automatically or manually.
If AUTO is selected, the display and sound is automatically set up according to the capabilities of
the TV and/or the cable that are used.
If MANUAL is selected, you may select the display and sound options manually.
NOTE: If MANUAL is selected, the display and sound are output according to the specified
settings regardless of the capabilities of the TV and/or cable used to connect to the
TV. If the settings do not match the capabilities of the TV and/or cable that are
used, the video output may not display properly, and the sound may not be what
you expect.
The following settings are available on when the Connection Mode is set to MANUAL.
Video out
You may set up the cable used for TV output. There are 3 settings: HDMI, COMPONENT, and
COMPOSITE.
Resolution
You may set the TV resolution. The available resolution depends on the selected region and cable
settings. The relationship between the region and cable settings, and the available resolutions are
described in the following table:
Aspect Ratio
You may set the display aspect ratio. The Aspect Ratio 4:3 may be enabled only when the resolution
is set to SD (480I/P, 576I). For other resolutions, the Aspect Ratio should be set to 16:9.
TV Under Scan
Generally TVs are designed to overscan input signals to display. This means that a part of the input
image is cut off and becomes invisible to the user. The over scan ratio varies by TV. You may
compensate for over scan by turning on under scan. Increase the under scan percentage until the
entire image is displayed on your TV. You may set under scan up to 20% of the valid frame.
NOTE: Regardless of the under scan setting, the game application must meet the safety frame
requirement according to the guideline, and lay out important information to fit within the
frame.
TV Sound
You may set the TV sound format. There are 3 settings: MONO, STEREO, and SURROUND.
TV Audio out
You may set the TV audio output. There are 3 settings: HDMI, HDMI+RCA, and RCA. This setting is
available only when video output is set to HDMI.
Revision History
2013-10-15 Updated for SDK 2.10.03
2013-05-08 Automated cleanup pass.
2013-02-15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Wii U
GamePad (DRC) Settings
In the Wii U GamePad (DRC) Settings menu, you may update the GamePads firmware, pair
GamePads to a devkit (CAT-DEV or CAT-R), restore microphone and LCD default settings, and
check the GamePad WiFi status.
Pair DRC
1. Select the Pair DRC option to pair a GamePad to the devkit. If the Multi DRC setting is ON,
multiple GamePads may be paired as primary (1) and secondary (2).
2. When you select this menu option, a PIN code and the remaining time for pairing to finish is
displayed. If you do not finish the pairing process in the time displayed, pairing is canceled, and
the process again must be started again.
3. To continue the pairing process, press the SYNC Button on the GamePad.
If you press the SYNC Button once on the GamePad, the GamePad pairing process starts.
If another GamePad is already paired and you press the SYNC Button twice, the GamePad
pairing process starts, and the GamePad pairs as the primary controller.
If another GamePad is already paired and you press the SYNC Button once, the GamePad
pairing process starts, and the GamePad pairs as the secondary controller.
If you press the SYNC Button during the GamePad pairing process, pairing is canceled.
4. Enter the PIN code on the GamePad that is displayed on the TV or monitor. The "Connecting to
the Wii console" message is displayed on the GamePad.
Tapping the symbols and connecting to the Wii U Console
For more information about setting up a GamePad, see Set Up the DRC.
Revision History
2015/02/06 Updated screen images.
2014/03/27 Removed long version of 'GamePad'.
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Wii Remote
and Sensor Bar
You may set up the Wii Remote and Sensor Bar.
Start the pairing process by pressing the SYNC Button on the Wii Remote. For more information
about pairing, see Pair DRC on Wii U GamePad (DRC) Settings in the System Config Tool.
Revision History
2015-02-04 Added 'Connected Controllers' listing.
2013-10-15 Updated for SDK 2.10.03
2013-05-08 Automated cleanup pass.
2013-02-15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Network
Setting
You may create and save network settings or modify parameters that are used by the Auto
Connection (AC) Library, which handles the network connection state.
Network Settings
On the Wii U, you may configure 1 to 6 user profiles. Individual network settings are stored in each
profile. Only the selected profile is used to connect to the network. For each profile, you may
configure the following settings:
Edit Config
On the Edit Config page, you may set and change the settings for individual profiles. In the initial
state, connection settings are not set. Items that are displayed vary by setting. The tables below
describe the settings available for wireless and wired connections.
NOTE: This option is available only when the Wireless Connection Mode is selected.
SSID
Enter the Service Set Identifier (SSID) for the wireless LAN (WLAN). This is a string that is up to 32-
characters long, which differentiates one WLAN from another. Each AP and device on a WLAN must
use the same SSID so that they may communicate with each other. Your local network administrator
may provide the information required to configure your Wii U to connect to the WLAN.
Privacy Mode
Privacy Mode Security Key
None (default)
WEP You may set up four 5-character or four 13-character security keys,
WEP(RC4 40Bit) depending on the version of WEP that your WLAN uses. Use an index to
WEP(RC4 104Bit) specify the key to use. Each security key is set up by changing the index to
use.
NOTE: WEP technology is obsolete and no longer recommended for
use on wireless networks.
Negotiation Mode
NOTE: This option is available only when the Wired Connection Mode is selected.
IP Description
Address
Obtain
Mode
DHCP When you select DHCP, the IP address, subnet mask, and default gateway are
obtained automatically. You must enter IP addresses for the DNS servers manually.
The IP address may change at any time.
Sticky When you select Sticky, the subnet mask and default gateway are obtained
automatically. You must enter the IP address and IP addresses for the DNS servers
manually. The IP address does not change. However, the subnetwork that the device
accesses may change if the subnet mask and/or default gateway change. This helps
load-balance subnetworks.
Manual When you select Manual, you must enter all of the IP address settings manually. The
IP address never changes.
IP Address Setting
The table below is a quick reference that shows which addresses that you must enter manually and
which are automatically obtained, depending on the address acquisition method.
Configure IP Settings
Proxy Setting
If the Use Proxy option is set to Not Use, proxy setup options are not displayed.
Configure Proxy Settings
A larger MTU that you set may result in greater efficiency because each packet carries more user
data while protocol overheads, such as headers, are the same size regardless of the MTU set. The
greater efficiency means a slight improvement in overall throughput, with fewer packets processed
for the same amount of data.
However, larger packets on a slow link take more time, causing delays for packets that follow and
increasing lag time and latency. Also, if a single bit is corrupted in the transmission, the entire packet
must be retransmitted. On some networks, larger packets are more likely to be corrupted. In spite of
the downsides, large packets may still have a net positive effect on end-to-end TCP performance.
For information on how to improve network throughput, see Network Optimization on the Wii U.
Connection Test
Connection Test
During the connection test, the system attempts to connect to the local network using the current
configuration for the selected profile. At the end of the test:
Revision History
2013/12/13 Added descriptions about "Import/Export Profile".
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Parental
Control Setting
You may set up parental controls. Each option selected is stored in the system file. Each setting is
described in the table below:
NOTE: The System Config Tool stores only parental control settings. It does not actually control
features according to each setting. Actual control is exercised in each application that
looks at the stored parental control information.
Revision History
2013/10/15 Added screen shot for parental account main page.
2013/10/15 Updated for SDK 2.10.03
2013/05/17 Updated messages to fit Wii U menu.
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: SpotPass
Setting
The SpotPass feature enables users to periodically download and/or upload data while the system is
running by registering the communication tasks to be performed. You may modify the system setting
for SpotPass.
NOTE: The System Config Tool provides only the functionality to store the SpotPass settings.
Actual functionality control is managed by the application that uses the this settings.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: EULA
You may change the EULA agreement.
Revision History
2013-10-15 Updated for SDK 2.10.03
2013-05-08 Automated cleanup pass.
2013-02-15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Other Setting
Other Setting
The Other Setting menu lets you change the following settings:
Spin on Crash
If Spin on Crash is set to Enable and a problem is encountered that causes the system to crash,
the system will stay up if possible so that the crash state can be examined by COS Shell
Commands. Disable is the default setting.
Disable is the default setting. For more information, see Debug a Crash.
Crash Recovery
Crash Recovery is set to Enable by default. If a problem is encountered that causes the system to
crash, the system enters a crash recovery state. Disable prevents a crash recovery state from
proceeding so that it is then possible to debug an application.
USB Keep-Alive
To meet reduced power consumption requirements, USB hard drives may power down after a
specified period of inactivity. Waking up from the powered-down state takes time, which increases
response time. To avoid delays in gameplay, users may Enable the USB Keep-Alive setting. If USB
Keep-Alive is set to Enable, it prevents a USB hard drive from powering down. Disable is the
default setting.
NOTE: Many users do not enable the USB Keep-Alive setting. It is recommended that you
implement your application with the assumption that the USB HDD is in the low-power
state and will take time to power up and load data.
Using the settings under Debug Flags Setting, you may limit, or filter, the Cafe logging output that
is produced as your application runs.
Synchronous Printing
If Synchronous Printing is set to Enable, all output from OSReport is printed, even if system
timing is affected by doing so. If set to Disable, then output from OSReport is dropped with a
message if the debugging interface cannot keep up. Disable is the default setting.
When the LV -1: No Override option is selected, the filtering is determined by the -v option of the
caferun command. For the other options, the numbered LV level corresponds to the equivalent
numeric argument to the -v option.
You may also filter Cafe logging output based on the process.
You may also filter Cafe logging output based on the module.
Auto Power-Down
If Auto Power-Down is set to Use, the system powers down automatically after the set period of
time. If Auto Power-Down is set to Not Use, the system never powers down automatically. Use is
the default setting.
[Reset to default]
Selecting this setting restores the default Eco mode settings.
Revision History
2014/03/11 Change /usr/tmp to /usr/tmp/app.
2014/02/13 Add log filtering details.
2014/01/31 Add Copy Tmp on Crash setting.
2013/12/17 Added Debug Flags Setting and clean up.
2013/12/11 Added Spin on Crash, Crash Dump Type, Eco mode.
2013/12/06 Added Crash Recovery option.
2013/10/15 Updated for SDK 2.10.03.
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs.
CONFIDENTIAL
System Config Tool: Test Settings
To verify the application is working, you may use Test Settings to configure features that run in the
background.
BG Stress Mode
The Wii U the system performs background processes, such as downloading data, while the user
continues to use the application. Downloading data consumes the most resources of any of the
background processes. Generally, the system manages these processes so that they do not affect
the application. However, when the system has an issue or the application calls system functions
frequently, a problem may occur.
By running an application with BG Stress Mode enabled, background processing can continue
without affecting the application. To use BG Stress Mode, an environment that connects to the
Internet is required. This allows the development machine to connect to the Internet and run in BG
Stress Mode for testing purposes.
NOTE: Test Settings also has a setting called Background Daemon. It is not the same setting as
BG Stress Mode. If Background Daemon is disabled, the system daemon does not run
and BG Stress Mode does not work even if it is enabled.
Item Description
Disable When you disable BG Stress Mode, BG Stress Mode is turned off and
BOSS storage is deleted.
Mode1(FS-Write) Repeat 1 GB file download.
Mode2(FS-Flush) (Default) Repeat 2.5 MB file download.
Mode3(FS-Flush) Like Mode1 (FS-Write), repeat 1 GB file download, but save
downloaded file to USB storage.
Mode4(FS-Flush) Like Mode2 (FS-Flush), repeat 2.5 MB file download, but save
downloaded file to USB storage.
Status
Displays the status of the task running in BG Stress Mode.
Background Daemon
The Background Daemon setting determines whether to run a system daemon in the background. If
you encounter an issue, use this setting to verify whether the system daemon affects the problem. If
Background Daemon is disabled, the system daemon does not run and BG Stress Mode does not
work even if it is enabled. Enable is the default setting.
Find USB
Set this flag to True if you want the application to use USB storage when performing cafex run.
False is the default setting.
Revision History
2014/05/05 Added NUP info.
2013/10/15 Updated for SDK 2.10.03
2013/05/16 Added information on BG Stress Mode.
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: System
Viewers
System Titles Viewer
The System Titles Viewer displays the list of system titles that are installed. To display detailed
information about a title, select the title, and then press the A Button.
The System Log Viewer displays the current or previous system event log that is stored in volatile
memory on the Wii U system.
You may review the logs in the Crash Log Viewer. A list of crash logs is displayed. To view
information about a specific system hang or crash, select the crash log, and then press the A
Button.
Crash Log Viewer
The Console Event Viewer displays the history of system and error events stored on the Wii U
system.
System Events
In the Console Event Viewer, select System Event to view the 10 most recent system events in the
console log.
Error Events
In the Console Event Viewer, select Error Event to view the 10 most recent error events in the
console log. Select an available error code to view the corresponding crash log.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Update
System
You may manually update the Wii U system for NAND or PCFS mode in the Update System MAN
page.
Update System
NOTE: You may update your system with the installed SDK version when the solution to an issue
is to run an update, or you may install a patch for the currently installed SDK. If you want
to install another version of the SDK, follow the instructions in CAT-DEV System Upgrade
or Update CAT-R Firmware.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Format
System
To format the Wii U system, select the Format System option in the Root Menu, and then press the
A Button. Press the Y Button to confirm that you want to format the system.
Format System
It may take a few minutes depending on the volume of data. Do not turn OFF the system until the
format process finishes.
After the format finishes, run cafeon to restart the CAT-DEV, and again set the date and time,
regions, language, and country. Using the TV or monitor and the Wii U Pro Controller, pair the
GamePad to the CAT-DEV. For more information, see the CAT-DEV QuickStart Guide.
To use USB storage again, the USB storage must also be formatted. For more information, see
Format the USB Storage Device.
Revision History
2013/10/15 Updated for SDK 2.10.03
2013/05/08 Automated cleanup pass.
2013/02/15 Divided long document into multiple html docs
CONFIDENTIAL
System Config Tool: Reboot
System
To reboot the Wii U system, select the Reboot System option in the Root Menu, and then press the
A Button. Press the Y Button to confirm that you want to reboot the system.
Reboot System
Revision History
2013-10-15 Updated for SDK 2.10.03
2013-05-08 Automated cleanup pass.
2013-02-14 Added Reboot System Information.
CONFIDENTIAL
System Config Tool: Command-
Line Options
Overview
The System Config Tool supports various commands directly from a USB keyboard with pressing
F12 (or Tilde) key. Currently, the command line supports the following.
Command Description
alias Add or delete alias for commands.
bg_enable Enable or disable background daemons.
cat Print file(s) to standard output.
cd Change current directory.
copy Copy title from source title path to target device.
country Display or set the country.
create_syssave Create initial save data of some system applications. This manipulation will
take a few minutes.
date Show date/time.
delete_save Delete all save directories associated with a title.
delete_user_data Delete user data from NAND.
delete_ver_list Delete version list.
drc_update Update DRC firmware.
exit Exit System Config Tool.
export_save Export save data to SD card.
fast_rle Display or set the global fast relaunch option.
fillup Generates a large number of save directories and fills up NAND or external
USB storage fully.
findusb Display or set the find USB option.
gamereg Display or set the game region.
get_sys_version Display system version information.
get_ticketlist Display list of tickets for a title.
get_tid Display current title ID.
get_titleinfo Display information about a title.
get_titlesize Display size of title in bytes.
help List commands.
history Display history of entered commands.
import_save Import save data from SD card.
install Install title.
language Display or set the language.
launch Launch title.
limit_mem Displays or sets the memory limit.
list Display list of titles.
load List, acquire, or release RPL command package.
ls List directory.
mode List, show current, or change mode.
mount Mount volume.
nup_skip_check Configure settings for NUP skip.
prodarea Displays or sets the product area.
pwd Print current directory.
restart Restart System Config Tool.
set_apd Enable or disable Auto Power-Down.
set_install_dev Set target device for title installation.
set_latest_ver Set latest version for title.
set_required_ver Set required version for title.
set_updater Set system updater.
set_ver_list_ver Set version list version.
sleep Sleep before continuing.
source Run a script.
status Display status of last command.
sys_mode Set system mode.
syslog Outputs previous system log.
uninstall Uninstall title.
update Install update package.
update_check Check all update packages.
update_launch Install updater and launch it.
Top
alias
Syntax:
alias -D [alias]
alias -E
Option Description
-A Set alias
-D Delete alias
-E Delete all aliases
After being set, an alias may be used to execute the command line associated to it. An alias may not
contain any '-' characters. To view currently set aliases, use alias.
bg_enable
Syntax:
bg_enable [0 | 1]
Description: Enable (1) or disable (0) background daemons. Passing no arguments will display the
current state of the background daemons.
cat
Syntax:
Option Description
-h, -? Show help.
-n Number lines.
-x Dump as hex.
-X Dump as hex and characters.
-v Use escape sequences for non-printable characters.
-E Verbose error output.
-w [positive integer] Set width of line.
-s [positive integer] Start at specified line.
-e [positive integer] End at specified line.
Description: Print file(s) to standard output with formatting supplied by options. Default behavior will
display as text and non-printable characters will appear as ".".
Top
cd
Syntax:
cd [directory]
copy
Syntax:
country
Syntax: country [country ID]
For a complete list of country IDs, see the Wii U country list spreadsheet.
create_syssave
Syntax: create_syssave
Description: Create initial save data of some system applications. This manipulation will take a few
minutes.
date
Syntax:
date
delete_save
Syntax:
delete_save [TID]
Description: Delete all save directories associated with a given title ID [TID] (in hex).
delete_user_data
Syntax:
delete_user_data
Description: Deletes all user data and resets the console to the initial state. This includes save
directories and preferences.
Top
delete_ver_list
Syntax:
delete_ver_list
drc_update
Syntax:
drc_update [1 | 2]
Description: Updates the DRC firmware for the DRC attached to port DRC1 (1) or DRC2 (2).
exit
Syntax:
exit [0 - 255]
Description: Exits System Config Tool. The argument acts as the exit code. Zero is returned in the
case of no argument.
export_save
Syntax:
Description: Exports specified title's [titleId] save data from target device [mlc | hfiomlc | usb] to SD
card.
fast_rle
Syntax:
fast_rle [0 | 1]
Description: Enable (1) or disable (0) the fast relaunch setting for all applications using the same
OS. Providing no arguments displays the current state. This setting requires a restart to take effect.
Top
fillup
Syntax:
Description: Generates a large number of save directories and fills up MLC or USB. [rest size(byte)]
specifies the size to be left open on the device when filling up.
findusb
Syntax:
findusb [0 | 1]
Description: Enable (1) or disable (0) the find USB setting. When no arguments are provided, the
current value is displayed.
gamereg
Syntax:
gamereg [0 - 6]
Code Region
0 Japan
1 USA
2 Europe
3 Australia
4 China
5 Korea
6 Taiwan
Description: Sets the game region when a value is provided. Otherwise, displays the current setting.
get_sys_version
Syntax:
get_sys_version
get_ticketlist
Syntax:
Option Description
-v Verbose mode
get_tid
Syntax:
get_tid
get_titleinfo
Syntax:
get_titleinfo [TID]
Description: Displays group ID, path, type, version, OS, and SDK for a given title ID [TID] (in hex).
get_titlesize
Syntax:
get_titlesize [path]
help
Syntax:
help [string]
Description: Display a list of commands. If a string is provided, only displays commands starting with
that substring.
history
Syntax:
history [options]
Option Description
-c Clear history list
-n [N] Show only the last [N] commands
-? Display help
Top
import_save
Syntax:
Description: Imports specified title's [titleId] save data from SD card to target device [mlc | hfiomlc |
usb] as specified account's [persistentId] save data.
install
Syntax:
install [path]
Description: Install title at [path] to current install device. The path must be to an installable image
(i.e. created with makecfdownloadimage.sh). To set the install device, see set_install_dev.
language
Syntax: language [0 - 11]
Code language
0 Japanese
1 English
2 French
3 German
4 Italian
5 Spanish
6 Chinese
7 Korean
8 Dutch
9 Portuguese
10 Russian
11 Taiwanese
launch
Syntax:
launch -D [alias]
Option Description
-a Launch title from specific path
-l Enable preloading
-p Enable patch
-A Set alias
-D Delete alias
Description: Launch title based on title ID [TID] (in hex) or from specific [path].
After being set, an alias may be used to launch a title instead of a path or title ID. Use the optional
[DEV] parameter to launch from the specific device. An alias may not contain any '-' characters. To
view more information about valid [DEV] parameters or currently set aliases, use launch -h.
Top
limit_mem
Syntax:
limit_mem [0 | 1]
Description: Restricts (1) or unrestricts (0) memory to simulate production console environment. If
no argument is provided, the current setting is displayed. Any changes will take effect on the next
restart.
list
Syntax:
list [0 - N] [/s]
Description: List titles. Optionally will list only the first N titles. Specify zero to get the number of
titles. Use "/s" to get the title size.
load
Syntax:
load [options]
Option Description
-l Show loaded packages
-I Reload all packages.
-R Release all packages.
-r [PkgName] Unload [PkgName].
-v Verbose output.
-h, -? Display help.
Description: Manage functionality packages for System Config Tool. By default, System Config Tool
loads all packages in init.scp.
ls
Syntax:
ls [options] [dir]
-l Lists permissions, group ID, owner ID, size, along with the name.
-R Recursive mode with a maximum depth of 32.
-h, -? Display help
Description: Lists information about files in [dir] (if specified) or current directory.
mode
Syntax:
mode -l
Option Description
-l List all modes currently loaded with System Config Tool.
-e [N] Send status [N] to next mode [M].
Top
mount
Syntax:
mount [options]
Option Description
-d List current devices.
-h, -? Display help.
nup_skip_check
Syntax:
nup_skip_check enable [0 - 1]
Code Description
0 Disable
1 Enable
prodarea
Syntax:
prodarea [0 - 6]
Code Region
0 Japan
1 USA
2 Europe
3 Australia
4 China
5 Korea
6 Taiwan
Description: Sets the product area when a value is provided. Otherwise, displays the current setting.
pwd
Syntax:
pwd
restart
Syntax:
restart
set_apd
Syntax:
set_install_dev
Syntax:
set_install_dev mlc
Description: Set install device to MLC or USB. If USB, a device index may be specified.
set_latest_ver
Syntax:
Description: Sets the latest version for an application with title ID [TID] (in hex) to [ver] (in decimal).
Top
set_required_ver
Syntax:
Description: Sets the required version for an application with title ID [TID] (in hex) to [ver] (in
decimal).
set_updater
Syntax:
set_updater [TID]
set_ver_list_ver
Syntax:
set_ver_list_ver [ver]
sleep
Syntax:
sleep [N]
Description: Sleep for [N] seconds before continuing. [N] must be a positive integer greater than
zero.
source
Syntax:
Option Description
-c Continue even if error occurs
-q Run quietly. Commands will not echo.
-p Allows script to modify working directory.
-h, -? Display help.
Description: Execute commands from a script file. Script files must be less than 64K in size. Scripts
may source other scripts, but maximum depth is 16.
Top
status
Syntax:
status [options]
Option Description
-n Prints status as number
-e [integer] Passes only if status equals N
-p [string] Set pass message
-f [string] Set failure message
-h, -? Show help
sys_mode
Syntax:
sys_mode [0 | 1]
Description: Sets the system mode to development (1) or production (0). No arguments will display
the current mode. Any changes will take effect on the next restart.
syslog
Syntax:
syslog
uninstall
Syntax:
uninstall [path]
update
Syntax:
update [path]
Description: Update with a user update package specified at [path]. Use update_check to find paths
to update packages.
update_check
Syntax:
update_check
update_launch
Syntax:
update_launch [path]
Description: Update with a system update package specified at [path]. Use update_check to find
paths to update packages.
Top
Revision History
2014/11/15 Updated command list.
2013/05/08 Automated cleanup pass.
CONFIDENTIAL