ScummVM for PalmOS v0.6.1 by Chris Apers
Last update : 2004-01-17


  1. Requirement
  2. Installation
  3. How to install a game on a memory card ?
  4. How to select a memory card ?
  5. How to add/edit a game ?
  6. What about sound and music support ?
  7. More options ? (Misc Options form)
  8. About keys and controls

1. Requirement
ScummVM for PalmOS requires an Hi-Res color PalmOS (v3.5 or up) device, a memory card, and at least 860K of free dynamic memory depending of the game. Tungsten|T, T2, and Zire 21 are currently not supported due to system limitation (memory configuration).

2. Installation
You need to install the following from the archive :

ScummVM.prc  :  the program itself
Scumm-Globals.pdb  :  constant data used in Scumm engine
Simon-Globals.pdb  :  constant data used in Simon engine
MathLib.pdb  :  math library (not for Garmin iQue3600)

Lastest version of MathLib can be found on http://www.palmgear.com/
Lastest version of ScummVM can be found on ScummVM for PalmOS Home Page

3. How to install a game on a memory card
If you start ScummVM with a memory card inserted on your palm, ScummVM will create the following directories, if not, you need to create them :

/Palm/Progams/ScummVM  :  location of debug/log file and ScummVM internal configuration file,
you can select the memory card where those files will be created
/Palm/Progams/ScummVM/Games  :  location of games
/Palm/Progams/ScummVM/Saved  :  location of saved states

To install a game on your memory card, just copy the files from your CD/floppies to the .../Games/[my folder] directory where [my folder] is the name of the folder where you want to install the game, example :
You want to play Sam'n'Max Hit the Road, just copy the following files to .../Games/samnmax/ (or any other folder you want) :

samnmax.000
samnmax.001
monster.sou ...
If there is not enough room on your memory card and if you have multiple slots on your device, you can put the missing files on an additional card in the same directory. ScummVM will search for files on all inserted cards. But keep in mind that you cannot switch card while playing.

4. How to select a memory card
To select a memory card, you can tap on the top right memory card icon :

 :  indicate that a memory card has been selected
 :  indicate that a memory card has not been selected

or select 'Memory Card..." from the Tools menu, then you will have the following form :



Now you can select the memory card to store debug/log file and ScummVM internal configuration file.

> Move to memory card on exit
Enable you to copy the game list to your memory card when you quit ScummVM. This let you have a game list per memory card.
> And delete list from device
Delete the list from the device storage memory. If you start ScummVM without a card, the game list will be empty. (only available when Move option is selected)
> Comfirm replace on start/insert
Display a confirmation box and let you decide to replace or not the actual game list. (only available when Move option is selected)

5. How to add/edit a game
You can tap on the ADD or EDIT button, or select New/Edit... from the Tools menu (no entry must be selected to add a game).



> Entry name : name of the game displayed in the game list
> Path : path to the game data files
If the game is located in a sub-folder of .../Games/ you can provide only the folder name with no slash as first charcater (ex : dott/).
If it's located in another directory, you need to privde the full path staring with slash (ex : /Palm/MyGames/SamNMax/).
> Game : ScummVM short name of game (see supported games)

Display modes are :

> Direct : direct draw to the screen, the fastest mode, may have sync problem
> Flipping : use the system page flipping mode, fast and sync
> Buffered : slower, draw first to a buffer then blit to the screen, more compatible than flipping
> Wide (1.5x) : experimental wide display mode (may be very slow... portrait only for now)

Options (see command line options) :

> Talk speed : --talkspeed=NUM
> Load game slot : -x, --save-slot[=NUM]
> Boot parameter : -b, --boot-param=NUM
> Set plateform to : --platform=WORD
> Enable subtitles : -n, --subtitles / -q, --language=LANG (always passed on the command line)

The Delete... button is active only in edition mode.

6. What about sound and music support
Music : Actually, MIDI music is supported only on older Clié devices (Pa1Lib), since Palm doesn't provide midi functions.
Sound FX : Actually sound FX is not supported.
MP3 : Actually MP3 replay [seems] to work only on T615C/T625C with audio adapter, but you can test it on other <OS5 Clié devices.



PalmOS Volume :

> Speaker : set the initial volume of the palm speaker
> Headphone : set the initial volume of the palm headphone

ScummVM Volume (see command line options) :

> Master : -o, --master-volume=NUM
> Music : -m, --music-volume=NUM
> Sound FX : -s, --sfx-volume=NUM

Midi (see command line options) :

> Enable multi midi : --multi-midi (currently not supported)
> Enable music : -e, --music-driver=MODE
Yamaha Pa1 driver is supported only on older Clié devices. There is currenlty no sound on other devices even if you choose another driver.
> Tempo : --tempo=NUM

CD Audio :

> Enable MP3 replay : try to use the Memory Stick Audio library
> Beep : beep when the MSA lib is successfully loaded (currently not supported)
> First track is track number : set the index of the first track in the actual system MP3 play list
> Default track length : set a default length for devices without MP3 support to prevent unexpected scene cut (currently not supported)


7. More options (Misc Options form)
Using Menu > Options > Misc ..., you can access additionnal palm and scumm options.



PalmOS :

> Use vibrator when needed : activate the vibrator when a game need to shake the screen (Day of the Tentacle)
> Disbale Palm auto-off : prevent the device to automatically shutdown while playing
> Use standard palette function : <OS5 devices need a non official palette function to prevent [big] slow down during color cycling
> Auto reset on exit : reset the palm when you quit ScummVM, this may be needed if you have unexpected crashes on exit
> Use larger stack : some games (Simon) may need a bigger stack in order to run properly, you need to restart ScummVM after check/uncheck this option

ScummVM (see command line options) :

> Fullscreen mode : (-f, --fullscreen) hide the virtual slikscreen on devices that support this option
> Keep aspect ratio : (--aspect-ratio) aspect ratio correction for Wide mode (Zodiac only)
> Enable debug level : (-d, --debuglevel=NUM) dump debug infos to the selected memory card
> Demo mode : --demo-mode
> Enable copy protection : --copy-protection


8. About keys and controls
All devices :

 :  [ESC] end cut scene
 :  [F5] show in-game menu in Scumm games
 :  quit (double tap)

Devices with Jog DIal :

> Back : end cut scene
> Push Repeat : show in-game menu in Scumm games

Devices without 5way navigator :

> 1 : left mouse button
> 2 : mouse left
> 3 : mouse up
> 4 : mouse down
> 5 : mouse right
> 6 : right mouse button

Devices with 5way navigator :

> 1 : left mouse button
> 2 : mouse left
> 3 : mouse up
> 4 : mouse down
> 5 : mouse right
> 6 : right mouse button
> 7 : end cut scene
> 8 : show in-game menu in Scumm games

Other keys (see hot keys) :

> COMMAND : switch between COMMAND/CTRL/ALT/[NORMAL] key mode
> CTRL + n : show num pad (mainly for indy3 fight scene, not shown in wide mode)
> COMMAND + a : toggle aspect ratio (Zodiac wide only)