Screen Settings
General System
3D Display Settings
3D Default Scene Settings
Hardware Setup:
Depending on the combinations of machines and their connections, USB communication between the Viewer and the PC may not work; check the Requirement Specifications.
Software Setup:
The procedure to start the Viewer is shown below:
If screen size settings are required, edit (NW4C_FORBANNER_ROOT)/Viewer/dvdroot/viewer.ini.
This step will not be required at the next or subsequent times if those settings are not changed.
NW4R_ROOT
)/tools/Viewer/LaunchViewer.bat
. Note: If multiple development devices are connected to the PC, check the title bar of PARTNER-CTR HIO-Daemon
because it displays the device that is currently communicating.
You cannot connect to the viewer if it is running on a different device than the one that HIO-Daemon is communicating with.
The CTRSDK_ROOT environment variable must be set to the folder where the CTR-SDK is installed.
HIO-Daemon must be installed and running.
The version of the SDK that is set with CTRSDK_ROOT must be compatible with the PARTNER-CTR Debugger version that you are using.
When you use PARTNER-CTR Debugger, you must first update to the latest PARTNER-CTR Debugger firmware version that is compatible with the installed SDK.
Edit the file $(NW4C_FORBANNER_ROOT)/tools/Viewer/Viewer.ini
with a text editor to change the screen settings displayed on Viewer.
The Viewer.ini
file is read each time Viewer is launched. If the settings are changed, Viewer
must be restarted.
The following items can be set.
You can configure screen settings.
Configure the values after the key names that follow /system/video/
as follows.
Example: /system/video/clr_color = 0x404040FF
Key Name | Description |
clr_color |
Sets the clear color value. |
clr_z |
Sets the clear Z value. |
color_fmt |
Sets the color format.
RGBA8: Each of the RGBA components is 8 bits. |
depth_fmt |
Sets the depth format.
D16: Depth is 16 bits. |
You can configure the viewer mode settings.
Configure the values after the key names that follow /system/config/
as follows.
Specify path settings using in the form of full path plus filename.
Example: /system/config/capture_image = C:\NintendoWare\CTR\tools\Viewer\Capture.bmp
Key Name | Description |
default_mode | Sets the default mode when launching the Viewer. You can choose one of the following modes:
3D: 3D Mode |
default_model |
Sets the file path for the model that will be initially loaded by default. If nothing is specified, no model will be loaded by default. |
reload_target |
Sets the file reload path. If nothing is specified here, the reload path is set to $(NW4C_FORBANNER_ROOT)/temp/model.bcmdl .
|
capture_image |
Sets the path for saving screen captures. If nothing is specified here, the screen captures are saved to $(NW4C_FORBANNER_ROOT)/tools/Viewer/capture.bmp .
|
controller_mode |
Sets the operation mode. (Currently cannot be set.) |
frame_rate |
Configures the animation frame rate. |
frame_skip |
Configures whether to skip frames where processing slows.
0: Do not skip |
You can configure the 3D display settings.
Configure the values after the key names that follow /system/information/
as follows.
Example: /system/information/grid_visible = 1
Key Name | Description |
sub_mode |
Sets the graphics sub-mode at viewer startup.
CAM: Camera mode |
grid_visible |
Sets whether grid display is enabled.
0: Do not display |
grid_scale |
Sets the size of the grid scale when displaying the coordinate axes or grid. Specify a real number between 0.001 and 1000.0. |
grid_num |
Sets the number of divisions in the grid scale when displaying the coordinate axes or grid. Specify an integer between 1 and 20. |
grid_color |
Sets the grid color when displaying the grid. |
You can configure the 3D default scene settings.
Configure camera settings by entering /g3d/camera/
followed by the key names and their values, as shown in the following example.
Example: /g3d/camera/rotation_init = 4.032
Key Name | Description |
rotation_init |
Sets the initial value for rotation velocity. |
rotation_step |
Sets the acceleration per frame for rotation velocity. |
rotation_max |
Sets the maximum rotation velocity. |
translation_init |
Sets the initial value for translation velocity. |
translation_step |
Sets the acceleration per frame for translation velocity. |
translation_max |
Sets the maximum value for translation velocity. |
tilt_init |
Sets the initial value for tilt velocity. |
dolly_init |
Sets the initial value for dolly translation velocity. |
tilt_accel |
Sets the acceleration versus pixels during tilt rotation. |
tilt_decel |
Sets the deceleration per frame for tilt rotation. |
tilt_limit |
Sets the velocity limit per frame for tilt rotation. |
slide_accel |
Sets the acceleration versus pixels during slide translation. |
slide_decel |
Sets the deceleration per frame during slide translation. |
slide_limit |
Sets the velocity limit per frame during slide translation. |
tumble_x_inverse |
Sets the tumble x inverse flag for camera-controlled rotation.
0: Do not inverse |
tumble_y_inverse |
Sets the tumble y inverse flag for camera-controlled rotation.
0: Do not inverse |
track_x_inverse |
Sets the tumble x inverse flag for camera-controlled translation.
0: Do not inverse |
track_y_inverse |
Sets the tumble y inverse flag for camera-controlled rotation.
0: Do not inverse |
dolly_inverse |
Sets the dolly inverse flag for camera-controlled translation.
0: Do not inverse |
dolly_target_inverse |
Sets the dolly target inverse flag for camera-controlled translation.
0: Do not inverse |
tilt_x_inverse |
Sets the x inverse flag for camera-controlled tilt.
0: Do not inverse |
tilt_y_inverse |
Sets the y inverse flag for camera-controlled tilt.
0: Do not inverse |
fovy |
Sets the view angle for the default camera. |
position/x |
Sets the x value for the default camera. |
position/y |
Sets the y value for the default camera. |
position/z |
Sets the z value for the default camera. |
target_pos/x |
Sets the x value of the default camera target. |
target_pos/y |
Sets the y value of the default camera target. |
target_pos/z |
Sets the z value of the default camera target. |
up_vector/x |
Sets the x value of the default camera up vector. |
up_vector/y |
Sets the y value of the default camera up vector. |
up_vector/z |
Sets the z value of the default camera up vector. |
touch_panel_mode |
Sets the touch panel operation mode.
NORMAL: Normal mode |
near |
Sets the camera near clip. |
far |
Sets the camera far clip. |
depthlevel |
Sets the distance in virtual space from the player's eyes to the base plane for the realism priority camera. |
factor |
Sets the depth adjustment factor. (A value of 0 indicates no parallax. A value of 1 indicates standard parallax.) |
realSwitch |
Sets whether to enable realism priority camera matrix calculations.
0: Application-priority calculation method |
Configure by entering /g3d/light/
followed by the key names and their values, as shown in the example below:.
Example: /g3d/light/global_ambient_color = 0x333333FF
Key Name | Description |
global_ambient_color |
Sets the light color of the global ambient light by using RGBA values. |
light0_kind |
Sets the light type.
DIRECTIONAL: Parallel light source |
light0_ambient_color |
Sets Ambient Color 1 of Light 0 by using RGBA values. |
light0_diffuse_color |
Sets Diffuse Color 1 of Light 0 by using RGBA values. |
light0_specular0_color_specular0_color |
Sets Specular 0 of Light 0 using RGBA values. |
light0_specular1_color |
Sets Specular Color 0 of Light 1 by using RGBA values. |
light0_direction/x |
Sets the x value of the Light 0 direction vector. |
light0_direction/y |
Sets the y value of the Light 0 direction vector. |
light0_direction/z |
Sets the z value of the Light 0 direction vector. |
Configure by entering /effect/config/
followed by the key name and a value, as shown in the example below:
Example: /effect/config/max_frame_count = 200
Key Name | Description |
sub_mode |
Sets the effect sub-mode at viewer startup.
CAM: Camera mode |
max_frame_count |
Sets the number of frames to loop when looping. |
loop_flag |
Sets whether looping is enabled.
0: Do not loop |
Makes layout settings.
Configure layout settings by entering /g2d/
followed by the key names and their values, as shown in the following example.
Example: /g2d/perspective/fovy
= 45.0
Key Name | Description |
projection |
Specifies the camera mode.
ORTHO: Parallel projection |
z_compare |
Specifies whether to perform Z comparisons.
OFF: Disable |
ortho/near | Sets the projection matrix near clipping value when the camera mode is ORTHO. Configure so that ortho/near < ortho/far. |
ortho/far |
Sets the far-clipping value for the projection matrix when the camera mode is ORTHO. Configure so that ortho/near < ortho/far. |
perspective/fovy | Sets the default FOVY value. Specify a value from 1 to 179. |
perspective/near | Sets the projection matrix near clipping value when the camera mode is PERS .Specify a positive value. Configure the setting so perspective/near < perspective/far. |
perspective/far | Sets the far-clipping value for the projection matrix when the camera mode is PERS .Specify a positive value. Configure the setting so perspective/near < perspective/far. |
stereo/factor | Sets the stereoscopic adjustment factor. (Specify a value the range of from 0 to 1. A value of 0 indicates no parallax. A value of 1 indicates standard parallax.) |
stereo/real_switch | Sets whether to enable realism priority camera matrix calculations for stereoscopic vision..
OFF: Application-priority calculation method |
CONFIDENTIAL