Update CE specific FAQ

svn-id: r16248

1 files changed, 182 insertions, 64 deletions

diff --git a/backends/wince/README-WinCE b/backends/wince/README-WinCE
index dd48fa89ac..ebb98ff783 100644
--- a/backends/wince/README-WinCE
+++ b/backends/wince/README-WinCE
@@ -1,19 +1,93 @@
 ScummVM Windows CE FAQ
-Last updated:    2003-08-02
-Release version: 0.5.0
+Last updated:    2004-12-21
+Release version: 0.7.0
 ------------------------------------------------------------------------
 
 This document is intended to give common answers to specific ScummVM
-ScummVM issues on Windows CE, in 3 sections
+issues on Windows CE, in 3 sections
   * "General questions"       : browse this section to get started and see
     general issues
   * "Game specific questions" : lists some common game specific issues
-  * "Support"                 : how to get support if you're still puzzled
+  * "Support and links"       : how to get support if you're still puzzled
 
 ------------------------------------------------------------------------
 General questions
 ------------------------------------------------------------------------
 
+Which devices are supported ?
+-----------------------------
+
+Full support
+------------
+
+* ARM based Windows Mobile handhelds with QVGA resolution (240x320) slower
+  than 200 MHz (PocketPC platform)
+
+All AdLib first generation games should work properly on these devices.
+Sam'n'Max will be a bit too slow to be played with music.
+More recent games (The Dig, Curse of Monkey Island, Broken Sword series)
+and all VGA games will probably be too slow to be enjoyable.
+
+* ARM based Windows Mobile handhelds with QVGA resolution (240x320) faster
+  than 200 MHz
+
+All games should work properly on these devices.
+VGA games will be resized and the font gets hard to read in this case (be sure
+to install the talkie version the game :p)
+
+* ARM based Windows Mobile handhelds with VGA resolution (640x480) 
+
+All non VGA games should work properly on these devices. They can be resized
+with different scalers (not all desktop scalers are supported due to Embedded
+Visual C++ very personal interpretation of the C++ standard).
+VGA games will be displayed in true VGA mode, which can takes a lot of memory
+and slow down the game (especially during scrollings). It will get better in
+the next releases or with faster devices.
+
+* Windows Mobile Smartphones (176x220)
+
+Early support is provided for all 320x200 games.
+The font can get hard to read (you should prefer talkie games, or wear glasses)
+
+Partial / Discontinued support
+------------------------------
+
+Support for the following devices is not complete, not working properly or
+discontinued because the device is now obsolete. Feel free to contribute and
+improve the port for your favorite device, or use the last release built with
+the previous port architecture (0.5.1) which was less resource hungry and
+supported more exotic devices.
+
+* "Paletted" devices (non "true color")
+
+These devices will be supported through the GDI layer which will slow down the
+games a lot. You can try to disable the music/sound effects to get a better
+game experience.
+
+* "Mono" devices
+
+I don't even think anything will be displayed on these devices :) you can try
+and report your success ...
+
+* MIPS/SH3 devices with QVGA resolution (240x320), "true color"
+
+Some devices may be a bit too slow, especially if direct screen access (GAPI)
+is not supported on these devices.  
+
+* ARM/MIPS/SH3 devices with VGA resolution (640x480) (Palm Size PC / Handheld 
+  PC platform)
+
+True VGA games will probably be too slow to run properly on these devices even
+if they can support them ...
+
+* ARM/MIPS/SH3 devices with desktop resolution (800x600) (Handheld PC platform)
+
+No, there will never be ANY scaler supporting 800x600 resolution, because
+320x200 games CANNOT be resized to a 800x600 by a simple operation.
+
+And the device will probably be too slow to perform any kind of graphic
+transform anyway :)
+
 How do I install ScummVM for Windows CE ?
 -----------------------------------------
 
@@ -35,8 +109,8 @@ You'll need to put the data files in a directory named after ScummVM game
 name (see "Supported Game" section in ScummVM readme) for the games having
 "generic" data files (.LFL files). Recent games can be put in any directory.
 
-You can compress the sound files (.SOU) using the "extract" tool described in 
-the ScummVM readme.
+You can compress the multimedia files (sound/video) as described in the
+ScummVM readme.
 
 You can compress the audio tracks of Loom or Monkey Island 1 as described in
 the ScummVM readme. If you are running these games on a slow device with Ogg
@@ -51,18 +125,14 @@ How do I run a game ?
 
 If it's the first time you're running ScummVM for Windows CE, have installed or
 removed games, you need to rescan your game directory. 
