1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html lang="ja">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5<meta http-equiv="Content-Style-Type" content="text/css">
6<link href="../css/manpage.css" rel="stylesheet" type="text/css">
7	<title>Setup</title>
8    <style type="text/css">
9        .style1
10        {
11            height: 21px;
12        }
13        .style2
14        {
15            height: 18px;
16        }
17    </style>
18</head>
19<body>
20
21<!-- =================================================== -->
22<h1 id="SETUP">Starting Up</h1>
23
24<a href="#setup">Setup</a><p></p>
25<a href="#startup">Starting Up</a>
26<p><a href="#caution">Notes</a></p>
27<a href="#init">Initial Settings File</a><br>
28<p>
29<a href="#init_video">Screen Settings</a><br> <a href="#init_system">General System</a><br> <a href="#init_g3d">	3D Display Settings</a><br> <a href="#init_g3d_scene">3D Default Scene Settings</a><br>
30
31</p>
32
33<h2><a name="setup">Setup</a></h2>
34<p>Hardware Setup:</p>
35<ol>
36  <li>Connect the device used for previewing to the PC with a USB cable.
37    <p>
38      Depending on the combinations of machines and their connections, USB communication between the Viewer and the PC may not work; check the <A href="../summary/index.html#requirements">Requirement Specifications</A>.
39    </p>
40  </li>
41
42</ol>
43<p>Software Setup:</p>
44
45<ol>
46  <li>
47    PARTNER-CTR Debugger software setup must be complete. For more information, see the PARTNER-CTR Debugger setup manual.
48  </li>
49  <li>Install CTR-SDK. First, the folder in which CTR-SDK is installed must be set using the environment variable CTRSDK_ROOT and update to CTR-SDK-compatible firmware for devices used for preview.</li>
50  <li> Install NintendoWare. The Viewer will be installed in the Viewer folder below NintendoWare/CTR (indicated below as NW4C_ROOT).
51  </li>
52</ol>
53<BR>
54
55<h2><a name="startup">Starting Up</a></h2>
56<p>The procedure to start the Viewer is shown below:</p>
57<ol>
58  <li>Configure the Viewer's initial settings.
59    <p>If screen size settings are required, edit (NW4C_ROOT)/Viewer/dvdroot/viewer.ini.</p>
60    <p class="warn">This step will not be required at the next or subsequent times if those settings are not changed.</p>
61    <BR>
62  </li>
63  <li>Run the batch file used to start the Viewer.<BR> <BR>
64    <UL>
65      <li>Execute $(<CODE>NW4R_ROOT</CODE>)<CODE>/tools/Viewer/LaunchViewer.bat</CODE>. <BR> (Note: CTRSDK_ROOT must be set to the folder where CTRSDK is setup.)
66      </li>
67    </UL>
68    <BR>
69  </li>
70<!--   <li>PC上でMCSサーバが起動し、実機にViewerプログラムがロードされます。</li>   <li>PARTNER-CTR DebuggerでViewer.cciを実行します。<BR>     <BR>     <UL>       <li>$(NW4C_ROOT)/tools/Viewer/bin/Viewer.cciをPARTNER-CTR Debuggerにロードして実行します。<BR>       </li>     </UL>     <BR>   </li>   <li>PC上でPARTNER-CTR HIO-Daemonを起動します。</li> -->
71  <li>
72    PARTNER-CTR HIO-Daemon will be disconnected if the development hardware is turned off or if the USB adapter is removed. Just reconnect if this happens.
73    <p class="warn"><B>Note:</B> If multiple development devices are connected to the PC, check the title bar of <CODE>PARTNER-CTR HIO-Daemon</CODE> because it displays the device currently communicating.<BR> You will not be able to connect to the Viewer if it is running on a different device than the one that HIO-Daemon is communicating with.</p>
74  </li>
75</ol>
76
77<h3><a name="caution">Notes</a></h3>
78  <h4>Note: If Viewer does not start correctly with PARTNER-CTR Debugger:</h4>
79  <UL>
80    <li>Is the CTRSDK_ROOT environment variable set?
81       <p>The CTRSDK_ROOT environment variable must be set to folder where the CTR-SDK is installed.</p>
82    </li>
83    <li>Is PARTNER-CTR HIO-Daemon running?
84       <p>HIO-Daemon must be installed and running.</p>
85    </li>
86    <li>Does the installed CTR-SDK support the PARNTER-CTR Debugger version being used?
87       <p>The version of the SDK set with CTRSDK_ROOT must be compatible with the PARTNER-CTR Debugger version being used.</p>
88    </li>
89    <li>Has the PARTNER-CTR Debugger firmware been updated to a supported version?
90       <p>In order to use PARTNER-CTR Debugger, it is necessary to update to the latest PARTNER-CTR Debugger firmware version supported by the SDK being set up.
91       </p>
92    </li>
93  </UL>
94
95<h2><a name="init">Initial Settings File</a></h2>
96<p>
97Edit the file $(NW4C_ROOT)/tools/Viewer/Viewer.ini with a text editor to change the screen settings displayed on Viewer.
98</p>
99<p>
100The Viewer.ini file is read each time Viewer is launched. If the settings are changed, Viewer must be restarted.
101</p>
102<BR>
103<p>   The following items can be set:</p>
104
105
106
107
108<h3><a name="init_video">Screen Settings</a></h3>
109<p>Performs screen settings.</p>
110<p>Configure the values after the key names following <CODE>/system/video/</CODE> as shown below.</p>
111<p>Example: /system/video/clr_color = 0x404040FF</p>
112<BR>
113<TABLE class="explain" border="1">
114  <THEAD>
115    <TR>
116      <TD>Key Name</TD>
117      <TD>Description</TD>
118    </TR>
119  </THEAD>
120  <TBODY>
121    <TR>
122      <TD>clr_color</TD>
123      <TD>Sets the clear color value.</TD>
124    </TR>
125    <TR>
126      <TD>clr_z</TD>
127      <TD>Sets the clear Z value.</TD>
128    </TR>
129  </TBODY>
130</TABLE>
131
132
133
134
135<h3><a name="init_system">System Basics</a></h3>
136    <p>
137        Viewer mode settings are configured.</p>
138    <p>
139        Configure the values after the key names following /system/config/ as shown below.</p>
140    <p>
141        Specify path settings using in the form of full path plus filename.</p>
142    <p>
143        Example: /system/config/capture_image = C:\NintendoWare\CTR\tools\Viewer\Capture.bmp </p>
144<TABLE class="explain" border="1">
145  <THEAD>
146    <TR>
147      <TD>Key Name</TD>
148      <TD>Description</TD>
149    </TR>
150  </THEAD>
151  <TBODY>
152    <TR>
153      <TD>default_mode</TD>
154      <TD> Sets the default mode when launching the Viewer. You can choose one of the following modes:
155          <p>
156              3D: 3D Mode<br />EFF: Effect Mode</p>
157    </TD>
158    </TR>
159    <TR>
160      <TD>default_model</TD>
161      <TD> Sets the file path for the model to load by default.</TD>
162    </TR>
163    <TR>
164      <TD>reload_target</TD>
165      <TD>Sets the file reload path.</TD>
166    </TR>
167    <TR>
168      <TD>capture_image</TD>
169      <TD>Sets the path for saving screen captures.</TD>
170    </TR>
171    <TR>
172      <TD>controller_mode</TD>
173      <TD>Sets the operation mode. (Currently cannot be set.)</TD>
174    </TR>
175    <TR>
176      <TD>frame_rate</TD>
177      <TD>Configures all of the animation frame rate.</TD>
178    </TR>
179    <TR>
180      <TD>frame_skip</TD>
181      <TD>Sets whether to skip animation frames when processing slows down.
182          <p>
183              0: Do not skip<br /> 1: Skip</p>
184      </TD>
185    </TR>
186  </TBODY>
187</TABLE>
188
189
190
191
192<h3><a name="init_g3d">3D Display Settings</a></h3>
193    <p>
194        Configures the 3D display settings.</p>
195    <p>
196        Be sure to set the values after the key names following /system/information/ as shown below.</p>
197    <p>
198        Example: /system/information/grid_visible = 1</p>
199<TABLE class="explain" border="1">
200  <THEAD>
201    <TR>
202      <TD>Key Name</TD>
203      <TD>Description</TD>
204    </TR>
205  </THEAD>
206  <TBODY>
207    <TR>
208      <TD>sub_mode</TD>
209      <TD>Sets the Graphics sub-mode at Viewer startup.
210          <p>
211              CAM: Camera mode<br /> MNU: Menu mode</p>
212      </TD>
213    </TR>
214    <TR>
215      <TD>grid_visible</TD>
216      <TD>Sets whether grid display is enabled.<BR>
217          <p>
218              0: Do not display<br /> 1: Display</p>
219        </TD>
220    </TR>
221    <TR>
222      <TD>grid_scale</TD>
223      <TD>Sets the size of the grid scale when displaying the coordinate axes or grid.<BR> Specify a real number between 0.001 and 1000.0.</TD>
224    </TR>
225    <TR>
226      <TD>grid_num</TD>
227      <TD>Sets the number of divisions in the grid scale when displaying the coordinate axes or grid.<BR> Specify an integer between 1 and 20.</TD>
228    </TR>
229    <TR>
230      <TD>grid_color</TD>
231      <TD>Sets the grid color when displaying the grid.</TD>
232    </TR>
233  </TBODY>
234</TABLE>
235
236
237
238
239<h3><a name="init_g3d_scene">3D Default Scene Settings</a></h3>
240    <p>
241        Configures the 3D default scene settings.</p>
242    <h4>
243        Camera Settings</h4>
244    <p>
245        Configure the values after the key names following <CODE>/g3d/</CODE> as shown below.</p>
246    <p>
247        Example: /g3d/camera/distance rotation_init = 4.032</p>
248<TABLE class="explain" border="1">
249  <THEAD>
250    <TR>
251      <TD>Key Name</TD>
252      <TD>Description</TD>
253    </TR>
254  </THEAD>
255  <TBODY>
256    <TR>
257      <TD>rotation_init</TD>
258      <TD>Sets the initial value for rotation velocity.</TD>
259    </TR>
260    <TR>
261      <TD>rotation_step</TD>
262      <TD>Sets the acceleration per frame for rotation velocity.</TD>
263    </TR>
264    <TR>
265      <TD>rotation_max</TD>
266      <TD>Sets the maximum rotation velocity.</TD>
267    </TR>
268    <TR>
269      <TD>translation_init</TD>
270      <TD>Sets the initial value for translation velocity.</TD>
271    </TR>
272    <TR>
273      <TD>translation_step</TD>
274      <TD>Sets the acceleration per frame for translation velocity.</TD>
275    </TR>
276    <TR>
277      <TD>translation_max</TD>
278      <TD>Sets the maximum value for translation velocity.</TD>
279    </TR>
280    <TR>
281      <TD>tilt_init</TD>
282      <TD>Sets the initial value for tilt velocity.</TD>
283    </TR>
284    <TR>
285      <TD>dolly_init</TD>
286      <TD>Sets the initial value for dolly translation velocity.</TD>
287    </TR>
288    <TR>
289      <TD>tilt_accel</TD>
290      <TD>Sets the acceleration versus pixels during tilt rotation.</TD>
291    </TR>
292    <TR>
293      <TD>tilt_decel</TD>
294      <TD>Sets the deceleration per frame for tilt rotation.</TD>
295    </TR>
296    <TR>
297      <TD>tilt_limit</TD>
298      <TD>Sets the velocity limit per frame for tilt rotation.</TD>
299    </TR>
300    <TR>
301      <TD>slide_accel</TD>
302      <TD>Sets the acceleration versus pixels during slide translation.</TD>
303    </TR>
304    <TR>
305      <TD>slide_decel</TD>
306      <TD>Sets the deceleration per frame during slide translation.</TD>
307    </TR>
308    <TR>
309      <TD>slide_limit</TD>
310      <TD>Sets the velocity limit per frame during slide translation.</TD>
311    </TR>
312    <TR>
313      <TD>tumble_x_inverse</TD>
314      <TD>Sets the tumble x inverse flag for camera-controlled rotation.<p>
315          0: Do not inverse<br /> 1: Inverse</p>
316                </TD>
317    </TR>
318    <TR>
319      <TD>tumble_y_inverse</TD>
320      <TD>Sets the tumble y inverse flag for camera-controlled rotation.<p>
321          0: Do not inverse<br /> 1: Inverse</p>
322                </TD>
323    </TR>
324    <TR>
325      <TD>track_x_inverse</TD>
326      <TD>Sets the tumble x inverse flag for camera-controlled translation.<p>
327          0: Do not inverse<br /> 1: Inverse</p>
328                </TD>
329    </TR>
330    <TR>
331      <TD>track_y_inverse</TD>
332      <TD>Sets the tumble y inverse flag for camera-controlled rotation.<p>
333          0: Do not inverse<br /> 1: Inverse</p>
334                </TD>
335    </TR>
336    <TR>
337      <TD>dolly_inverse</TD>
338      <TD>Sets the dolly inverse flag for camera-controlled translation.<p>
339          0: Do not inverse<br /> 1: Inverse</p>
340                </TD>
341    </TR>
342    <TR>
343      <TD>dolly_target_inverse</TD>
344      <TD>Sets the dolly target inverse flag for camera-controlled translation.<p>
345          0: Do not inverse<br /> 1: Inverse</p>
346                </TD>
347    </TR>
348    <TR>
349      <TD>tilt_x_inverse</TD>
350      <TD>Sets the x inverse flag for camera-controlled tilt.<p>
351          0: Do not inverse<br /> 1: Inverse</p>
352                </TD>
353    </TR>
354    <TR>
355      <TD>tilt_y_inverse</TD>
356      <TD>Sets the y inverse flag for camera-controlled tilt.<p>
357          0: Do not inverse<br /> 1: Inverse</p>
358                </TD>
359    </TR>
360    <TR>
361      <TD>fovy</TD>
362      <TD>Sets the view angle for the default camera.</TD>
363    </TR>
364    <TR>
365      <TD>position/x</TD>
366      <TD>Sets the x value for the default camera.</TD>
367    </TR>
368    <TR>
369      <TD>position/y</TD>
370      <TD>Sets the y value for the default camera.</TD>
371    </TR>
372    <TR>
373      <TD class="style2">position/z</TD>
374      <TD class="style2">Sets the z value for the default camera.</TD>
375    </TR>
376    <TR>
377      <TD>target_pos/x</TD>
378      <TD>Sets the x value of the default camera target.</TD>
379    </TR>
380    <TR>
381      <TD>target_pos/y</TD>
382      <TD>Sets the y value of the default camera target.</TD>
383    </TR>
384    <TR>
385      <TD>target_pos/z</TD>
386      <TD>Sets the z value of the default camera target.</TD>
387    </TR>
388    <TR>
389      <TD>up_vector/x</TD>
390      <TD>Sets the x value of the default camera up vector.</TD>
391    </TR>
392    <TR>
393      <TD>up_vector/y</TD>
394      <TD>Sets the y value of the default camera up vector.</TD>
395    </TR>
396    <TR>
397      <TD>up_vector/z</TD>
398      <TD>Sets the z value of the default camera up vector.</TD>
399    </TR>
400    <TR>
401      <TD>touch_panel_mode</TD>
402      <TD>Sets the touch panel operation mode.
403          <p>
404              NORMAL: Normal mode<br /> DRAG: Drag mode<br /> INERTIA:  Inertia mode</p></TD>
405    </TR>
406    <TR>
407      <TD>near</TD>
408      <TD>Sets the camera near clip.</TD>
409    </TR>
410    <TR>
411      <TD>far</TD>
412      <TD>Sets the camera far clip.</TD>
413    </TR>
414  </TBODY>
415</TABLE>
416
417
418    <h4>
419        Light Settings</h4>
420    <p>
421        Configure by entering  <CODE>/g3d/light/ </CODE> followed by the key names and their values, as shown in the example below:.</p>
422    <p>
423        Example: /g3d/light/global_ambient_color = 0x333333FF</p>
424<TABLE class="explain" border="1">
425  <THEAD>
426    <TR>
427      <TD>Key Name</TD>
428      <TD>Description</TD>
429    </TR>
430  </THEAD>
431  <TBODY>
432    <TR>
433      <TD>global_ambient_color</TD>
434      <TD>Sets the light color of the global ambient light using RGBA values.</TD>
435    </TR>
436    <TR>
437      <TD>light0_kind</TD>
438      <TD>Sets the light type.
439          <p>
440              DIRECTIONAL: Parallel light source<br /> POINT: Point light source</p>
441              </TD>
442    </TR>
443    <TR>
444      <TD class="style1">light0_ambient_color</TD>
445      <TD class="style1">Sets Ambient Color 1 of Light 0 using RGBA values.</TD>
446    </TR>
447    <TR>
448      <TD>light0_diffuse_color</TD>
449      <TD>Sets Diffuse 1 of Light 0 using RGBA values.</TD>
450    </TR>
451    <TR>
452      <TD>light0_specular0_color_specular0_color</TD>
453      <TD>Sets Specular 0 of Light 0 using RGBA values.</TD>
454    </TR>
455    <TR>
456      <TD>light0_specular1_color</TD>
457      <TD>Sets Specular 0 of Light 1 using RGBA values.</TD>
458    </TR>
459    <TR>
460      <TD>light0_direction/x</TD>
461      <TD>Sets the x value of the Light 0 direction vector.</TD>
462    </TR>
463    <TR>
464      <TD>light0_direction/y</TD>
465      <TD>Sets the y value of the Light 0 direction vector.</TD>
466    </TR>
467    <TR>
468      <TD>light0_direction/z</TD>
469      <TD>Sets the z value of the Light 0 direction vector.</TD>
470    </TR>
471  </TBODY>
472</TABLE>
473
474
475    <h4>
476        Effect Settings</h4>
477    <p>
478        Configure by entering <CODE>/effect/config/</CODE> followed by the key name and a  value, as shown in the example below:</p>
479    <p>
480        Example: <CODE>/effect/config/max_frame_count = 200</CODE></p>
481<TABLE class="explain" border="1">
482  <THEAD>
483    <TR>
484      <TD>Key Name</TD>
485      <TD>Description</TD>
486    </TR>
487  </THEAD>
488  <TBODY>
489    <TR>
490      <TD>sub_mode</TD>
491      <TD>Sets the Effect sub-mode at Viewer startup.
492          <p>
493              CAM: Camera mode<br /> MNU: Menu mode</p>
494                </TD>
495    </TR>
496    <TR>
497      <TD>max_frame_count</TD>
498      <TD>Sets the maximum frame count.</TD>
499    </TR>
500    <TR>
501      <TD>loop_flag</TD>
502      <TD>Sets whether looping is enabled.<p>
503              0: Do not loop<br /> 1: Loop</p>
504                </TD>
505    </TR>
506  </TBODY>
507</TABLE>
508    <P> </P>
509
510<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table>
511
512<hr><p>CONFIDENTIAL</p></body>
513</html>
514