Вы находитесь на странице: 1из 22

Getting Started Guide

Getting Started Guide


Introduction
Hardware and Software Requirements
N-Gage™ SDK Installation
Testing N-Gage™ SDK Components
Removing the N-Gage™ SDK
Multiple SDKs on the Same Computer

© Nokia 2005-2009
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
Introduction

Introduction
The Installation Guide contains information on how to test the N-Gage SDK for a successful installation. Review this document if you
have run the installer without reading the guide.

If you have an IDE such as Carbide.c++ 1.1 or later installed, try the N-Gage Game Wizard. The N-Gage Game Wizard creates a basic
application skeleton that uses several N-Gage APIs such as Runtime, Back Buffer and Input. Extending Code discusses the basic
structure of the template, the basis of which you may use to create N-Gage compliant games.

Once an application is successfully run on the S60 Emulator, see "Creating and Signing a SIS Package", and upload the file to the N-
Gage mobile device for installation.

To find out about last minute changes to the N-Gage SDK, review the Release Notes.txt located on the root of your installer CD or
installer archive.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
Hardware and Software Requirements
Required Third-Party Software
Supported Third-Party Software
Recommended Hardware Requirements
Supported Peripheral Hardware
System Software Requirements
Limitations

Hardware and Software Requirements


This section lists the hardware and software requirements of the N-Gage™ SDK. Review the "Required Third-Party Software" section
for N-Gage supported software.

Before you install the N-Gage SDK, the hardware and software requirements must be met, and the required Third-Party software must
be installed.

Installation or removal of the N-Gage SDK requires local administrator rights on the target computer.

Required Third-Party Software


Some third-party software is required for the N-Gage SDK.

z Perl is an interpreted scripting language that is used by various DOS batch files. ActiveState Perl 5.6.1 is available from
www.activestate.com/Products/ActivePerl.
z Java Runtime is required to use Sisar, AIF Builder, CS Help Compiler, and Emulator Preferences. Follow the installation
instructions that come with the software. Java Runtime 1.4.2_02 is available from java.sun.com/downloads/index.html.
z Adobe Reader 7.0 or later is required to view PDF documentation, such as the N-Gage installation, as well as some tools
documentation. Current Adobe Reader software is available free from www.adobe.com/products/acrobat/readstep2.html.

Supported Third-Party Software


The N-Gage SDK includes build tools that support the following compilers:
z GCCE Compiler for target compilation (building for the device)
z ARM RVCT compiler 22 build 503 or newer (building for the device)
z Carbide.c++ 1.1 Professional Edition http://www.forum.nokia.com/main/resources/tools_and_sdks/carbide/

Recommended Hardware Requirements


The recommended hardware configuration for installing and running the N-Gage SDK and Carbide.c++ is:

z 2 GHz processor; x86 architecture (1.2 GHz minimum).


z 1024 MB RAM (512 MB RAM minimum).
z 32-bit color monitor (16-bit minimum).
z 1280 x 1024 pixel screen resolution (1024 x 768 minimum).
z 1 GB free hard disk space (200 MB for Carbide, 600 MB for N-Gage SDK).
z Microsoft Windows compatible sound card is required for audio support.
z Keyboard and mouse.
z See IDE documentation for minimum hardware requirements.

Supported Peripheral Hardware


The following peripheral hardware is supported:

z Bluetooth cards and dongles


