Open main menu

Difference between revisions of "User Manual"

198 bytes removed ,  17:59, 1 December 2007
Remove the top heading "user's manual"
(→‎Appendix: Tools: clarified TODO a bit)
(Remove the top heading "user's manual")
Line 15: Line 15:




= User's Guide =
= Introduction =
 
== What is ScummVM? ==
== Introduction ==
=== What is ScummVM? ===
ScummVM is a program which allows you to run certain classic graphical
ScummVM is a program which allows you to run certain classic graphical
point-and-click adventure games, provided you already have their data
point-and-click adventure games, provided you already have their data
Line 48: Line 46:
easier and quicker. If you cannot donate, help and contribute a patch!
easier and quicker. If you cannot donate, help and contribute a patch!


=== Reporting bugs ===
== Reporting bugs ==
To report a bug, please create a [http://sourceforge.net SourceForge account],
To report a bug, please create a [http://sourceforge.net SourceForge account],
then use our [http://sourceforge.net/tracker/?group_id=37116&atid=418820 bug tracker]
then use our [http://sourceforge.net/tracker/?group_id=37116&atid=418820 bug tracker]
Line 73: Line 71:
This should only take you a little time but will make it much easier for us to process your bug report in a way that satisfies both you and us.
This should only take you a little time but will make it much easier for us to process your bug report in a way that satisfies both you and us.


=== Contacting the developers ===
== Contacting the developers ==
The easiest way to contact the ScummVM team is by submitting bug reports (see reporting-bugs) or by using our
The easiest way to contact the ScummVM team is by submitting bug reports (see reporting-bugs) or by using our
[http://forums.scummvm.org forums]. You can also join and email the scummvm-devel mailing list (see
[http://forums.scummvm.org forums]. You can also join and email the scummvm-devel mailing list (see
Line 81: Line 79:
[http://www.scummvm.org/faq.php our FAQ] for an explanation.
[http://www.scummvm.org/faq.php our FAQ] for an explanation.


== Getting started ==
= Getting started =


=== Requirements ===
== Requirements ==
TODO: List Requirements (in terms of required/optional libraries, CPU power, memory, ... In particular it would be nice if we could e.g. say what PalmOS devices support ScummVM; not necessarily a list of all supported Palm models, but more a list of what OS you need how much memory, colors, etc.)
TODO: List Requirements (in terms of required/optional libraries, CPU power, memory, ... In particular it would be nice if we could e.g. say what PalmOS devices support ScummVM; not necessarily a list of all supported Palm models, but more a list of what OS you need how much memory, colors, etc.)


Line 116: Line 114:
If you plan to compile ScummVM yourself, you will need certain additional libraries. More on that in [[#Compiling from sources | Compiling from sources]].
If you plan to compile ScummVM yourself, you will need certain additional libraries. More on that in [[#Compiling from sources | Compiling from sources]].


=== How to obtain ScummVM ===
== How to obtain ScummVM ==
Basically you have two choices on how to get ScummVM: either you download one of the binaries we built for you (probably the most convenient way); or you can compile it yourself from source. For beginners, we strongly recommend using our prebuilt binaries.
Basically you have two choices on how to get ScummVM: either you download one of the binaries we built for you (probably the most convenient way); or you can compile it yourself from source. For beginners, we strongly recommend using our prebuilt binaries.


==== Binaries ====
=== Binaries ===
You can download official binaries of ScummVM from our [http://www.scummvm.org/downloads.php downloads page]. Go there with your favorite web browser and download the binary for your platform. If none is available, you may have to build ScummVM yourself, refer to the next section for instructions on how to do that. Alternatively, some third parties are providing unofficial ScummVM binaries for further platforms, but naturally, we can not make any statements about the quality of such unofficial builds - use them at your own risk!
You can download official binaries of ScummVM from our [http://www.scummvm.org/downloads.php downloads page]. Go there with your favorite web browser and download the binary for your platform. If none is available, you may have to build ScummVM yourself, refer to the next section for instructions on how to do that. Alternatively, some third parties are providing unofficial ScummVM binaries for further platforms, but naturally, we can not make any statements about the quality of such unofficial builds - use them at your own risk!


Line 144: Line 142:
*OS/2
*OS/2


==== Compiling from sources ====
=== Compiling from sources ===
TODO:
TODO:
* Point to the [[Compiling ScummVM]] page, resp. integrate that here.
* Point to the [[Compiling ScummVM]] page, resp. integrate that here.
Line 152: Line 150:




=== Installation ===
== Installation ==
After you have obtained ScummVM as described in the previous section, you will probably want to install it on your system. The steps required for that differ between the various operating systems. In the following we try to cover all the systems we officially support.
After you have obtained ScummVM as described in the previous section, you will probably want to install it on your system. The steps required for that differ between the various operating systems. In the following we try to cover all the systems we officially support.


==== Debian ====
=== Debian ===
From the downloads page, download the Debian .deb package. To install it, you need to be root and type ''dpkg -i packagename.deb'' into a virtual terminal near you.
From the downloads page, download the Debian .deb package. To install it, you need to be root and type ''dpkg -i packagename.deb'' into a virtual terminal near you.


==== Fedora Core / Redhat ====
=== Fedora Core / Redhat ===
TODO
TODO


==== Slackware ====
=== Slackware ===
TODO
TODO


==== Amiga OS4 ====
=== Amiga OS4 ===
From the downloads page, get the AmigaOS4 package. You will download a packed archive (.lha). To open it, double click on it and UnArc will unpack right away or ask for the installation path. Once it is unpacked, you can move the whole drawer where ever you wish to store it.
From the downloads page, get the AmigaOS4 package. You will download a packed archive (.lha). To open it, double click on it and UnArc will unpack right away or ask for the installation path. Once it is unpacked, you can move the whole drawer where ever you wish to store it.


==== Windows ====
=== Windows ===
From the downloads page, download either the Win32 .zip file or the Win32 .exe file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. If you download the .exe installer, you will get options where you want to install it. Choose the location to where you want to install it. Also, the installer places a shortcut in the Start Menu.
From the downloads page, download either the Win32 .zip file or the Win32 .exe file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. If you download the .exe installer, you will get options where you want to install it. Choose the location to where you want to install it. Also, the installer places a shortcut in the Start Menu.


==== Mac OS X ====
=== Mac OS X ===
From the downloads page, download the "Mac OS X Universal Binary" file. You will download a disk image (.dmg). To open it, double click on it and Disk Copy will mount the image. Once it is mounted, copy the files inside to a folder where you wish to store it.
From the downloads page, download the "Mac OS X Universal Binary" file. You will download a disk image (.dmg). To open it, double click on it and Disk Copy will mount the image. Once it is mounted, copy the files inside to a folder where you wish to store it.


==== Windows Mobile (WinCE / PocketPC / Smartphone) ====
=== Windows Mobile (WinCE / PocketPC / Smartphone) ===
Create a folder on your device to put ScummVM into, e.g. "\My Device\SD-MMcard\ScummVM". From the downloads page, download the "Windows CE ARM package" zip file. Extract everything from this file, and place it all in the folder that you created on your device (using ActiveSync or similar: note that if your chosen location is short of space, the only absolutely ''required'' file is "scummvm.exe"). To run ScummVM just tap on "scummvm.exe" in File Explorer: you may wish to copy a shortcut of "scummvm.exe" to your Start Menu to allow for easier access.
Create a folder on your device to put ScummVM into, e.g. "\My Device\SD-MMcard\ScummVM". From the downloads page, download the "Windows CE ARM package" zip file. Extract everything from this file, and place it all in the folder that you created on your device (using ActiveSync or similar: note that if your chosen location is short of space, the only absolutely ''required'' file is "scummvm.exe"). To run ScummVM just tap on "scummvm.exe" in File Explorer: you may wish to copy a shortcut of "scummvm.exe" to your Start Menu to allow for easier access.


==== PalmOS ====
=== PalmOS ===
From the downloads page, download the "PalmOS 5 binary" or the "PalmOS Tapwave Zodiac binary" and unzip the files to your computer. Using your hotsync tool, install the scummvm-frontend.prc and skin.pdb files to your device. Launch ScummVM to create the /PALM/Programs/ScummVM/ folders and subfolders on your memory card. Using a card reader, copy the engines you require to play your games to the /ScummVM/Mods/ folder on your card (scumm.engine for scumm games, queen.engine for FOTAQ, etc.)
From the downloads page, download the "PalmOS 5 binary" or the "PalmOS Tapwave Zodiac binary" and unzip the files to your computer. Using your hotsync tool, install the scummvm-frontend.prc and skin.pdb files to your device. Launch ScummVM to create the /PALM/Programs/ScummVM/ folders and subfolders on your memory card. Using a card reader, copy the engines you require to play your games to the /ScummVM/Mods/ folder on your card (scumm.engine for scumm games, queen.engine for FOTAQ, etc.)


==== Symbian / EPOC ====
=== Symbian / EPOC ===
TODO
TODO


==== Nintendo DS ====
=== Nintendo DS ===
TODO
TODO


==== Dreamcast ====
=== Dreamcast ===
From the downloads page, download either the Dreamcast .zip file or the Nero image file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. The Nero image can be burned automatically to a CD using Nero Burning ROM or any other program that accepts NRG formatted disc images.
From the downloads page, download either the Dreamcast .zip file or the Nero image file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. The Nero image can be burned automatically to a CD using Nero Burning ROM or any other program that accepts NRG formatted disc images.


==== GP2X ====
=== GP2X ===
TODO
TODO


==== GP32 ====
=== GP32 ===
TODO
TODO


==== PlayStation 2 ====
=== PlayStation 2 ===
TODO
TODO


==== PlayStation Portable ====
=== PlayStation Portable ===
TODO
TODO


=== First steps ===
== First steps ==


== Running and using ScummVM ==
= Running and using ScummVM =
=== The Launcher ===
== The Launcher ==
==== Managing your games ====
=== Managing your games ===
===== Adding a game =====
==== Adding a game ====
Before you can play a game using ScummVM, you first need to ''add'' it to the Launcher.
Before you can play a game using ScummVM, you first need to ''add'' it to the Launcher.
# Your game will run more smoothly if you copy all the files from the original disk(s) (whether floppy or CD) into a folder on your hard-drive.
# Your game will run more smoothly if you copy all the files from the original disk(s) (whether floppy or CD) into a folder on your hard-drive.
Line 213: Line 211:
# {{ManualScreenshot|name=Launcherwithgame.png|desc=The ScummVM Launcher with one game added}} Tada! You've added your first game to ScummVM. To play it now, just select the game you want to play and click on the Start button.{{-}}
# {{ManualScreenshot|name=Launcherwithgame.png|desc=The ScummVM Launcher with one game added}} Tada! You've added your first game to ScummVM. To play it now, just select the game you want to play and click on the Start button.{{-}}


===== Adding multiple games at once =====
==== Adding multiple games at once ====


# {{ManualScreenshot|name=Massadd.png | desc=Confirmation dialog for mass add}} If all of your games are in separate subdirectories of one "games" directory, you can add all of your games at once. Simply hold down the "shift" key, and the "Add Game..." button will switch to being a "Mass Add..." button. If you click on it, the ScummVM Launcher will ask you to confirm that you really do want to do this.{{-}}
# {{ManualScreenshot|name=Massadd.png | desc=Confirmation dialog for mass add}} If all of your games are in separate subdirectories of one "games" directory, you can add all of your games at once. Simply hold down the "shift" key, and the "Add Game..." button will switch to being a "Mass Add..." button. If you click on it, the ScummVM Launcher will ask you to confirm that you really do want to do this.{{-}}
Line 219: Line 217:
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.{{-}}
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.{{-}}


===== Removing a game =====
==== Removing a game ====
{{ManualScreenshot|name=Deletegame.png|desc=Dialog to confirm deletion}} To remove a game from the ScummVM Launcher, just select the game you want to remove and click the "Remove Game" button on the right-hand side. ScummVM will ask you whether you are sure you want to remove it, so click yes to remove it. Note that this will not delete the game files from your hard drive: you can easily re-add it again later.{{-}}
{{ManualScreenshot|name=Deletegame.png|desc=Dialog to confirm deletion}} To remove a game from the ScummVM Launcher, just select the game you want to remove and click the "Remove Game" button on the right-hand side. ScummVM will ask you whether you are sure you want to remove it, so click yes to remove it. Note that this will not delete the game files from your hard drive: you can easily re-add it again later.{{-}}


==== Configuring the Launcher and configuring individual games ====
=== Configuring the Launcher and configuring individual games ===
There are many options to change the way that ScummVM runs games: for discussion of these options see the [[#Configuration|configuration]] section.
There are many options to change the way that ScummVM runs games: for discussion of these options see the [[#Configuration|configuration]] section.


=== Running ScummVM from the command line ===
== Running ScummVM from the command line ==
As well as starting your ScummVM games using the graphical Launcher, you can also start them from the command line. The simplest way to run a game from the command line is to type, for example:
As well as starting your ScummVM games using the graphical Launcher, you can also start them from the command line. The simplest way to run a game from the command line is to type, for example:
<pre>scummvm samnmax</pre>
<pre>scummvm samnmax</pre>
Line 241: Line 239:
if you want to override a setting in the configuration file.
if you want to override a setting in the configuration file.


==== Command line options ====
=== Command line options ===
{|class="wikitable"
{|class="wikitable"
|+ <pre>scummvm [OPTIONS] GAME</pre>
|+ <pre>scummvm [OPTIONS] GAME</pre>
Line 410: Line 408:
|}
|}


==== Examples of Command Line Usage ====
=== Examples of Command Line Usage ===
;Running Monkey Island, fullscreen, from a hard disk (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey</code>
;Running Monkey Island, fullscreen, from a hard disk (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey</code>
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft</code>
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft</code>
Line 416: Line 414:
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix):<code>/path/to/scummvm -f -n -p/cdrom/resource/ ft</code>
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix):<code>/path/to/scummvm -f -n -p/cdrom/resource/ ft</code>


=== Hotkeys ===
== Hotkeys ==
TODO
TODO


=== Saving and loading ===
== Saving and loading ==
TODO
TODO


=== Macintosh games: Accesing HFS filesystems ===
== Macintosh games: Accesing HFS filesystems ==
You will need the "Windows Installer" from the download page. To copy the game data file from the CD to your hard disc, you will need [http://home.earthlink.net/~gamba2/pc2mac.html HFVExplorer]. Make sure you get the "HFV Explorer installer" rather than the zip file. When you choose to download the zip file, make sure you read the readme included with HFVExplorer, to set it up properly. Run the HFVExplorer installer and allow it to use its defaults.
You will need the "Windows Installer" from the download page. To copy the game data file from the CD to your hard disc, you will need [http://home.earthlink.net/~gamba2/pc2mac.html HFVExplorer]. Make sure you get the "HFV Explorer installer" rather than the zip file. When you choose to download the zip file, make sure you read the readme included with HFVExplorer, to set it up properly. Run the HFVExplorer installer and allow it to use its defaults.


Line 433: Line 431:
More details (including how to use extract_scumm_mac) can be found at [[HOWTO-Mac_Games]], a wiki page dedicated specifically to Macintosh games.
More details (including how to use extract_scumm_mac) can be found at [[HOWTO-Mac_Games]], a wiki page dedicated specifically to Macintosh games.


=== Multi-CD games ===
== Multi-CD games ==
In general, ScummVM does not deal very well with multi-CD games. This is because ScummVM assumes everything about a game can be found in one directory. Even if ScummVM does make some provisions for asking the user to change CD, the original games usually install a small number of files to hard disk. Unless these files can be found on all the CDs, ScummVM will be in trouble.
In general, ScummVM does not deal very well with multi-CD games. This is because ScummVM assumes everything about a game can be found in one directory. Even if ScummVM does make some provisions for asking the user to change CD, the original games usually install a small number of files to hard disk. Unless these files can be found on all the CDs, ScummVM will be in trouble.


Line 442: Line 440:
The instructions for the Broken Sword games are for the Sold-Out Software versions, which are the ones you are probably most likely to find in stores now.
The instructions for the Broken Sword games are for the Sold-Out Software versions, which are the ones you are probably most likely to find in stores now.


==== The Curse of Monkey Island ====
=== The Curse of Monkey Island ===
For this game, you will need the comi.la0, comi.la1 and comi.la2 files. The comi.la0 file can be found on either CD, but since they are identical it doesn't matter which one of them you use.
For this game, you will need the comi.la0, comi.la1 and comi.la2 files. The comi.la0 file can be found on either CD, but since they are identical it doesn't matter which one of them you use.


In addition, you will need a resource subdirectory with all of the files from the resource subdirectories on both CDs. Some of the files appear on both CDs, but again they're identical.
In addition, you will need a resource subdirectory with all of the files from the resource subdirectories on both CDs. Some of the files appear on both CDs, but again they're identical.


==== Broken Sword 1 ====
=== Broken Sword 1 ===
For this game, you will need all of the files from the clusters directories on both CDs. You will also need the speech.clu files from the speech directories, but since they are not identical you will need to rename them speech1.clu and speech2.clu for CD 1 and 2 respectively.
For this game, you will need all of the files from the clusters directories on both CDs. You will also need the speech.clu files from the speech directories, but since they are not identical you will need to rename them speech1.clu and speech2.clu for CD 1 and 2 respectively.


Line 454: Line 452:
ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them.
ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them.


==== Broken Sword 2 ====
=== Broken Sword 2 ===
For this game, you will need all of the files from the clusters directories on both CDs. (Actually, a few of them may not be strictly necessary, but the ones that I’m uncertain about are all fairly small.) You will need to rename the speech.clu and music.clu files speech1.clu, speech2.clu, music1.clu and music2.clu so that ScummVM can tell which ones are from CD 1 and which ones are from CD 2. Any other files that appear in both cluster directories are identical. Use whichever you like.
For this game, you will need all of the files from the clusters directories on both CDs. (Actually, a few of them may not be strictly necessary, but the ones that I’m uncertain about are all fairly small.) You will need to rename the speech.clu and music.clu files speech1.clu, speech2.clu, music1.clu and music2.clu so that ScummVM can tell which ones are from CD 1 and which ones are from CD 2. Any other files that appear in both cluster directories are identical. Use whichever you like.


Line 461: Line 459:
ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them.
ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them.


==== The Feeble Files ====
=== The Feeble Files ===


TODO
TODO


== Configuration ==
= Configuration =
=== Using the Launcher to configure ScummVM ===
== Using the Launcher to configure ScummVM ==
The ScummVM Launcher gives us a graphical method for changing the settings that it uses to run games. There are two ways to do this: firstly by changing the default settings (which games will follow unless told otherwise), secondly by overriding an individual game to use settings that are different from the defaults. To begin with we will look at changing the default settings. To do this, click on the "Options" button on the right-hand side of the Launcher window. There are many options, and they are separated into tabs: we shall look at each tab in turn.
The ScummVM Launcher gives us a graphical method for changing the settings that it uses to run games. There are two ways to do this: firstly by changing the default settings (which games will follow unless told otherwise), secondly by overriding an individual game to use settings that are different from the defaults. To begin with we will look at changing the default settings. To do this, click on the "Options" button on the right-hand side of the Launcher window. There are many options, and they are separated into tabs: we shall look at each tab in turn.


==== Graphics tab ====
=== Graphics tab ===
{{ManualScreenshot|name=Graphicstab.png|desc=The Graphics tab of the ScummVM options}}
{{ManualScreenshot|name=Graphicstab.png|desc=The Graphics tab of the ScummVM options}}
The graphics tab allows us to change various things about the way the games are displayed on screen when played.
The graphics tab allows us to change various things about the way the games are displayed on screen when played.
Line 491: Line 489:
{{-}}
{{-}}


==== Audio tab ====
=== Audio tab ===
{{ManualScreenshot|name=Audiotab.png|desc=The Audio tab}}The audio tab in the options allows us to change various things about the way that sound is outputted in ScummVM games.
{{ManualScreenshot|name=Audiotab.png|desc=The Audio tab}}The audio tab in the options allows us to change various things about the way that sound is outputted in ScummVM games.
{|class="wikitable"
{|class="wikitable"
Line 512: Line 510:
{{-}}
{{-}}


==== Volume tab ====
=== Volume tab ===
{{ManualScreenshot|name=Volumetab.png|desc=The Volume tab}}The volume tab allows us to set the relative volumes for the various different types of sound that ScummVM plays.
{{ManualScreenshot|name=Volumetab.png|desc=The Volume tab}}The volume tab allows us to set the relative volumes for the various different types of sound that ScummVM plays.
{|class="wikitable"
{|class="wikitable"
Line 530: Line 528:
{{-}}
{{-}}


==== MIDI tab ====
=== MIDI tab ===
{{ManualScreenshot|name=Miditab.png|desc=The MIDI tab}} The MIDI tab lets us change various settings about the MIDI music played back in games.
{{ManualScreenshot|name=Miditab.png|desc=The MIDI tab}} The MIDI tab lets us change various settings about the MIDI music played back in games.
{|class="wikitable"
{|class="wikitable"
Line 554: Line 552:
{{-}}
{{-}}


==== Paths tab ====
=== Paths tab ===
{{ManualScreenshot|name=Pathstab.png|desc=The Paths tab}}This part of the options lets the user tell ScummVM where to look for particular files
{{ManualScreenshot|name=Pathstab.png|desc=The Paths tab}}This part of the options lets the user tell ScummVM where to look for particular files
{|class="wikitable"
{|class="wikitable"
Line 575: Line 573:
{{-}}
{{-}}


==== Misc tab ====
=== Misc tab ===
{{ManualScreenshot|name=Misctab.png|desc=The Misc tab}}The Misc tab contains options that don't belong on any of the other tabs.
{{ManualScreenshot|name=Misctab.png|desc=The Misc tab}}The Misc tab contains options that don't belong on any of the other tabs.
{|class="wikitable"
{|class="wikitable"
Line 591: Line 589:
{{-}}
{{-}}


=== Using the configuration file to configure ScummVM ===
== Using the configuration file to configure ScummVM ==
When you change a setting in the ScummVM Launcher (see [[#Using_the_Launcher_to_configure_ScummVM |Using the Launcher to configure ScummVM]]), all it does is add a line to the ''configuration file''. This is a plain text file which stores all the settings for ScummVM. It is possible to edit this file directly, and some settings can only be changed this way.
When you change a setting in the ScummVM Launcher (see [[#Using_the_Launcher_to_configure_ScummVM |Using the Launcher to configure ScummVM]]), all it does is add a line to the ''configuration file''. This is a plain text file which stores all the settings for ScummVM. It is possible to edit this file directly, and some settings can only be changed this way.


Line 624: Line 622:
Note: all Windows versions will use <windir>\scummvm.ini if it already exists.
Note: all Windows versions will use <windir>\scummvm.ini if it already exists.


==== All config file switches in detail ====
=== All config file switches in detail ===


=== Graphic filters ===
== Graphic filters ==


ScummVM offers several anti-aliasing filters to attempt to improve visual
ScummVM offers several anti-aliasing filters to attempt to improve visual
Line 703: Line 701:
Likewise, games that were originally 640x480 (such as Curse of Monkey Island or the Broken Sword games) will be scaled to 1280x960 (2x) and 1920x1440 (3x).
Likewise, games that were originally 640x480 (such as Curse of Monkey Island or the Broken Sword games) will be scaled to 1280x960 (2x) and 1920x1440 (3x).


=== Music and Sound ===
== Music and Sound ==
==== Music drivers ====
=== Music drivers ===
==== Using compressed audio files ====
=== Using compressed audio files ===
==== Output sample rate ====
=== Output sample rate ===
The output sample rate tells ScummVM how many sound samples to play per channel per second. There is much that could be said on this subject, but most of it is beyond the scope of this document. The short version is that for most games 22050 Hz is fine, but in some cases 44100 Hz is preferable. On extremely low-end systems you may want to use 11025 Hz, but it’s unlikely that you will have to worry about that.
The output sample rate tells ScummVM how many sound samples to play per channel per second. There is much that could be said on this subject, but most of it is beyond the scope of this document. The short version is that for most games 22050 Hz is fine, but in some cases 44100 Hz is preferable. On extremely low-end systems you may want to use 11025 Hz, but it’s unlikely that you will have to worry about that.


Line 717: Line 715:
Using frequencies in between is not recommended. For one thing, your sound card may not support it. In theory, ScummVM should fall back on a sensible frequency in that case, but don’t count on it. More importantly, ScummVM has to resample all sounds to its output frequency. This is much easier to do well if the output frequency is a multiple of the original frequency.
Using frequencies in between is not recommended. For one thing, your sound card may not support it. In theory, ScummVM should fall back on a sensible frequency in that case, but don’t count on it. More importantly, ScummVM has to resample all sounds to its output frequency. This is much easier to do well if the output frequency is a multiple of the original frequency.


== Appendix: Supported games ==
= Appendix: Supported games =
The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility_stable.php Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page].  
The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility_stable.php Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page].  
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.


== Appendix: Tools ==
= Appendix: Tools =
{| border="0" cellpadding="2" cellspacing="1"  style="margin:1em; background:#FF0000;"
{| border="0" cellpadding="2" cellspacing="1"  style="margin:1em; background:#FF0000;"
|- style="background:#ffffff"
|- style="background:#ffffff"
Line 729: Line 727:
This is a collection of various tools that may be useful to use in conjunction with ScummVM. Please note that although a tool may support a feature, certain ScummVM versions may not. ScummVM 0.6.x does not support FLAC audio, for example.
This is a collection of various tools that may be useful to use in conjunction with ScummVM. Please note that although a tool may support a feature, certain ScummVM versions may not. ScummVM 0.6.x does not support FLAC audio, for example.


=== Compression Tools ===
== Compression Tools ==
==== compress_scumm_sou ====
=== compress_scumm_sou ===
Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
Used to compress .sou files to .so3 (MP3), .sog (Vorbis),
or .sof (FLAC).
or .sof (FLAC).


==== compress_agos ====
=== compress_agos ===
Used to compress the Feeble Files or Simon 1/2 voc/wav files
Used to compress the Feeble Files or Simon 1/2 voc/wav files
to MP3, Vorbis or FLAC.
to MP3, Vorbis or FLAC.


==== compress_queen ====
=== compress_queen ===
Used to rebuild the datafile of Flight of the Amazon Queen,
Used to rebuild the datafile of Flight of the Amazon Queen,
and allow optional MP3, Vorbis or FLAC compression.
and allow optional MP3, Vorbis or FLAC compression.


==== compress_saga ====
=== compress_saga ===
Used to compress SAGA engine digital sound files to MP3, Vorbis
Used to compress SAGA engine digital sound files to MP3, Vorbis
or FLAC.  
or FLAC.  
Line 764: Line 762:
- The unsupported early DOS demo of Inherit the Earth
- The unsupported early DOS demo of Inherit the Earth


==== compress_sword1 ====
=== compress_sword1 ===
Used to compress Broken Sword 1's music and speech files to
Used to compress Broken Sword 1's music and speech files to
MP3 or Vorbis or FLAC.
MP3 or Vorbis or FLAC.


==== compress_sword2 ====
=== compress_sword2 ===
Used to compress Broken Sword 2's music and speech .clu
Used to compress Broken Sword 2's music and speech .clu
files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
Line 776: Line 774:
use lossy compression.
use lossy compression.


==== compress_touche ====
=== compress_touche ===
Used to compress and pack Touche speech files ('Vxxx' and
Used to compress and pack Touche speech files ('Vxxx' and
'OBJ') to MP3, Vorbis or FLAC to a single file named
'OBJ') to MP3, Vorbis or FLAC to a single file named
Line 783: Line 781:
to play the game under ScummVM.
to play the game under ScummVM.


==== compress_scumm_san <inputfile> <inputdir> <outputdir> [--ogg] ====
=== compress_scumm_san <inputfile> <inputdir> <outputdir> [--ogg] ===
Compresses '.san' smush animation files. It uses lossless
Compresses '.san' smush animation files. It uses lossless
zlib for compressing FOBJ gfx chunks inside a san file.
zlib for compressing FOBJ gfx chunks inside a san file.
Line 805: Line 803:
move the '.flu' files, too!
move the '.flu' files, too!


==== compress_scumm_bun <inputfile> <inputdir> <outputdir> [params] ====
=== compress_scumm_bun <inputfile> <inputdir> <outputdir> [params] ===
Used to the compress '.bun' music/voice files with MP3, Vorbis
Used to the compress '.bun' music/voice files with MP3, Vorbis
or FLAC.
or FLAC.
Line 815: Line 813:
than the original, for The Curse of Monkey Island!
than the original, for The Curse of Monkey Island!


==== compress_kyra ====
=== compress_kyra ===
Used to compress The Legend of Kyrandia's speech files with
Used to compress The Legend of Kyrandia's speech files with
MP3, Vorbis or FLAC.
MP3, Vorbis or FLAC.
Line 826: Line 824:
and let the tool put the output file in another directory.
and let the tool put the output file in another directory.


=== Encoder Tools ===
== Encoder Tools ==
==== encode_dxa <filename> ====
=== encode_dxa <filename> ===


Creates DXA file out of extracted Smacker video.
Creates DXA file out of extracted Smacker video.
Line 856: Line 854:
and conversion options work the same.
and conversion options work the same.


==== convert_dxa.bat, convert_dxa_one.bat ====
=== convert_dxa.bat, convert_dxa_one.bat ===


To ease your life we also provide batch files to autoconvert
To ease your life we also provide batch files to autoconvert
Line 870: Line 868:
press OK
press OK


==== convert_dxa.sh ====
=== convert_dxa.sh ===


Same as above convert_dxa.bat, just for *nix-based systems.
Same as above convert_dxa.bat, just for *nix-based systems.
It uses Wine to run RAD Game Tools.
It uses Wine to run RAD Game Tools.


=== Extraction Tools ===
== Extraction Tools ==
Many games package together all their game data in a few big archive files. The following tools can be used to extract these archives, and in some cases are needed to make certain game versions usable with ScummVM. In general, though, they are mostly intended for ScummVM developers and not useful to end users.
Many games package together all their game data in a few big archive files. The following tools can be used to extract these archives, and in some cases are needed to make certain game versions usable with ScummVM. In general, though, they are mostly intended for ScummVM developers and not useful to end users.


==== extract_agos ====
=== extract_agos ===
Extracts the packed files used in the Amiga and AtariST
Extracts the packed files used in the Amiga and AtariST
versions of Elvira 1/2, Waxworks and Simon the Sorcerer 1.
versions of Elvira 1/2, Waxworks and Simon the Sorcerer 1.


==== extract_kyra ====
=== extract_kyra ===
Unpacks .PAK files from Kyrandia games.
Unpacks .PAK files from Kyrandia games.


==== extract_scumm_mac ====
=== extract_scumm_mac ===
Extracts Macintosh "single file" SCUMM games into their
Extracts Macintosh "single file" SCUMM games into their
component parts, for use with ScummVM.
component parts, for use with ScummVM.
Line 892: Line 890:
format.
format.


==== extract_loom_tg16 ====
=== extract_loom_tg16 ===
Extracts data files from the PC-Engine version of Loom.
Extracts data files from the PC-Engine version of Loom.
Use the dumpcd utility at http://www.zeograd.com/misc_download.php
Use the dumpcd utility at http://www.zeograd.com/misc_download.php
to dump the code tracks on the CD.
to dump the code tracks on the CD.


==== extract_mm_apple ====
=== extract_mm_apple ===
Extracts data files from the Apple II version of Maniac
Extracts data files from the Apple II version of Maniac
Mansion.
Mansion.


==== extract_mm_c64 ====
=== extract_mm_c64 ===
Extracts data files from the Commodore 64 version of Maniac
Extracts data files from the Commodore 64 version of Maniac
Mansion.
Mansion.


==== extract_mm_nes ====
=== extract_mm_nes ===
Extracts data files from the NES version of Maniac Mansion.
Extracts data files from the NES version of Maniac Mansion.


==== extract_parallaction ====
=== extract_parallaction ===
Extracts the contents of archives used by Nippon Safes
Extracts the contents of archives used by Nippon Safes


==== extract_zak_c64 ====
=== extract_zak_c64 ===
Extracts data files from the Commodore 64 version of Zak
Extracts data files from the Commodore 64 version of Zak
McKracken.
McKracken.


=== Script Tools ===
== Script Tools ==
The following tools can be used to analyze the game scripts (controlling the behavior of certain scenes and actors in a game). They are intended for use by developers, and as such in general not helpful to normal users.
The following tools can be used to analyze the game scripts (controlling the behavior of certain scenes and actors in a game). They are intended for use by developers, and as such in general not helpful to normal users.


==== descumm ====
=== descumm ===
Decompiles SCUMM scripts
Decompiles SCUMM scripts


==== desword2 ====
=== desword2 ===
Disassembles Broken Sword II scripts
Disassembles Broken Sword II scripts


==== dekyra ====
=== dekyra ===
Basic script disassembler for Legend of Kyrandia games
Basic script disassembler for Legend of Kyrandia games
1,079

edits