- * On Pocket PCs and Handheld PCs, tap the "Scan" button, select your upper 
-   game directory, and tap the "Scan" button again.
- * On Microsoft Smartphone devices, choose the "Scan" option in the "Game" 
-   menu.
-A list of recognized games will be displayed. If your game is not detected 
-check its directory name and your installation.
-
-To play a game
- * On Pocket PCs and Handheld PCs, tap on its name then tap the "Play" 
-   button
- * On Microsoft Smartphone devices, choose it from the "Play" sub-menu in the
-   "Game" menu
+ * Select Scan, tap the root directory of your games, and tap "Yes" to begin
+   an automatic scan of the installed games. 
+
+Usually all games are detected and you can start playing right away. If your 
+game is not detected check its directory name and your data files.
+
+To play a game, tap on its name then tap the "Play" button or double tap its 
+name.
 
 How do I play a game on a Pocket PC or Handheld PC device ?
 -----------------------------------------------------------
@@ -96,11 +166,12 @@ The following actions are available
     - YOU MUST MAP THIS ACTION TO PLAY THE FOLLOWING GAMES -
     - SAM & MAX, BENEATH A STEEL SKY, CURSE OF MONKEY ISLAND -
   * Cursor      : hide or display the mouse cursor
-  * Subtitles   : hide or display the subtitles
-  * Boss        : turn off all sound, blanks the screen, save the game and
-    run the tasks application :)
   * Free look   : go in or out of free-look mode. In this mode, you can tap 
     the screen to look for interesting locations without walking.
+  * Zoom up     : magnify the upper part of the screen for 640x480 games 
+    rendered on a 320x240 device.
+  * Zoom down   : magnify the lower part of the screen for 640x480 games
+    rendered on a 320x240 device.
 
 If you start a game when a Right click mapping is necessary, ScummVM will ask
 you to map one of your hardware key to this action before playing. Just press
@@ -109,23 +180,30 @@ the key you want to map if you see this message.
 How do I play a game on a Microsoft Smartphone device ?
 -------------------------------------------------------
 
-You move the cursor with the "Left", "Right", "Up" and "Down" keys, and click
-with the "Left Click" or "Right Click" keys.
-The cursor will move faster if you keep the key down. 
+When playing on a Smartphone, the cursor and mouse buttons are emulated by
+a set of default keys :
+      4            Move up
+      6            Move down
+      8		   Move left
+      2 	   Move right
+      Hotkey 1     Left mouse button click
+      Hotkey 2     Right mouse button click
+
+A few options are also emulated by a set of default keys :
+
+      0		   Options menu
+      Back	   Skip
+      #		   Zone option
+
+The cursor will move faster if you keep the key down. You can tweak this
+behaviour in the configuration file described below.
 
 The "Zone" key is a *very* valuable addition allowing you to jump quickly 
 between three screen zones : the game zone, the verbs zone and the inventory 
 zone. When you switch to a zone the cursor will be reset to its former location
 in this zone. 
 
-The "Options" key opens ScummVM action menu.
-
-The "Boss" key turns off all sound, blanks the screen, save the game and run 
-the tasks application :)
-
-You can change the keys mapping in the main screen in the "Options" menu. Select
-an action in the "Keys Mapping" submenu, then press the key you want to map to 
-this action.
+You can change the keys mapping during the game in the "Options" menu.
 
 How can I apply a ScummVM command line option (f.e. to change the language) 
 ---------------------------------------------------------------------------
@@ -133,49 +211,80 @@ How can I apply a ScummVM command line option (f.e. to change the language)
 See the section regarding the configuration file (scummvm.ini) in ScummVM
 README file - the same keywords apply.
 
-Some parameters are specific to this port  
+Some parameters are specific to this port :
 
-[wince] section
+game specific section (f.e. [monkey2]) - performance options
 
-NoDirectVideo         bool      Do not try direct video access if GAPI
-                                cannot be found (debug option) if set
-
-Sound                 bool      Comput everything but mute output if set 
-FMHighQuality         bool      Desktop quality FM synthesis if set
-SoundThreadPriority   int       Set the priority of the sound thread
+high_sample_rate       bool      Desktop quality (22 kHz) sound output if set. 
+				11 kHz otherwise.
+                                The default is 11 kHz. 
+				If you have a fast device, you can set this to
+                                true to enjoy better sound effects and music.
+FM_high_quality        bool      Desktop quality FM synthesis if set. Lower 
+				quality otherwise. The default is low quality.
+			        You can change this if you have a fast device.
+sound_thread_priority  int       Set the priority of the sound thread 
                                 (given to SetThreadPriority API)
