Updates to the GP2X backend specific README-GP2X (and HTML ver)

svn-id: r24239

1 files changed, 146 insertions, 60 deletions

diff --git a/backends/platform/gp2x/build/README-GP2X b/backends/platform/gp2x/build/README-GP2X
index acc3d0d140..cb1d043500 100644
--- a/backends/platform/gp2x/build/README-GP2X
+++ b/backends/platform/gp2x/build/README-GP2X
@@ -1,56 +1,123 @@
-$URL$
-$Id$
+ScummVM - GP2X SPECIFIC README - 0.10.0 SVN
+------------------------------------------------------------------------
+
+Contents:
+
+    * About the backend/port <#About_the_backendport>
+    * Game compatability <#Game_compatibility>
+    * Included engines <#Included_engines>
+    * Supported audio options <#Supported_audio_options>
+    * Supported cut-scene options <#Supported_cut-scene_options>
+    * Recent changes <#Recent_changes>
+    * How to save <#How_to_save>
+    * Controller mappings <#Controller_mappings>
+    * Know issues <#Know_issues>
+    * Major TODO's <#Major_TODOs>
+    * Additional resources/links <#Additional_resourceslinks>
+    * Credits <#Credits>
+
+
+------------------------------------------------------------------------
+About the backend/port
+
+This is the readme for the offficial GP2X ScummVM backend (also known as
+the GP2X port).
+
+This is an SVN test release of ScummVM for the GP2X, it would be
+appreciated if this SVN test distribution was not mirrored and that
+people be directed to http://www.distant-earth.com/scummvm instead for
+updated SVN builds.
+
+Full supported official releases of the GP2X ScummVM backend are made in
+line with main official releases and are avalalble from the ScummVM
+downloads page <http://www.scummvm.org/downloads.php>.
+
+This build is in an active state of development and as such no
+?expected? behavior can be guaranteed ;).
+
+SVN builds are quickly tested with firmware 2.0.0 for reference.
+
+Please refer to the GP2X ScummVM forum
+<http://forums.scummvm.org/viewforum.php?f=14> and WiKi
+<http://wiki.scummvm.org/index.php/GP2X> for the latest information on
+the port.
+
+------------------------------------------------------------------------
+Game compatibility
+
+For information on the compatability of a specific game please refer to
+the GP2X compatability section of the ScummVM WiKi
+<http://wiki.scummvm.org/index.php/GP2X#Compatibility_List>.
+
+Please note the version and date of the ScummVM build you are running
+when reviewing the above list.
+
+------------------------------------------------------------------------
+Included engines
+
+Just because an engine is included does not mean any/all of its games
+are supported. Please check game compatability for more infomation.
+
+    * Scumm - (All games supported by ScummVM should work to some
+      extent, using the hardware scalar if needed)
+    * AGOS (AKA Simon) - (Simon the Sorcerer one and two).
+    * Sky - (Beneath a Steel Sky)
+    * Sword - (Broken Sword 1) - This engine uses the hardware scalar to
+      downsize the graphics to fix on the GP2X. It is NOT very nice to
+      look at.
+    * Sword2 - (Broken Sword 2) - This engine uses the hardware scalar
+      to downsize the graphics to fix on the GP2X. It is NOT very nice
+      to look at.
+    * Gob - (Goblins one)
+    * Queen - (Flight of the Amazon Queen)
+    * Kyra - (The Legend of Kyrandia)
 
-DO NOT USE THIS FOR ANYTHING OTHER THEN TO TEST A USB MOUSE.
-IT'S BUGGY AND ANYTHING OTHER THEN THE 320*2xx LucasArts GAMES 
-WILL MOST LIGHTLY CRASH YOUR GP2X.
-
-THE README IS BELOW JUST FOR REFERANCE.
-
-ScummVM for the GP2X - UNSTABLE MOUSE TEST - 0.10.0 SVN
--------------------------------------------------------
-
-This is a test release of ScummVM for the GP2X, it would be appreciated if this alpha test distribution was not mirrored and that people be directed to http://www.distant-earth.com/scummvm instead, until the port is a little more mature, to ensure people download the most recent builds.
-
-This build is still in a very heavy state of development and as such no ‘expected’ behaviour can be guaranteed ;).
-I tested with firmware 1.2.1 for reference.
+All other game engines are disabled in this release.
 
-INCLUDED ENGINES:
+------------------------------------------------------------------------
+Supported audio options
 
-Scumm - (All games supported by ScummVM should work to some extent, using the hardware scalar if needed)
+Raw audio.
+MP3 audio.
+OGG Vorbis audio.
 
-// Simon - (Simon the Sorcerer one and two)
-// Sky - (Beneath a Steel Sky)
-// Sword - (Broken Sword 1) - This engine uses the hardware scalar to downsize the graphics to fix on the GP2X. It is NOT very nice to look at.
-// Sword2 - (Broken Sword 2) - This engine uses the hardware scalar to downsize the graphics to fix on the GP2X. It is NOT very nice to look at.
-// Gob - (Goblins one)
-// Queen - Flight of the Amazon Queen
-// Kyra - (The Legend of Kyrandia) - This engine is still under heavy development in ScummVM, however the game is playable.
-// Lure - (Lure of the Temptress) - This engine is still under heavy development in ScummVM, the game is not yet really playable.
+FLAC audio is currently unsupported.
 
+For best results use uncompressed audio in games.
 
-All other game engines are disabled in this release.
+------------------------------------------------------------------------
+Supported cut-scene options
 
-SUPPORTED AUDIO OPTIONS:
+No cut scene compression options are currently supported.
 
