6.2 ScummVM for the Zaurus

6.2 ScummVM for the Zaurus

HoloVector's picture
Posted by HoloVector on Mon, 01/21/2008 - 04:15

Welcome to the homepage of ScummVM@tyrannozaurus

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

Table of Contents

Introduction
Acknowledgements
Downloads
What Games are Supported?
Configuration Tips
What files are needed?
Audio File Compression How-To
Video File Compression How-To
Adding a Game to the ScummVM Main Screen
In Game Controls
Available Themes
Hints and Walkthroughs
Useful Links

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

Introduction

This is a joint project between HoloVector and Antikx that strives to provide the fullest and best ScummVM experience for clamshell (CXX0 and CXX00) Zaurus users under the pdaXrom distro. One the main goals of project is to provide an accelerated ScummVM that could run Broken Sword MPEG2 cut scenes smoothly. Most of the previous builds for the Sharp-based and pdaxrom-based ROMs out there could not run the MPEG2 cut scenes from the Broken Sword games. The OE-based ports could only run jerky reencoded cut scenes at 320x240 because they lacked bvdd support. This version can run these cut scenes at 480x304 with minimal dropped frames.

Please comment below or PM us if you have comments or suggestions.
Please go to the project page and submit bugs and feature requests for the IPK.
-------------------------------------------------------------------------------------

Acknowledgements

Like all open source projects this port became a reality thanks to the work of many diverse people. We would like to take this opportunity to thank them. They are:

The ScummVM Team for making a great and highly portable interpreter for many of our favorite games and then creating the infamous ScummVM Tools that allows us to compress the data files to a more suitable Zaurus size.

Antikx for taking the time to build this port and host not only the ipk but all the associate files in the Downloads section and this home page.

Meanie for building his native GCC environment for the Zaurus and helping Antikx with the build details.

The pdaXrom Team for building the best Zaurus distro to run ScummVM on, IMHO .

Alex/Alez for creating the run script, desktop shortcut, keyboard remap and the original 0.9.0 Modern theme ipk.

kkazakov13 for creating the updated 0.9.1 theme ipks for Modern, Modern Ice, Modern Blue and Modern Dark.

Arisme for hosting the Broken Sword cutscene re-encoding package and creating the mini how-to for it.

bgbennyboy for creating the graphical ScummVM ToolBox for Windows.
-------------------------------------------------------------------------------------

Downloads

Here's the goodies...
Project page: get ipk here
Broken Sword 1 videos in English: bs1video
Broken Sword 1 videos in French/en Francais: bs1videofr
Broken Sword 2 videos in English: bs2video
Broken Sword 2 videos in French/en Francais: bs2videofr
Modern Theme: Modern
Modern Ice Theme: Modern Ice
Modern Blue Theme: Modern Blue
Modern Dark Theme: Modern Dark
-------------------------------------------------------------------------------------

What Games are Supported

The original scope of the main ScummVM project (not the Zaurus off-shoot) was to support all the Graphic Adventure games from LucasFilm Games/LucasArts that were written for the Scripting Creation Utility for Maniac Mansion (AKA SCUMM) engine so that the games could run on more modern computers and platforms that the original interpreters were never ported to (like the Zaurus). Later on it was decided to increase the scope of the project to include many other game engines.

Here is the basic list of supported games in this version:

LucasArts/Lucasfilm Games

Maniac Mansion
Zak McKracken and the Alien Mindbenders
Indiana Jones and the Last Crusade (A Graphic Adventure)
LOOM
The Secret of Monkey Island
Monkey Island 2: LeChuck's Revenge
Indiana Jones and the Fate of Atlantis (A Graphic Adventure)
Maniac Mansion 2: Day of the Tentacle
Sam & Max Hit the Road
Full Throttle
The Dig
The Curse of Monkey Island

Revolution Software

Beneath a Steel Sky*
Broken Sword 1: The Shadow of the Templars (AKA The Circle of Blood)
Broken Sword 2: The Smoking Mirror

Interactive Binary Illusions

Flight of Amazon Queen*

Coktel Vision

Gobliiins

The Dreamer's Guild/Wyrmkeep Entertainment Company

Inherit the Earth: Quest for the Orb

Adventure Soft Publishing Limited

Simon the Sorceror 1
Simon the Sorceror 2
The Feeble Files

Westwood Studios

The Legend of Kyrandia 1*

and a whole lot of Humongous Entertainment Games