-NoMusic               bool      Equivalent to -e NULL if set
-DisplayMode           int       0 : Portrait | 1 : Landscape
 
-The following parameters are specific to Microsoft Smartphone devices
+game specific section (f.e. [monkey2]) - game options
+
+landscape	       bool      Run the game in landscape mode if set.
+
+[pocketpc] section - keys definition for Pocket PCs
+
+You usually do not wish to modify these values directly, as they are set 
+by the option dialog, and are only given here for reference.
+
+action_mapping_version int       Mapping version linked to ScummVM version.
+action_mapping         string    Hex codes describing the key associated to
+                                 each different action.
+
+[smartphone] section - keys definition for Smartphones.
 
-[smartfon-keys] section
+You usually do not wish to modify these values directly, as they are set 
+by the option dialog, and are only given here for reference.
 
-RepeatX               int       Number of events before changing horizontal
-                                cursor behaviour 
-StepX1                int       First horizontal cursor increment value
-StepX2                int       Second horizontal cursor increment value
-                                triggered when the key is repeated less than
-                                repeatX 
-StepX3                int       Third horizontal cursor increment value
-                                triggered when the key is repeated more than
-                                repeatX
+action_mapping_version int       Mapping version linked to ScummVM version.
+action_mapping         string    Hex codes describing the key associated to
+                                 each different action.
 
-And you'll guess what RepeatY and StepY do :p
+[smartphone] section - mouse emulation tuning
+
+You can tweak these parameters to customize how the cursor is handled.
+
+repeatTrigger         int       Number of milliseconds a key must be held to
+                                consider being repeated.
+
+repeatX               int       Number of key repeat events before changing
+                                horizontal cursor behaviour.
+stepX1                int       Horizontal cursor offset value when the key is
+                                not repeated.
+stepX2                int       Horizontal cursor offset value when the key is
+                                repeated less than repeatX.
+stepX3                int       Horizontal cursor offset value when the key is
+                                repeated more than repeatX.
+
+
+repeatY               int       Number of key repeat events before changing
+                                vertical cursor behaviour.
+stepY1                int       Vertical cursor offset value when the key is
+                                not repeated.
+stepY2                int       Horizontal cursor offset value when the key is
+                                repeated less than repeatY.
+stepY3                int       Vertical cursor offset value when the key is
+                                repeated more than repeatY.
 
 Game xxx is too slow on my device
 ---------------------------------
 
 Even if it shouldn't happen (this port is running almost correctly on a 
-80 / 120 MHz SPV phone), you can try some things :
-
-  * Disable sound in the engine (add the line "NoMusic = true" to the wince 
-    section of your scummvm.ini file)
-  * Play with the priority of the sound thread (change the SoundThreadPriority
-    value - the higher the lower priority)
+80 / 120 MHz first generation SPV phone), you can try some things :
 
-And don't forget to report your progress in PocketMatrix ScummVM forum
+  * Disable sound in the engine (see the global README)
+  * Play with the priority of the sound thread (change the 
+    sound_thread_priority value - the higher the lower priority)
 
+And don't forget to report your progress in PocketMatrix ScummVM forum !
 
 ------------------------------------------------------------------------
 Game specific questions 
@@ -222,7 +331,8 @@ to lower these requirements.
 Sound synchronization is lost in Curse of Monkey Island videos
 --------------------------------------------------------------
 
-Get a faster device :)
+This is a port bug which is very noticeable in VGA mode. It can probably be
+fixed with a faster blitting routine or a faster device.
 
 --------------------
 -- Full Throttle --
@@ -235,8 +345,7 @@ This game has high memory requirements, and may crash sometimes on low
 memory devices. Continue your game with the latest automatically saved
 game and everything should be fine. 
 You can consider removing the voice file (MONSTER.SOU) and disable the 
-music (add the line "NoMusic = true" to the wince section of your scummvm.ini
-file) to lower these requirements.
+music to lower these requirements.
 
 ----------------------------------------
 -- Indiana Jones and the Last Crusade --
@@ -293,6 +402,15 @@ How can I scroll through my inventory items in Zak Mc Kracken ?
 
 You need to map the hide toolbar button (see the General Questions section).
 
+--------------------
+-- Broken Sword 2 --
+--------------------
+
+I've installed the movies pack but they are not playing
+-------------------------------------------------------
+
+MPEG 2 playback takes too much memory in the current release, and may prevent
+movies from playing in VGA mode. This will get better in the next releases.
 
 ------------------------------------------------------------------------
 Support