release_notes.txt

RGA: Biowaste Game Example This C++ application demonstrates how to create a 2D mobile game for S60

RGA: Biowaste Game Example
-----------------------------------------------

This C++ application demonstrates how to create a 2D mobile game for S60 devices using Real-Time Graphics and Audio (RGA) APIs.

--------------------------------------------------------------------------------

PREREQUISITES

Symbian C++ basics
Game Programming
RGA plugin
OpenC plugin

--------------------------------------------------------------------------------

IMPORTANT FILES/CLASSES

data\
Game level file(s)
Application resource files (rss)

docs\
Design documents and release notes

gfx\
Application graphics files and application icon file
All required graphics are exported in emulator build

group\
Build files

inc\
Application header files

sis\
Installation package creation files
ARMV5 compiled, non signed SIS file

snd\
Application sound files

src\
Application source files


--------------------------------------------------------------------------------

REQUIRED CAPABILITIES

ReadUserData SwEvent

    
--------------------------------------------------------------------------------


KNOWN ISSUES

- The application is not shown in the task list and it cannot be closed by pressing
  the End key. This applies to all RGA applications and it is expected to be fixed in future releases.

- No error message if application initialisation fails (just exit).
- Performance problems with bitmap rotate and alphablending.
- All sounds are uncompressed WAV files, unable to load compressed WAV files.
- Audio playback latency is high.
- Audio playback produces "crackles" and noise to sound output.



--------------------------------------------------------------------------------


RUNNING THE EXAMPLE

The application is a two-dimensional game, viewed from top down. The purpose of the game is to guide a bio-waste ball through a maze in a limited time, avoiding ghosts who try to block the way of the player.

Intro:
- Use any key to skip intro

Menu:
- Use navigation up/down to select menu item
- Use left softkey, right softkey, or middle of directional to select menu items

Game:
- Use navigation up/down/left/right to move player
- Use left softkey, right softkey, or middle of directional to pause the game

In Game Performace tracking:
- Press '5' on numpad to toggle FPS display

--------------------------------------------------------------------------------

BUILD & INSTALLATION INSTRUCTIONS

To compile the example on an S60 3rd Edition SDK, you need to have the Open C and RGA plug-ins installed. The plugins are published in the  OpenC/C++ plug-ins package, available at: 
http://www.forum.nokia.com/info/sw.nokia.com/id/91d89929-fb8c-4d66-bea0-227e42df9053/Open_C_SDK_Plug-In.html

Steps for building and installing the application to a device depend on the S60
platform version:

--Mobile device (S60 3rd Edition)
    cd to /RGAExample/group
    bldmake bldfiles
    abld build gcce urel
    cd to /RGAExample/sis
    makesis RGAExample.pkg
    
    Sign the SIS package 
    - This example cannot be self-signed since RGA requires SwEvent capability.
      see: www.symbiansigned.com for information about Developer Certificates.

    Install the signed .sis file to a S60 3rd Edition device.
    The device must  be an official N-Gage-certified device and both the RGA and Open C plug-ins need to be installed.
    
--Emulator (WINSCW)
    cd to /RGAExample/group
    bldmake bldfiles
    abld build winscw udeb
    Start the emulator.


--Carbide.c++ IDE

    1. Make sure that the path for current Carbide workspace does not contain
       any whitespace characters. If necessary, select a new workspace folder
       in Carbide (File -> Switch workspace). 
    2. Extract the example package to a temporary folder. 
    3. Select File -> Import -> Symbian MMP File, click Browse and find the .mmp
       file you want to import, and select the appropriate SDK/configurations.
       Check that 'Copy source files into workspace' is selected, then click
       Finish.
      
      The project is now ready to be built. 

    --Mobile device (S60 3rd Edition)
        Select Project -> Properties -> C/C++ Build
        Set Configuration: "S60 3.0 Phone (GCCE) Release" and press OK.
        Select Project -> Build project.

        Install the signed .sis file to a S60 3rd Edition device.

    --Emulator (WINSCW)
        Select Project -> Properties -> C/C++ Build.
        Set Configuration: "S60 3.0 Emulator Debug" and press OK.
        Select Project -> Build project.
        Select Run -> Run As -> Run Symbian OS Application.
    
--------------------------------------------------------------------------------

COMPATIBILITY

S60 3rd Edition (N-Gage-qualified devices)
S60 3rd Edition, FP1 (N-Gage-qualified devices)
(S60 3rd Edition, FP2 (N-Gage-qualified devices))
   
Tested on Nokia N82 and Nokia N95.

Developed and tested using S60 3rd Edition MR SDK (with  RGA plug-in and OpenC plug-in installed) and Carbide.c++ 1.2.
    
--------------------------------------------------------------------------------

VERSION HISTORY

1.0    First version

--------------------------------------------------------------------------------
EVALUATE THIS RESOURCE   

Please spare a moment to help us improve documentation quality and recognize
the examples you find most valuable, by rating this resource at http://www.forum.nokia.com/main/1%2C%2C90%2C00.html?surveyId=0aaff2d2-adc8-444c-b3a2-0ad483245925/RGA_Biowaste_Game_Example_v1_0_beta_en.zip.