<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>ScummVM - GP2X SPECIFIC README</title>


</head>


<body>

<span style="font-weight: bold;">ScummVM -
GP2X&nbsp;SPECIFIC README - HEAD SVN<br>

</span>
<hr style="width: 100%; height: 2px;"><br>

<span style="font-weight: bold;">Contents:</span><br>

<ul>

  <li><a href="#About_the_backendport">About the
backend/port</a></li>

  <li><a href="#Game_compatibility">Game
compatability</a></li>

  <li><a href="#Included_engines">Included engines</a></li>

  <li><a href="#Supported_audio_options">Supported
audio options</a></li>

  <li><a href="#Supported_cut-scene_options">Supported
cut-scene options</a></li>

  <li><a href="#Recent_changes">Recent changes</a></li>

  <li><a href="#How_to_save">How to save</a></li>

  <li><a href="#Controller_mappings">Controller
mappings</a></li>

  <li><a href="#Know_issues">Know issues</a></li>

  <li><a href="#Major_TODOs">Major TODO's</a></li>

  <li><a href="#Additional_resourceslinks">Additional
resources/links</a></li>

  <li><a href="#Credits">Credits</a></li>

</ul>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="About_the_backendport"></a><span style="font-weight: bold;">About the backend/port</span><br>

<br>

This is the readme for the offficial GP2X ScummVM backend (also known
as the GP2X port).<br>

<br>

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 <a href="http://www.distant-earth.com/scummvm">http://www.distant-earth.com/scummvm</a>
instead for updated SVN builds.<br>

<br>

Full supported official releases of the GP2X ScummVM backend are made
in line with main official releases and are avalalble from the <a href="http://www.scummvm.org/downloads.php">ScummVM
downloads page</a>.<br>

<br>

This build is in an active state of development and as such no
&lsquo;expected&rsquo; behavior can be guaranteed ;).<br>

<br>

SVN builds are quickly tested with firmware 2.0.0 for reference.<br>

<br>

Please refer to the <a href="http://forums.scummvm.org/viewforum.php?f=14">GP2X
ScummVM forum</a> and <a href="http://wiki.scummvm.org/index.php/GP2X">WiKi</a>
for the latest information on the port.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Game_compatibility"></a><span style="font-weight: bold;">Game compatibility</span><br>

<br>

For information on the compatability of a specific game please refer to
the <a href="http://wiki.scummvm.org/index.php/GP2X#Compatibility_List">GP2X
compatability section of the ScummVM WiKi</a>.<br>

<br>

Please note the version and date of the ScummVM build you are running
when reviewing the above list.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Included_engines"></a><span style="font-weight: bold;">Included engines</span><br>

<br>

Just because an engine is included does not mean any/all of its games
are supported. Please check game compatability for more infomation.<br>

<ul>

  <li>Scumm - (All games supported by ScummVM should work to some
extent, using the hardware scalar if needed)</li>

  <li>AGOS (AKA Simon) - (Simon the Sorcerer one and two).</li>

  <li>Sky - (Beneath a Steel Sky)</li>

  <li>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.</li>

  <li>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.</li>

  <li>Gob - (Goblins one)</li>

  <li>Queen - (Flight of the Amazon Queen)</li>

  <li>Kyra - (The Legend of Kyrandia)</li>

</ul>

All other game engines are disabled in this release.<br>

<br style="font-weight: bold;">

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Supported_audio_options"></a><span style="font-weight: bold;">Supported audio options</span><br>

<br>

Raw audio.<br>

MP3 audio.<br>

OGG Vorbis audio.<br>

<br>

FLAC audio is currently unsupported.<br>

<br>

For best results use uncompressed audio in games.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Supported_cut-scene_options"></a><span style="font-weight: bold;">Supported cut-scene options</span><br>

<br>

No cut scene compression options are currently supported. <br>

<br>

DXA video support will be added as soon as it is stable.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Recent_changes"></a><span style="font-weight: bold;">Recent changes<br>

<br>

</span>Refined audio hacks to reduce audio delay a little more.<br>

Enabled hardware scalar code.<br>

Now built using SDL 1.2.9 for the parts of the port that use SDL (some
parts now hit the hardware directly).<br>

Enabled new launcher - (Ensure defaulttheme.zip is in the same folder
as the executable).<br>