A more complete compatibility list can be found here. Not all versions of the games are supported or are not completely supported so please check the above link for more detailed information. A general rule of thumb for support in ScummVM is that if you have the DOS or Windows version of a game it is highly likely that it will be completely supported.

Games marked with a * are either freely available for download or require additional files which you can get by clicking on the *. You do not need to download the Broken Sword cut scenes that are linked on the above page because they are unsuitable for use with the Zaurus. Please use the cut scenes above in our Downloads section.

The publishers of Beneath a Steel Sky and Flight of the Amazon Queen have graciously donated the source code for these games to the ScummVM team and have released these games as freeware so you can freely download them and play them in ScummVM. Many thanks to Revolution Software, John Passfield and Steve Stamatiadis for their wonderful donations.
-------------------------------------------------------------------------------------

Configuration Tips

To get the full ScummVM experience we recommend that you run ScummVM in Fullscreen mode with the Aspect ratio correction turned on and the AdvMAME2x graphics filter turned on. ScummVM will run slightly faster when you enable Fullscreen mode and use the optimized AdvMAME2x filter. The main purpose of the AdvMAME2x is to smoothly scale the graphics up to 640x480 without the nasty looking jaggies but, as an added benefit this filter is bvdd or ati accerelated thanks to it's dependency on SDL to do it's magic. We recommend AdvMAME2x because is well suited to the Zaurus due to it's low system requirements compared to the similar hq2x filter which was designed for a desktop environment. Aspect ratio correction is needed to fix the mouse cursor positioning in the scaled up games and prevent graphics distortion that would make a circle look like an oval.

You can turn on the Fullscreen mode and Aspect ratio correction by tapping on the Options button on the main GUI screen and then tapping on the checkboxes for both of those options. Both boxes should then have x's in them. Don't tap the OK button yet because we still need to turn on the graphics filter.

To turn on the AdvMAME 2x graphics filter tap and hold on the double headed arrows for the Graphics mode. A large list of the graphics filters will appear. Keeping your pen pressed to the screen, slide the tip to highlight the AdvMAME2x entry and release the pen tip from the screen. The Graphics mode box should then say AdvMAME2x.

After that tap the OK button to save and close the Options screen and then tap on the Quit button to exit ScummVM. You need to quit to enable the changes you just made.
-------------------------------------------------------------------------------------

What files are needed?

Because ScummVM is replacing the original interpreter you will only need the core data files in order play the game. This is a good thing since it will cut down on the amount of space you will need on your Zaurus. The following link lists the main files required in order to play the supported games. If you follow its guidance closely you will have a working game under ScummVM on Zaurus that will take the least amount of space. Audio and Video compression is covered in the next section

http://wiki.scummvm.org/index.php/Datafiles

Once you have determined what files you require you need to copy it over to your Zaurus. If you are copying it to a 3x00, we highly recommend copying under the /data/ folder (which links to hdc3)on those units. For the other clamshells we recommend copying the files over to /mnt/card/. Make sure that each game has its own subfolder. Here are a couple example layouts for you to consider:

/data/Documents/Game_Files/indy4/
or
/mnt/card/scummvm/zakfm/
-------------------------------------------------------------------------------------

Audio File Compression How-To

There are many types of audio used in the supported games such as sound effects, dialog, and music. The one thing that these audio types have in common is that the audio, in most cases, is stored in low or uncompressed formats. Uncompressed audio takes a significant amount of space so, it is in your best interest to compress the audio of these games.

ScummVM offers many choices for alternate audio formats, these include MP3, Ogg Vorbis, and FLAC. FLAC is not recommended for the Zaurus since this lossless format will actually create larger files than the original uncompressed files. Ogg Vorbis on the Zaurus has performance issues and therefore can lead to gameplay degradation. Therefore, MP3 should be your target format for the Zaurus since MP3 will give you the best performance/compression ratio of these choices.

You will require a copy of the lame encoder in order to perform these compression steps. Here is a link to a DOS based one that I have used. Depending on which type of compression you need to perform; it is possible to do some of this encoding on your Zaurus if you have a significant amount of disk space. However, since you will need a CD-ROM drive or in some cases a floppy drive to extract the raw audio files I recommend using a desktop platform of your choice instead.

Some of the games will require that you use something called the ScummVM Tools in addition to the lame encoder because of the way the audio was stored. The command line based ScummVM Tools are precompiled for the following platforms: Windows, Fedora Core 2 and 4, Mac OS X Universal, Solaris 8 and 10 and Atari/FreeMint. Since ScummVM is a LGPL licensed project, the source to the tools is available for your compiling pleasure. Please note that there are no plans at this time to compile these tools for the Zaurus but, you never know... Also note that there is a GUI front-end for Windows available for some of the ScummVM Tools tools called the ScummVM ToolBox. You can find it here.

