core/com.nokia.carbide.cpp.doc.user/html/concepts/ngage_projects.htm
author fturovic <frank.turovich@nokia.com>
Wed, 15 Sep 2010 09:40:16 -0500
changeset 2009 b622387629d6
parent 1791 727385d8e2b3
child 2087 617a89f9dffc
permissions -rw-r--r--
changed TRK to CODA in docs except where it related to pre-3.0 versions
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     2
<html>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     3
<head>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     4
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     5
<meta http-equiv="Content-Style-Type" content="text/css" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     6
<meta name="LASTUPDATED" content="06/17/05 11:09:43" />
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     7
<title>N-Gage Projects</title>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
     8
<link rel="StyleSheet" href="../../book.css" type="text/css"/>
1754
a1e1c11d5a44 broken links fixed
fturovic <frank.turovich@nokia.com>
parents: 1658
diff changeset
     9
<script language="JavaScript" src="../reference/perspective_debug.htm"></script>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    10
</head>
1791
727385d8e2b3 added new customize carbide section and some relinking done for deleted duplicate page
fturovic <frank.turovich@nokia.com>
parents: 1754
diff changeset
    11
<body >
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    12
<h2>N-Gage Projects</h2>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    13
<p>Carbide.c++ supports the importing of N-Gage projects. However, there are some process issues that effect how you can debug game projects on devices. The following provides a high level overview of the process you should follow to successfully import, build, deploy, and debug an N-Gage game on a device. </p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    14
<h4>Importing N-Gage projects</h4>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    15
<p>To start,  import your game project into Carbide:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    16
<ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    17
  <li>Install the N-Gage SDK on your PC</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    18
  <li>Place your game project inside the N-Gage SDK</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    19
  <li> In Carbide.c++, click<b> File &gt; <a href="../tasks/ImportingProjects.html">Import</a></b></li>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    20
  <li>Select <b>Symbian OS Bld.inf</b> <strong>File</strong> importer and navigate to your <span class="code">bld.inf</span>  file to import it </li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    21
</ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    22
<h4>Building the N-Gage project</h4>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    23
<p>Once the game project has been imported, use these steps to create an N-GAGE game file:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    24
<ol>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    25
  <li>Right-click the project name and choose <b>Properties</b> to open the <b>Properties for <i>project_name</i></b> window  </li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    26
  <li>In the <b>Carbide.c++ &gt; Carbide Build Configuration &gt; <a href="../reference/build_properties/pane_build_config_sis.htm">SIS Builder</a></b> panel, click <b>Add</b>.</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    27
  <li>In the <b><a href="../reference/build_properties/wnd_sis_properties.htm">SIS Properties</a></b> window:
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    28
    <ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    29
      <li>Specify the project and metadata PKG files  to build</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    30
      <li>Enable  the<b> Sign sis file with certificate/key pair</b> for each PKG file </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    31
      <li>Select the certificate/key given to you by the Nokia R&amp;D Certificate Service</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    32
      <li>Click  <b>OK</b></li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    33
    </ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    34
  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    35
  <li>If using a batch file to build the N-Gage installation,  create a new builder within Carbide  by opening the <b>Properties for <i>project_name</i>  &gt;  Builders</b> panel and click <b>New</b>.  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    36
<p align="center"><img src="images/pane_builders_properties.png" width="682" height="208"></p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    37
<p align="center" class="figure">Figure 1 - Builders pane in project Properties dialog</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    38
      <li>Open the <b>Properties for <i>project_name</i> &gt;  Builders</b> panel</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    39
      <li>Click <b>New</b></li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    40
      <li>Select <b>Program</b> in the <b>Choose configuration type</b> window, click <b>OK</b> </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    41
      <p align="center"><img src="images/wnd_properties_for_builder.png" width="800" height="640"></p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    42
      <p align="center" class="figure">Figure 2 - <b>Properties for N-Gage Builder</b> dialog</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    43
      <li>In the <b>Properties for New_Builder</b> window 
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    44
        <b>Main</b> tab:
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    45
        <ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    46
          <li>Define the builder  name in the <b>Name</b> text box</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    47
          <li>Specify the <b>Location</b> of the builder of the installation file</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    48
          <li>Specify the <b>Working Directory</b>  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    49
        </ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    50
      </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    51
      <li>Click <b>OK</b> </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    52
    <p>	The new builder appears in the <b>Builders</b> panel. The build steps are performed in the order they are displayed.  Your builder name should appear under the  <b>Carbide CPP Project Builder</b> item. If not, use the <b>Up</b> or <b>Down</b> controls to set the build order.
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    53
      <p align="center"><img src="images/pane_builder_n_gage_builder.png" width="489" height="184"></p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    54
      <p align="center" class="figure">Figure 4 - <b>Builder</b> dialog with new N-Gage Builder defined </p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    55
  <li>Click OK to close the <b>Properties for <i>project_name</i></b> window</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    56
  <li>Build the project and its SISX file by selecting the <b>Project &gt; Build Project</b> menu item</li>