-Raw audio.
-MP3 audio.
-OGG Vorbis audio (this may be problematic, I just made some big changes to my Tremor code).
+DXA video support will be added as soon as it is stable.
 
-RECENT CHANGES:
+------------------------------------------------------------------------
+Recent changes
 
 Refined audio hacks to reduce audio delay a little more.
 Enabled hardware scalar code.
-Now built using SDL 1.2.9 for the parts of the port that use SDL (some parts now hit the hardware directly).
-Enabled new launcher - (Ensure defaulttheme.zip is in the same folder as the executable).
-Aspect Ratio Correction can now be disabled ‘per game’. When adding a game you can find this option on the GFX tab. 
-Note: This will cause the game to run with a black border at the bottom as it will be rendered to a 320*200 frame.
+Now built using SDL 1.2.9 for the parts of the port that use SDL (some
+parts now hit the hardware directly).
+Enabled new launcher - (Ensure defaulttheme.zip is in the same folder as
+the executable).
+Aspect Ratio Correction can now be disabled ?per game?. When adding a
+game you can find this option on the GFX tab.
+Note: This will cause the game to run with a black border at the bottom
+as it will be rendered to a 320*200 frame.
+
+------------------------------------------------------------------------
+How to save
 
-HOW TO SAVE:
+NOTE: Everything is saved to the SD card, saves are stored in the saves
+folder under your main ScummVM executable unless you set another save
+location.
 
-NOTE: Everything is saved to the SD card, saves are stored in the game folder, and the config file for ScummVM (.scummvmrc) is stored in the same place as the GPE.
+The configiration file for ScummVM (.scummvmrc) is stored in the same
+place as the ScummVM executable.
 
-Ok, this is for Scumm engine games but the principle is the same for all.
+The save process below is for Scumm engine games but the principle is
+the same for all.
 
 In Game.
 
@@ -60,22 +127,23 @@ In Game.
 4. Right trigger puts ? in the name box for some text.
 5. Press B to save
 
-Basically the emulated keys you have are what I mapped the buttons to, 
-I have a virtual keyboard like the GP32 one (left/right on the stick to pick chars) to add in at some point ;-)
+Basically the emulated keys you can use are equivelent to the values
+buttons are mapped to,
 
-CONTROLLER MAPPING:
+I have a virtual keyboard like the GP32 one (left/right on the stick to
+pick chars) to add in at some point ;-)
 
-NOTE: The controller mappings have recently changed somewhat so please review the new setup.
-This is subject to change; it still does not ‘feel’ quite right.
+------------------------------------------------------------------------
+Controller mappings
 
-Mouse Emulation:
+Mouse emulation:
 
 Stick: Move Pointer
-Stick Click: ‘light’ Left Click
+Stick Click: ?light? Left Click
 B: Left click
 X: Right click
 
-Keyboard Emulation:
+Keyboard emulation:
 
 Start: Return
 Select: Escape
@@ -87,28 +155,46 @@ Fancy button combos:
 
 NOTE: To use button combos press and hold the Left Trigger then...
 
+Y: Toggle "zoom" mode - Try it in larger games like Broken Sword.
 Volume Buttons: Increase and Decrease subtitle speed (In SCUMM games)
 Right Trigger: 0 (For skipping the copy protection in Monkey Island 2)
-Select: Exit ScummVM completely
-(More to add, ideas please)
+Select: Exit ScummVM completely (and gracefully)
 
-KNOWN ISSUES:
+------------------------------------------------------------------------
+Know issues
 
-Possible random crash (well SegFault). I have had this happen twice and have not tracked down the cause. 
-It happens very infrequently, both times it was in the DOTT CD intro. Saving often is never a bad idea anyhow.
+Possible random crash (well SegFault). I have had this happen twice and
+have not tracked down the cause.
+It happens very infrequently, both times it was in the DOTT CD intro.
+Saving often is never a bad idea anyhow.
 
-Volume level changes can be a little inconsistent at times.
+------------------------------------------------------------------------
+Major TODO's
 
-MAJOR TODOS:
-
-Fix save support when using the Sky engine (Beneath a Steel Sky) - You CAN'T save at the moment but auto save works.
-Look into inconsistencies with Simon engine and map Y key to a button combination to allow clean quitting (Simon 1/2).
-Add splash-screen and pre-ScummVM config menu (CPU speed, LCD timings etc.) - Partly done.
+Fix save support when using the Sky engine (Beneath a Steel Sky) - You
+CAN'T save at the moment but auto save works.
+Look into inconsistencies with AGOS engine and map Y key to a button
+combination to allow clean quitting (Simon 1/2).
+Add splash-screen and pre-ScummVM config menu (CPU speed, LCD timings
+etc.) - Partly done.
 Fix TV out, maybe make it an option in the pre-ScummVM config menu.
 Any help appreciated :).
 
-SOURCE:
+------------------------------------------------------------------------
+Additional resources/links
+
+    * ScummVM WiKi GP2X page <http://wiki.scummvm.org/index.php/GP2X>
+    * ScummVM forums GP2X forum
+      <http://forums.scummvm.org/viewforum.php?f=14>
+    * My own ScummVM page <http://www.distant-earth.com/scummvm> (for
+      SVN/test builds)
+    * Main ScummVM site <http://www.scummvm.org> (for official supported
+      release builds)
+
+------------------------------------------------------------------------
+Credits
 
-Port source is available on request. Note this is development code (and VERY messy).
+Core ScummVM code (c) The ScummVM Team
+Portions of the GP2X backend (c) John Willis
+Detailed (c) information can be found within the source code
 
-John Willis
\ No newline at end of file