Instead of reinventing wheel explaining the steps required to compress the audio for some of the supported games I will merely point you to the ScummVM 0.9.1 Read Me file which is located here. The section you require is 7.7.

I will spell out which subsection instructions you need to use for which game though so, here we go:

7.7.0 - Zak McKracken and the Alien Mindbenders (FM Towns only), Indiana Jones and the Last Crusade (FM Towns only), LOOM (PC CD and FM Towns), and The Secret of Monkey Island (PC CD and FM Towns)

7.7.3 - Monkey Island 2: LeChuck's Revenge (FM Towns only), Indiana Jones and the Fate of Atlantis (PC CD, Mac CD* and FM Towns), Maniac Mansion 2: Day of the Tentacle (PC CD, PC Floppy, and Mac CD*), Sam & Max Hit the Road (PC CD, PC Floppy and Mac CD*), Full Throttle (PC CD and Mac CD*)

7.7.6 - Simon the Sorceror 1 and 2 and The Feeble Files

7.7.7 - Broken Sword 1 (note this is for in game audio not the video cut scenes mentioned above)

7.7.8 - Broken Sword 2 (note this is for in game audio not the video cut scenes mentioned above)

* = The Mac CD monster.sou audio is stored in a single file called Game Name Data that also contains the rest of the game files. In order to compress the monster.sou file you will need to split up the Data file into it's component parts first (effectively turning it into the PC version) and then running the SOU compression utility. The ScummVM tool you would use to break up the Data file is called

extract_scumm_mac

The following games do not have their compression instructions included in the above linked ScummVM 0.9.1 ReadMe so, I will quote the ScummVM Tools ReadMe file included in the ScummVm Tools download instead.

For Full Throttle, The Dig and The Curse of Monkey Island follow these directions and compress the audio to MP3.

"compress_scumm_bun [inputfile] [inputdir] [outputdir] [--ogg] Compresses '.bun' music/voice files.

Example of usage: compress_scumm.bun digmusic.bun uncomp comp
For the Ogg or Mad compression feature, your ScummVM binary naturally must have been built with Ogg or Mad support enabled."

For The Legend of Kyrandia 1 follow these directions and compress the audio to MP3

"compress_kyra Used to compress The Legend of Kyrandia's speech files with MP3, Vorbis or FLAC.

Example of usage: compress_kyra [flags here] input/GEMCUT.VRM output/GEMCUT.VRM

Note: You have to keep the VRM extension, else it will NOT work. Use it like shown above, copy all *.VRM files to a directory and let the tool put the output file in another directory."

The flag you want to use in this case is --mp3
-------------------------------------------------------------------------------------

Video File Compression How-To

Several of the supported games use complex animated cut scenes to help move their stories along. Due the age of some of these games the cut scenes are using non-compressed video and audio formats. In order minimize the disk footprint of these games on your Zaurus it is in your best interest to compress these cut scenes using the tools mentioned below.

The following LucasArts Games make use of SMUSH formatted animation, Full Throttle, The Dig and The Curse of Monkey Island. You can one again use the ScummVM Tools or the ScummVM ToolBox for Windows previously mentioned in the Audio File Compression How-To above. Here is a quote from the ScummVM Tools readme on SMUSH compression tools usage.

"compress_scumm_san [inputfile] [inputdir] [outputdir] [--ogg]
Compresses '.san' smush animation files. It uses lossless
zlib for compressing FOBJ gfx chunks inside a san file.
It also can create a separate Ogg file with the audio track.

Example of usage: compress_Scumm_san opening.san uncomp comp