1658
2a5c0df13bad renamed files for consistency in naming
fturovic <frank.turovich@nokia.com>
parents: 1475
diff changeset
    57
  <p>The <a href="../reference/view_console.htm">Console</a> view shows information as the project  and it's SISX file are built and then the build of the installation file (<span class="code">N-GAGE</span>).</p>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    58
    </ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    59
<h3>For On-device Debugging </h3>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    60
<h4>Deploying the N-Gage project   to a device </h4>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    61
<p>Once you have an <span class="code">.N-GAGE</span> game file, you need to deploy it on the target device:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    62
<ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    63
  <li>Verify that you have a valid developer certificate on the target device given to you by the  Nokia R&amp;D Certificate Service. If not, get and install one.</li>
2009
b622387629d6 changed TRK to CODA in docs except where it related to pre-3.0 versions
fturovic <frank.turovich@nokia.com>
parents: 1791
diff changeset
    64
  <li>Verify that you have Application CODA installed on the target device. If not, install it now using <a href="../reference/trk/wnd_new_connection_wizard.htm">On-Device Connections &gt; New Connection Wizard &gt; Install remote agents</a> pane.</li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    65
<li>Manually install the <span class="code">.N-GAGE</span>  file on the device</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    66
</ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    67
<h4>Debugging the Game project</h4>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    68
<p>With your game file installed on the device, create a launch configuration for the project. In Carbide:</p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    69
<ol>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    70
  <li>Open <span class="note"><b>Window &gt; Preferences &gt; Run/Debug &gt;<img src="../images/command_link.png" width="16" height="12"> <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.debug.ui.LaunchingPreferencePage)")'> Launching</a></b> preference panel </span>and disable the <b>Build (if required) before launching</b> option under the General Options group</li>
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    71
  <li>Right-click the project and choose <b>Debug As &gt; Debug Configuration</b> to open the <b><a href="../reference/wnd_debug_configuration.htm">Debug Cinfigurations</a></b> window</li>
2009
b622387629d6 changed TRK to CODA in docs except where it related to pre-3.0 versions
fturovic <frank.turovich@nokia.com>
parents: 1791
diff changeset
    72
  <li><a href="../tasks/projects/prj_debug_config.htm">Create</a> an <b>Symbian OS Application CODA</b> launch configuration
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    73
      <ul>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    74
      <li>In the <b><a href="../projects/launch/page_connection.htm">Connection</a></b> tab select the COM port used to connect to the device. </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    75
      <li> In the <b><a href="../projects/launch/page_installation.htm">Installation</a></b> tab, verify that the game SISX file is correct </li>
2009
b622387629d6 changed TRK to CODA in docs except where it related to pre-3.0 versions
fturovic <frank.turovich@nokia.com>
parents: 1791
diff changeset
    76
      <li>In the <b><a href="../projects/launch/page_debugger.htm">Debug</a></b> tab, enable the View messages between PC and debug agent on the phone if you want to monitor communications between CODA and Carbide </li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    77
    </ul>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    78
  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    79
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    80
  <li>Click <b>Debug</b>    </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    81
</ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    82
<p>The Debugger launches the game project in the device and halts when it encounters the breakpoint you set. </p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    83
<h3>For Emulator Debugging </h3>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    84
<h4>Deploying and debugging the N-Gage project on an emulator</h4>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    85
<p>With your game file installed on the emulator, create a launch configuration for the project. In Carbide:</p>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    86
<ol>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    87
  <li>Open <b>Window &gt; Preferences &gt;   Run/Debug &gt; Launching</b> and disable the <b>Build (if required) before launching</b> option under the General Options group</li>
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    88
  <li>Right-click the project and choose <b>Debug As &gt; Debug Configurations</b> to open the <b>Debug Configurations</b> window</li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    89
  <li>Create an <b>Symbian OS Emulation </b> launch configuration</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    90
  <li>Click <b>Debug</b> to launch the emulator </li>
1475
fb0e02cb252b minor edits and updated images
fturovic <frank.turovich@nokia.com>
parents: 1376
diff changeset
    91
  <li>In the emulator, select <b>File &gt; Open</b>,  locate and select the <span class="code">.N-GAGE</span> installation file and click <b>Open</b> to install the project </li>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    92
  <li>Open the Installation folder, launch the N-Gage runtime application</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    93
  <li>In the N-Gage runtime launch the game  </li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    94
  <li>If any breakpoint is hit in the game project, the debugger suspends</li>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    95
</ol>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    96
<p>From this point you can use all of the debugger features to debug the project. </p>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    97
<p>Always refer to the N-Gage documentation for more information on creating, deploying, and debugging N-Gage projects. </p>
1376
120480c02651 BUG 10758 - copyright revised date to 2010
fturovic <frank.turovich@nokia.com>
parents: 1207
diff changeset
    98
<div id="footer">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
400
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
    99
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   100
</body>
9b005a8e6778 removed duplicate pages, unused images, and fixed links to same
fturovic <frank.turovich@nokia.com>
parents: 0
diff changeset
   101
</html>