{ TDK BRBLU04
{ Brainboxes BL-500
{ Casira (HCI BCSP & H4)
{ Cards supporting HCI BCSP
{ Wrapper for Bluetooth USB dongles (with CSR chipset) at H4 mode
z Infrared devices
{ Extended Systems ESI-9680 RS-232 IR pod (or compatible)
z Network cards
{ Ethernet cards that comply with IEEE 802.3 standards (Ndismedium802_3)

System Software Requirements


The following operating systems are supported:

z Microsoft Windows XP Professional SP2


z Microsoft Windows 2000 SP4

Limitations
In Carbide.c++ v1.3, there are four configuration available for ARM instuctions:
z ARMV5
z ARM9E
z ARMV6
z ARMV6_ABIV1

N-Gage supports ARMV5 only.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
N-Gage SDK Installation
N-Gage SDK Installation Summary
N-Gage SDK Installation Instructions
Carbide.c++ Plug-in Installation

N-Gage SDK Installation


This section describes a typical N-Gage SDK installation. An Acrobat PDF version of this installation guide is included at the root of the
installer directory. The Release Notes.txt documents any last minute changes and can be found in the \NGagedoc\ folder, is
accessible from within the N-Gage Help.

Before you begin the installation, ensure the hardware and software requirements are met, and required Third-Party software has
been installed.

z A local administrator account is required for installation of the N-Gage SDK, Perl, and Java, otherwise some environment
variables may not be set correctly.
z If the default installation path is not accepted, the alternate path selected may not contain whitespace characters.
z The N-Gage SDK, IDE and your project files must be located on the same logical drive in order for the build tools to work
correctly in all situations.
z If a previously installed N-Gage SDK is being updated, first backup or archive the relevant folder located within
C:\Symbian\9.x\ (which is the default N-Gage SDK 2.0 installation path) to avoid potential problems due to the mixing of new
and old files, in the event the installer is cancelled or interrupted. Incomplete installations must be uninstalled by using the
Windows Add or Remove Programs control panel, and the previous NGage_SDK_1.x folder deleted from C:\Symbian\9.x\
before reinstallation is attempted.

NOTE: The N-Gage SDK install or removal process will not remove any foreign folder or project files that may have been added
afterwards, so a clean install will require removal of these files.

N-Gage SDK Installation Summary


The following summarizes the N-Gage SDK installation steps detailed in the N-Gage SDK Installation Instructions section..

z Backup or archive any existing N-Gage SDK installation(s) located within C:\Symbian\9.x\
z Run the N-Gage SDK Installer, setup.exe.
z Splash and Welcome screen appears, click Next.
z License Agreement screen appears, click Yes.
z Choose Destination Location screen appears, select default path and click Next .
{ If selecting an alternate destination, no spaces are allowed in the installation paths.
z Start Copying Files screen appears, click Next.
z Select a Device screen appears, choose NGAGE_SDK_2.0.
z Install Shield Wizard Complete screen appears, click Finish.

Upon completion, go to the Start menu, and locate S60 Developer Tools > N-Gage SDK > 2.0 > N-Gage Help to begin using the N-
Gage SDK.

NOTE: After the SDK is installed, Release Notes.txt can be found in the \NGagedoc\ folder, and is accessible from within the N-Gage
Help, and also from the Emulator: Help > Release Notes (\Epoc32\data\releasenotes.txt)

N-Gage SDK Installation Instructions


The following will take you through the steps needed to install the SDK. Close all applications before running the installer.

1. Start the SDK installation by running setup.exe.

Figure 1. The opening N-Gage SDK InstallShield Wizard N-Gage SDK splash screen.
Figure 2. N-Gage SDK 2.0 installer Welcome screen.

2. Click the Next button to continue. The License Agreement screen is displayed. Read the license agreement or use the Print
button to read a hard copy. Clicking the Yes button signifies that you have read and agree to the license terms, and the
installation will continue.
{ It is possible to select and copy the text of the license agreement and paste it into Word or Notepad.
{ Note that the SDK Help includes a copy of the license agreement for later reference.

Figure 3. The License Agreement screen.


3. At the Choose Destination Location screen, click Next to accept the default path presented.
{ Click the Browse button to select an alternate location.
{ Important: If selecting an alternate installation directory path, there must be no spaces in this path.

Figure 4. Choose Destination Location screen.

4. The Start Copying Files screen (Figure 4) displays a list of the files that will be installed. Click Next to proceed with the
installation.
{ Note: This information may be copied and pasted into Notepad for later reference.
Figure 5. The Start Copying Files screen.

5. The Setup Status screen displays the progress of the installation, which takes approximately 20 minutes.

Figure 6. The Setup Status screen.

6. The Select a Device screen displays the NGAGE_SDK and any previously installed SDKs. Select NGAGE_SDK_2.0 and click
Next.

Note that only one SDK may be checked. Environment variables and other system settings are established depending on which
SDK you choose.
Figure 7. The Select a Device screen displays the NGAGE_SDK_2.0 and other Symbian OS SDKs, such as the S60 3rd Edition
SDK.

7. In the InstallShield Wizard Complete screen, click the Finish button to complete the installation.

Note: A restart is not required to begin using N-Gage SDK components.

Figure 8. The InstallShield Wizard Complete screen.


8. If the CSL Toolchain (for those using the GCCE GNU compiler) installation dialog appears before completing the N-Gage SDK
installation, this may be installed now or later.
{ For later installation, the CSL installer is located at:

C:\Symbian\9.x\NGAGE_SDK_2.0\Epoc32\tools\distrib\arm-none-symbianelf-2005-q1c.exe
{ Use Start > CSL Arm Toolchain to review the README file or to run the uninstaller (Uninstall CSL ARM Toolchain
(arm-symbianelf)).
{ For additional information on the GNU Toolchain, see the Codesourcery website.

NOTE: There are instances where the N-Gage SDK fails to install due to an InstallShield bug. In this case, move the Installshield
runtime directory to the desktop, and run the N-Gage SDK installer again. The InstallSheild runtime files to move are located at:

C:\Program Files\Common Files\InstallShield\Professional\RunTime\11\

Carbide.c++ Plug-in Installation


The SDK includes additional tools and help in the form of Carbide.c++ plugins, which are located at:

z C:\Symbian\9.x\NGAGE_SDK_2.0\NGageTools\wintools\

and

z C:\Symbian\9.x\NGAGE_SDK_2.0\NGageDoc

To install these plug-ins into your Carbide.c++ installation, copy the *.jar and *ocx files to the carbide plugins folder located at (note
that the actual Carbide.c++ installed location may differ):

z C:\Program Files\carbide\plugins\

NOTE: The Java .jar files includes help files that are accessible from within Carbide. Duplicates of these help files in CHM format are
located in the SDK help folder at:

z C:\Symbian\9.x\NGAGE_SDK_2.0\NGageDoc\

To register the Trace plug-in, enter the following command line (click Start > Run) and adjust the path as required to point to the
location of the Trace plug-in:

z regsvr32 C:\Program Files\carbide\plugins\TraceControl.ocx

Windows should respond with a message as follows:

z DllRegisterServer in c:\APPS\carbide\plugins\TraceControl.ocx succeeded.

The Trace plug-in is now installed.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
Testing N-Gage SDK Components
Testing Command Line Tools and Emulator Functionality
Locating Emulator Help
Testing IDE Functionality by Running the N-Gage Game Wizard

Testing N-Gage SDK Components


Now that the N-Gage SDK is installed, the following components may be tested to confirm that the SDK is ready for use:

z Command line tools


z S60 Emulator
z Carbide.c++ 1.1 or later IDE
z N-Gage Game Wizard

Testing Command Line Tools and Emulator Functionality


To test the command line tools and the Emulator, the Audio API Example, audioex will be compiled and run. NOTE: Command-line
building for the Emulator (target is WINSCW) is no longer supported since CodeWarrior (which supplies the tools for this) is no longer
supported. Use Carbide.C++ installation instructions instead.

To verify that SDK command line tools function correctly, follow these steps:

1. Open a command line prompt.

2. Set the N-Gage SDK for Symbian OS for C++ as the default device with the devices command (note that this step is also
performed by the N-Gage SDK installation process):

devices -setdefault @NGAGE_SDK_2.1:com.nokia.s60

3. Go to the directory that contains the audioex example application. In a default installation it can be located with the cd
command:

cd C:\Symbian\9.4\NGAGE_SDK_2.1\NGageExamples\audioex\

4. Go to the group directory, which contains the bld.inf and audioex.mmp files, with the command:

cd group
5. To build the necessary directories, enter the command:

bldmake bldfiles

6. To start the make command that will both compile and link the application for the device, enter the command:

abld build armv5 urel

NOTE: For debugging on the device, udeb can be in place of urel , but corresponding changes needs to be done in the PKG file
for picking the udeb versions of the files residing in the udeb folder path generated from build.

7. Back out of the group folder and enter the sis folder, and create SIS files of the device version of the PKG file,
audioex_armv5.pkg, and the metadata.pkg, with the command:

makesis metadata.pkg
makesis audioex_armv5.pkg

8. Using the developer certificate (*.crt) and password key (*.key), sign both SIS files, audioex_armv5.sis, and metadata.sis,
with the command:

signsis audioex_armv5.sis audioex_armv5.sisx yourcertificate.crt yourkey.key


signsis metadata.sis metadata.sisx yourcertificate.crt yourkey.key

9. Run the makeinstallfile N-Gage command, on the SISX files to create the package installer file, with the command:

makeinstallfile -d audioex_armv5.n-gage -m metadata.sisx -g audioex_armv5.sisx

10. When installing a *.n-gage file on the device, it is best to have Nokia PC Suite installed on the PC and connected to the device
via USB or Bluetooth wireless technology. Begin the installation process by double-clicking the audioex_armv5.n-gage file.
{ Alternatively, copy the *.n-gage file to a flash card or copy it over USB or Bluetooth wireless technology to the C:\ drive
(for example, \Epoc32\winscw\c\data\), and use the S60 File Manager on the device to locate and run the file.

11. When using the Emulator, copy the audioex_winscw.n-gage to the C or E drive and use the File Manager (which is located in
the Organizer folder in the S60 application grid), locate the file and begin the installation by opening it. The N-Gage application
will immediately launch and install the game.

12. To use the auto-install feature of the N-Gage application copy the *.n-gage installation file:
{ c:\data\n-gage\ on the device
{ \Epoc32\winscw\c\data\n-gage\ when using the Emulator

13. Start the Emulator from Start > S60 Developer Tools > N-Gage SDK > 2.1 > Emulator, or use the command:

epoc

14. In the Emulator window, use the scroll keys to navigate to the Installat (Installations) folder, click the center of the navigation
key to open, then select and run the N-Gage application.

NOTE: N-Gage applications will not display in the S60 application grid, they are listed and launched from the Installation > N-
Gage application.
15. Start the N-Gage Application, move to the second tab with the scroll keys, and select the Audio API Example. Use the left soft
key to select Options > Start Game.

Successful operation of the audioex application confirms that the N-Gage SDK command line tools as well as the Emulator have been
installed and are functioning correctly. The "Building and Installing N-Gage SDK Examples" section will provide additional information if
you are using Carbide.c++ to compile for the Emulator.
Locating Emulator Help
The new S60 emulator avaliable since N-Gage SDK 2.0 removes the menus so there is no longer direct access to the online help.
Instead, refer to theEmulator Guide (N-Gage SDK > Tools and Utilities > S60 Tools and Utilities > Emulator Guide. Refer to this guide to
setup features such as Bluetooth wireless technology, IrDA and Ethernet.

Testing IDE Functionality by Running the N-Gage Game Wizard


To check that the N-Gage SDK functions correctly with the Carbide.c++ 1.xIDE, perform the following steps to build the N-Gage Game
Wizard.

1. Install the Game Wizard into Carbide.c++ 1.x by expanding the ZIP file into the root of the Carbide installation. The Game Wizard
plugin and readme file is located at:

C:\Symbian\9.x\NGAGE_SDK_2.1\NGageTools\wizard

2. Start the Carbide IDE, and select File > New > Symbian OS C++ Project from the main menu bar. A dialog box labelled Select
a type of project appears.
3. In the listing of templates, select N-Gage Hello World and click Next.
4. Enter a project name and click OK. (The Use default location setting can remain checked.)
5. In the Symbian OS SDKs dialog box, check NGAGE_SDK_2.1. Click Finish to create a basic N-Gage Hello World program.
6. In Carbide's left pane (C/C++ Projects) right-click on the project folder and select Build Target Only (Ctrl-Alt-B)
7. Build the game PKG file located in the sis folder by right-clicking and selecting Bld PKG File. Do the same with the
Metadata.pkg file to create SIS and signed (SISX) files.
8. Right-click on the project and click Refresh to view newly created SIS and SISX files in the SIS folder.
9. From the command line, use the MakeInstallfile command as follows:

makeinstallfile -m metadata.sisx -g GameWizard.sisx -d GameWizard.n-gage

10. Copy the newly created GameWizard.n-gage file to the Emulator C drive at:

C:\Symbian\9.x\NGAGE_SDK_2.1\Epoc32\winscw\c\data\n-gage

11. Start the Emulator from the command line using epoc command, or from Start > S60 Developer Tools > N-Gage SDK > 2.1 >
Emulator.
12. Run the N-Gage application. The N-Gage application will recognize that there is a new file to be installed and will proceed with
the install. The *.n-gage installer file is deleted as part of the installation process.
{ Alternatively, the S60 File Manager in the Emulator (located inside the Organiser folder) may be used to locate and launch
the .n-gage file with the N-Gage application. In this case, the file may be placed anywhere, not just the c\data\n-gage
folder.
{ The Nokia PC Suite application may be used to install the *.n-gage file to a connected device by double-clicking the file
stored on a PC hard drive.
{ Transfer the *.n-gage file to the device via Bluetooth wireless technology will deliver the file to the Inbox, from where the
installation is initiated from.
13. The N-Gage Hello World application is now visible in the N-Gage application launch screen, as shown in Figure 8.
Figure 9. N-Gage Wizard icon (top) and the opening screen.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
Removing the N-Gage SDK

Removing the N-Gage SDK


Use the Microsoft Windows Control Panel's Add or Remove Programs option to remove the N-Gage SDK. Do not attempt to remove
the SDK manually.

Click the Remove button and acknowledge all InstallShield confirmation prompts to complete the removal.

Figure 10. The Windows XP Add or Remove Programs with the N-Gage SDK selected for removal.

The build number of the SDK is available by clicking the link Click here for support information. Use the build information from this
dialog box when communicating with N-Gage Developer Support.
Figure 11. N-Gage SDK build number.

NOTE: If you have used the Emulator or compiled examples before uninstalling the SDK there may remain some SDK-related files and
folders in the C:\Symbian\9.x\NGAGE_SDK_2.1\ directory even after removing the SDK through the Add or Remove Programs
application. These files and folders need to be removed manually by deleting them in Microsoft Windows Explorer.

Remove the N-Gage SDK by using the control panel Add or Remove Programs, click the Remove button as shown in Figure 10.
Alternatively, run the N-Gage SDK installer again. A Confirm Uninstall dialog box appears as shown in Figure 11; click OK to proceed.

Figure 12. N-Gage SDK 2.1 Confirm Uninstall dialog box.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.
Getting Started Guide

Getting Started Guide


Table of Contents
Getting Started Guide
Multiple SDKs on the Same Computer
Use of the "devices" Command

Multiple SDKs on the Same Computer


It is possible to install multiple SDK installations on the same computer. The devices command is used to establish environment
variables used by the N-Gage SDK.

Use of the "devices" Command


The devices command is used to change between different SDK tool chains. All SDK commands, such as bldmake bldfiles, use the
devices mechanism to query the location of include files, link libraries and required SDK tools. To get a list of installed SDKs, or
"devices," enter the following command in the command prompt:

C:\>devices

A list of installed SDKs is displayed, for example:

S60_3rd_FP1:com.nokia.s60 - default
NGAGE_SDK_2.1:com.nokia.s60

The default device is indicated with –default. In the above case the default device is S60_3rd_FP1:com.nokia.s60. This device is the
one that is used when you call Symbian OS SDK commands such as epoc. To switch between devices, use the -setdefault option of
the devices command:

C:\ devices -setdefault @NGAGE_SDK_2.1:com.nokia.s60

Note: @ is part of the command.

You can verify that the default device has been changed by listing all devices with the devices command:

C:\>devices

The list of installed SDKs is displayed with the new default device:

S60_3rd_FP1:com.nokia.s60
NGAGE_SDK_2.1:com.nokia.s60 - default
To view information about any of the installed SDK devices, the devices -info option can be used:

C:\>devices -info @NGAGE_SDK_2.1:com.nokia.s60


Device: NGAGE_SDK_2.1:com.nokia.s60
Root is C:\Symbian\9.x\NGAGE_SDK_2.1\
Tools path is C:\Symbian\9.x\NGAGE_SDK_2.1\

This information is utilized by Symbian commands. When, for example, the epoc command is executed, a stub command is launched at
C:\Program Files\Common Files\Symbian\tools. The command uses the path information stored by the devices command to
launch the actual Emulator at <Tools_path>\Epoc32\release\wins\udeb\epoc.exe.

NOTE: When building a software project with multiple SDKs, please note the following: after you have changed the device, remember to
regenerate your IDE project and/or makefiles by using the bldmake bldfiles and makmake project.mmp <type> commands.

See the N-Gage SDK documentation for makmake and abld makefile located in the Symbian OS v9.x section for more information.

© 2005-2009 Nokia

This material, including documentation and any related computer programs, is protected by copyright controlled by Nokia. All rights are reserved. Copying, including
reproducing, storing, adapting or translating, any or all of this material requires the prior written consent of Nokia. This material also contains confidential information, which
may not be disclosed to others without the prior written consent of Nokia.

Nokia, N-Gage, and other Nokia product and game names are trademarks or registered trademarks of Nokia Corporation. S60 and logo is a trademark of Nokia Corporation.
Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. Other company and product names mentioned herein may be trademarks
or trade names of their respective owners.

Вам также может понравиться