In order to use such compressed files, your ScummVM binary must have been built with zlib support enabled (you can find out whether that's the case by looking at the About dialog). For the Ogg or Mad compression feature, your ScummVM binary naturally must have been built with Ogg or Mad support enabled.

NOTE: For some '.san' files there is a corresponding '.flu' file, which contains offsets into the '.san' file. Hence, the compress_scumm_san has to modify the '.flu' file. This happens automatically, if the '.san' and '.flu' files are in the same directory (which is normally the case). If you want to move the '.san' files before compressing them, make sure to
move the '.flu' files, too!"

The Revolution games Broken Sword 1 and 2 also use an unsuitable, for the Zaurus, animation format called Smacker. The owners of the format, RADTools, have specifically requested that the ScummVM team does not reverse engineer the format. Luckily, Revolution Games have allowed the cut scenes to be reencoded into MPEG2 and Ogg Vorbis. Those cut scenes are currently posted on the Main ScummVM download page but, as I mentioned above those cut scenes are not appropriate for the Zaurus. Which is why we have included downloads to the reencoded cut scenes on this page.

However, some of you may want to play the games in a different language then what we have included in our downloads so, therefore this section will detail the tools and steps needed to roll your own cut scenes.

This process will require a Windows PC because the RADTools Smacker decoder only runs under Windows. In theory you might be able to do this through WINE but, it is not something we have tested.

You can find the conversion files (bsvideo.rar) required and the basic instructions to perform this in post #2 on the following link. In addition you will need a copy of the LAME encoder which you can find here.
-------------------------------------------------------------------------------------

Adding a Game to the ScummVM Main Screen

By this point you will have grabbed the files you need to run games, compressed the audio and video as needed and copied it all over to your Zaurus. Now you want to start playing them. This section walks you through adding a game to the ScummVM GUI mainscreen for quick startups so, let's get to it.

After starting ScummVM, tap the Add game button.

The Selection Window will open. Navigate to the location on your Zaurus where your individual game sublfolders are located. Tap once on the subfolder you want to add to the main screen to highlight it and then tap the Choose button.

The Game Details window will open. If you wish you can make any changes to entries like perhaps setting the platform, etc.... This is optional because the majority of the time the defaults are just fine.

Tap the OK button and you will return the ScummVM mainscreen with your new entry listed. Repeat these steps as needed to add the remainder of the games to the mainscreen list.

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

In Game Controls

Because there are multiple game engines supported by the ScummVM interpreter (some of which the original source code was provided to the team) there are multiple control keys and combinations (referred to as hot keys) included in ScummVM in order to execute certain actions. To make matters more interesting some of these hot keys (eg. Save and Load) are mapped to the function keys on most other platforms. The Zaurus typically does not have function keys so, a keymap was developed to provide this functionality. Listed below are the key hot keys that one will need to know in order to complete a game in ScummVM. There are many more than these but in the interest of brevity we are only going to include the essentials. Please note that the following game engine short cut keys could not be tested at this time due to a lack ownership of these supported titles. They are the AdventureSoft Publishing (Feeble Files, Simon the Sorceror 1 and 2), Westwood Games (The Legend of Kyrandia 1), Coktel Vision (Gobliiins), WyrmKeep Entertainment (Inherit the Earth) and the Humongous Entertainment games. For the sake of completeness we will include the known hot keys that should work but, please bear in mind that they have not been tested on a Zaurus.

Common Hot Keys

Ctrl-q - Quits the game you are running and exits the ScummVM without saving your progress

Alt-Enter - Toggles full screen/windowed . Alt is the Kanji key to the right of the Ctrl key

LucasArts (SCUMM) Hot Keys

Menu or Right Rocker - Displays a save/load box with in game options, help and quit

Space - Pauses the game

Cancel - Skips the active cutscene

Fn-Tap - Simulates right click

Beneath a Steel Sky Hot Keys

Menu or Right Rocker - Displays a save/load box with in game options, and quit

Cancel - skips the game intro

Fn-Tap - Simulates right click

Broken Sword 1

Menu or Right Rocker or Cancel - Displays save/load box with in game options and quit

Cancel - skips the active cutscene

Taping the upper black bar of the screen - Displays your inventory

Fn-Tap - Simulates right click

Broken Sword 2

Tapping the the upper black bar of the screen - Displays save/load box with in game options and quit

Fn-Tap - Simulates right click

P - Pauses the game

Cancel - skips the active cutscene

Flight of the Amazon Queen

Menu or Right Rocker - Displays the Journal a save/load box with in game options, and quit

Fn-Tap - Simulates right click

Cancel - skips the active cutscene

Simon the Sorceror 1 and 2

Ctrl 0-9 and Alt 0-9 - Load and save game state. Alt is the Kanji key to the right of the Ctrl key

p - Pauses the game

The Feeble Files

F7 - Switch characters

p - Pauses the game

The Legend of Kyrandia

Ctrl 0-9 and Alt 0-9 - Load and save game state. Alt is the Kanji key to the right of the Ctrl key

Tap on the blue gem on the lower left of the screen - Displays save/load box with in game options and quit

We have not found out what the default hot keys are for Gobliiins, Inherit the Earth and the Humongous Entertainment games.

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

Available Themes

Starting with ScummVM 0.9.0, GUI Themes were incorporated. This allows you to replace the default retro black and green GUI with a more "modern" look.

Default Classic Theme

There are currently four themes ported over to the Zaurus and they are available in IPKG format. They are:

Modern

Modern Ice

Modern Blue

Modern Dark

Unfortunately, since this is a new feature; the GUI selector is not working properly so it only works by manually specifying the path and renaming the theme to modern.ini and modern.zip (if you want to use one the other themes besides the Modern one) since that theme name is hard coded in theme engine.

To activate a theme you must follow the steps outlined below:

Install the ipk of your choice (or install them all if you want to). This can be done via the GUI installer or from the console.

If you have chosen the Modern Ice, Blue or Dark themes follow the next three steps. If you chose the Modern theme skip the next three steps and continue on to the end of this section. Start up a the file manager of your choice or use the command line to navigate to /usr/share/scummvm/themes.

Rename the modern.ini and modern.zip to modern-orange.ini and modern-orange.zip if you chose to install that one as well your preferred theme.

Rename your preferred theme to modern.ini and modern.zip

If you started a file manager or console session close it and start ScummVM.

Tap on the Options button then tap on the Paths tab and you should see this.

Tap on the Theme Path: button and navigate to the themes directory which is located under /usr/share/scummvm/themes/ and then tap the Choose button.

Exit and restart ScummVM and it should now load with the theme of your choice.
-------------------------------------------------------------------------------------

Hints and Walkthroughs

There are many resources on the internet that provide hints and walkthroughs. In this section we will highlight some of our favorite hints and walkthroughs:

LucasArts/Lucasfilm Games

Maniac Mansion | hints | walkthrough |

Zak McKracken and the Alien Mindbenders | hints | walkthrough |

Indiana Jones and the Last Crusade (A Graphic Adventure) | hints | walkthrough |

LOOM | hints | walkthrough |

The Secret of Monkey Island | hints | walkthrough |

Monkey Island 2: LeChuck's Revenge | hints | walkthrough |

Indiana Jones and the Fate of Atlantis (A Graphic Adventure) | hints | walkthrough |

Maniac Mansion 2: Day of the Tentacle | hints | walkthrough |

Sam & Max Hit the Road | hints | walkthrough |

Full Throttle | hints | walkthrough |

The Dig | hints | walkthrough |

The Curse of Monkey Island | hints | walkthrough |

Revolution Software

Beneath a Steel Sky | hints | walkthrough |

Broken Sword 1: The Shadow of the Templars (AKA The Circle of Blood) | hints | walkthrough |

Broken Sword 2: The Smoking Mirror | hints | walkthrough |

Interactive Binary Illusions

Flight of Amazon Queen | hints | walkthrough |

Coktel Vision

Gobliiins | hints | walkthrough |

The Dreamer's Guild/Wyrmkeep Entertainment Company

Inherit the Earth: Quest for the Orb | hints | walkthrough |

Adventure Soft Publishing Limited

Simon the Sorceror 1 | hints | walkthrough |

Simon the Sorceror 2 | hints | walkthrough |

The Feeble Files | hints | walkthrough |

Westwood Studios

The Legend of Kyrandia 1 | hints | walkthrough |

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

Useful Links

Here are some links that you may find useful and interesting. Links to Abandonware and Pirated games are not permitted.

Where to acquire these games

eBay for LucasArts, Westwood, Coktel Vision and Humongous Games

AdventureSoft for Feeble Files, Simon the Sorcerer 1 and 2

Wyrmkeep for Inherit the Earth

Sold Out! for the Broken Sword Double Pack or 1 and 2 individually

ScummVM for Beneath a Steel Sky and Flight of the Amazon Queen

Background Information on the Games

Moby Games

Adventure Gamers

LucasFilm Games and LucasArts

The International House of Mojo

LucasArts Museum

The Zak McKracken Archive

Revolution Software

Broken Sword Planet

Beneath a Steel Sky Installer

Interactive Binary Illusions

Flight of the Amazon Queen Installer

Coktel Vision

Gobliiins at Vintage Sierra

The Dreamer's Guild/Wyrmkeep Entertainment Company

Inherit the Earth Web Comic

AdventureSoft Publishing

The Best Simon the Sorcerer fanpage

Westwood Studios

None at this time