Aspect Ratio Correction can now be disabled &lsquo;per
game&rsquo;. When adding a game you can find this option on the GFX
tab. <br>

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.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="How_to_save"></a><span style="font-weight: bold;">How to save</span><br>

<br>

<span style="font-weight: bold;">NOTE:</span>
Everything is saved to the SD card, saves are stored in the <span style="font-weight: bold;">saves</span> folder under
your main ScummVM executable unless you set another save location.<br>

<br>

The configiration file for ScummVM (.scummvmrc) is stored in the
same place as the ScummVM executable.<br>

<br>

The save process below is&nbsp;for Scumm engine games but the
principle is the same for all.<br>

<br>

In Game.<br>

<br>

1. Right Trigger<br>

2. Select SAVE with B<br>

3. Select a position with B<br>

4. Right trigger puts ? in the name box for some text.<br>

5. Press B to save<br>

<br>

Basically the emulated keys you can use are equivelent to the values
buttons are mapped to, <br>

<br>

I have a virtual keyboard like the GP32 one (left/right on the stick to
pick chars) to add in at some point ;-)<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Controller_mappings"></a><span style="font-weight: bold;">Controller mappings</span><br>

<br>

<span style="font-weight: bold;">Mouse emulation:</span><br>

<br>

Stick: Move Pointer<br>

Stick Click: &lsquo;light&rsquo; Left Click<br>

B: Left click<br>

X: Right click<br>

<br>

<span style="font-weight: bold;">Keyboard emulation:</span><br>

<br>

Start: Return<br>

Select: Escape<br>

Y: Space Bar (Pause)<br>

Right Trigger: Game Menu (Save, Load, Quit etc.)<br>

Volume Buttons: Increase and Decrease volume (5% per press)<br>

<br>

<span style="font-weight: bold;">Fancy button combos:</span><br>

<br>

NOTE: To use button combos press and hold the Left Trigger then...<br>

<br>

Y: Toggle "zoom" mode - Try it in larger games like Broken Sword.<br>

Volume Buttons: Increase and Decrease subtitle speed (In SCUMM games)<br>

Right Trigger: 0 (For skipping the copy protection in Monkey Island 2)<br>

Select: Exit ScummVM completely (and gracefully)<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Know_issues"></a><span style="font-weight: bold;">Know issues</span><br>

<br>

Possible random crash (well SegFault). I have had this happen twice and
have not tracked down the cause. <br>

It happens very infrequently, both times it was in the DOTT CD intro.
Saving often is never a bad idea anyhow.<br>

<br>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Major_TODOs"></a><span style="font-weight: bold;">Major TODO's</span><br>

<br>

Fix save support when using the Sky engine (Beneath a Steel Sky) - You
CAN'T save at the moment but auto save works.<br>

Look into inconsistencies with AGOS engine and map Y key to a button
combination to allow clean quitting (Simon 1/2).<br>

Add splash-screen and pre-ScummVM config menu (CPU speed, LCD timings
etc.) - Partly done.<br>

Fix TV out, maybe make it an option in the pre-ScummVM config menu.<br>

Any help appreciated :).<br>

<br style="font-weight: bold;">

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Additional_resourceslinks"></a><span style="font-weight: bold;">Additional resources/links<br>

<br>

</span><span style="font-weight: bold;">Note:</span>
When providing feedback,
requests, forum posts, bug reports or anything like that always include
a mention of the version of ScummVM you are using (the build version,
date and time can be seen in the main game launcher window).<br>

<ul>

  <li><a href="http://wiki.scummvm.org/index.php/GP2X">ScummVM
WiKi GP2X page</a></li>

  <li><a href="http://forums.scummvm.org/viewforum.php?f=14">ScummVM
forums GP2X forum</a></li>

  <li><a href="http://www.distant-earth.com/scummvm">My
own ScummVM page</a> (for SVN/test builds)</li>

  <li><a href="http://www.scummvm.org">Main ScummVM
site</a> (for official supported release builds)</li>

</ul>

<hr style="width: 100%; height: 2px;"><a style="font-weight: bold;" name="Credits"></a><span style="font-weight: bold;">Credits</span><br>

<br>

Core ScummVM code (c) The ScummVM Team<br>

Portions of the GP2X backend (c) John Willis<br>

Detailed (c) information can be found within the source code<br>

<br>

</body>
</html>