Difference between revisions of "User Manual/Installing a game for use with ScummVM"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Add installation instruction for freeware version of Drascula)
(Update info concerning the data files provided with ScummVM (*.dat and *.tbl files).)
Line 104: Line 104:
 
In August 2003, the creators and copyright holders of Beneath a Steel Sky, [[Revolution|Revolution Software]], released the game as freeware for use with ScummVM. You can therefore download the game from our [http://www.scummvm.org/downloads.php#extras Downloads page]. Then follow the general [[User_Manual/Running and Using ScummVM#Installing_Games|installation instructions]].
 
In August 2003, the creators and copyright holders of Beneath a Steel Sky, [[Revolution|Revolution Software]], released the game as freeware for use with ScummVM. You can therefore download the game from our [http://www.scummvm.org/downloads.php#extras Downloads page]. Then follow the general [[User_Manual/Running and Using ScummVM#Installing_Games|installation instructions]].
  
Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to run Beneath a Steel Sky. This file is available on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You can place it in either the directory containing the other
+
Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to run Beneath a Steel Sky. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You can place it in either the directory containing the other game data files (SKY.DNR, SKY.DSK), in your extrapath, or in the directory where your ScummVM executable resides.
game data files (SKY.DNR, SKY.DSK), in your extrapath, or in the directory where your ScummVM executable resides.
 
 
 
On MacOS X this 'SKY.CPT' file is included in ScummVM.app and therefore you do not need to download it separately and install it.
 
  
 
==== Hotkeys ====
 
==== Hotkeys ====
Line 292: Line 289:
 
In March 2004, the creators and copyright holders of Flight of the Amazon Queen, John Passfield and Steve Stamatiadis, released the game as freeware for use with ScummVM. You can therefore download the game from our [http://www.scummvm.org/downloads.php#extras Downloads page]. Then follow the general [[User_Manual/Running and Using ScummVM#Installing_Games|installation instructions]].
 
In March 2004, the creators and copyright holders of Flight of the Amazon Queen, John Passfield and Steve Stamatiadis, released the game as freeware for use with ScummVM. You can therefore download the game from our [http://www.scummvm.org/downloads.php#extras Downloads page]. Then follow the general [[User_Manual/Running and Using ScummVM#Installing_Games|installation instructions]].
  
If you have the original CD of the game game and would like to play this version, you will need to place the 'queen.tbl' file (that you can find on our [http://www.scummvm.org/downloads.php#extras Downloads page]) in either the directory containing the 'queen.1' game data file, in your extrapath, or in the directory where your ScummVM executable resides. On MacOS X this 'queen.tbl' file is included in ScummVM.app and therefore you do not need to download it separately and install it.
+
If you have the original CD of the game game and would like to play this version, you will also need the 'queen.tbl' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You can place it in either the directory containing the 'queen.1' file, in your extrapath, or in the directory where your ScummVM executable resides.
  
 
Alternatively you can use the '[[User_Manual/Appendix:_Tools#compress_queen|compress_queen]]' tool from the tools package to 'rebuild' your FOTAQ data file to include the table for that specific version, and thus removing the run-time dependency on the 'queen.tbl' file. This tool also allows you to compress the speech and sound effects with MP3, OGG or FLAC.
 
Alternatively you can use the '[[User_Manual/Appendix:_Tools#compress_queen|compress_queen]]' tool from the tools package to 'rebuild' your FOTAQ data file to include the table for that specific version, and thus removing the run-time dependency on the 'queen.tbl' file. This tool also allows you to compress the speech and sound effects with MP3, OGG or FLAC.
Line 375: Line 372:
 
== The Legend of Kyrandia ==
 
== The Legend of Kyrandia ==
 
=== Installation ===
 
=== Installation ===
To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat' file, which can be found on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You will need to copy this file in either the directory containing the game data files, in your extrapath, or in the directory where your ScummVM executable resides. On MacOS X this 'kyra.dat' file is included in ScummVM.app and therefore you do not need to download it separately and install it.
+
To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You can place it in either the directory containing the other game data files, in your extrapath, or in the directory where your ScummVM executable resides.
  
 
=== Hotkeys ===
 
=== Hotkeys ===
Line 423: Line 420:
 
=== Installation ===
 
=== Installation ===
 
In August 2008, the creators and copyright holders of Drascula: The Vampire Strikes Back, Alcachofa Soft, released the game as freeware for use with ScummVM. It is available for download from our [http://www.scummvm.org/downloads.php#extras Downloads page].
 
In August 2008, the creators and copyright holders of Drascula: The Vampire Strikes Back, Alcachofa Soft, released the game as freeware for use with ScummVM. It is available for download from our [http://www.scummvm.org/downloads.php#extras Downloads page].
# You will need to download the English version (even if you want to play it in another language). You will also need the 'DRASCULA.DAT' file that you can download from the same page. On MacOS X this 'DRASCULA.DAT' file is included in ScummVM.app and therefore you do not need to download it separately.
+
# You will need to download the English version (even if you want to play it in another language). You will also need the 'DRASCULA.DAT' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the [http://www.scummvm.org/downloads.php#extras Downloads page] of the ScummVM website. You can place it in either the directory containing the 'PACKET.001' game data file, in your extrapath, or in the directory where your ScummVM executable resides.
 
# Then if you want to play the game in another language (Spanish, German, French or Italian) you will also need to download the international pack and put the files together with the English version file (i.e. have all the PACKET.00# and DRASCULA.DAT files in the same directory).
 
# Then if you want to play the game in another language (Spanish, German, French or Italian) you will also need to download the international pack and put the files together with the English version file (i.e. have all the PACKET.00# and DRASCULA.DAT files in the same directory).
 
# Finally to play the game with a music score you will need to download the Music Add-on and put the ogg files together with the other game files.  
 
# Finally to play the game with a music score you will need to download the Music Add-on and put the ogg files together with the other game files.  

Revision as of 20:33, 20 April 2009

WORK IN PROGRESS, HELP NEEDED
If you want to contribute, send us a sample of text you'd write for the new manual, and we will consider adding you an account. You can work on the manual in the Wiki, but if you prefer, supplying us with HTML or TeX sources is fine, too (we will then translate them for the Wiki).

You can have a look at our TODO page for a list of tasks that need to be done.

LucasArts Games (SCUMM Engine)

Installation

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.

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.

Macintosh Games

All LucasArts SCUMM based adventures except Curse of Monkey Island also exist in versions for the Macintosh. ScummVM can use most (all?) of them, however, in some cases some additional work is required.

First off, if you are not using a Macintosh for this, accessing the CD/floppy data might be tricky. See notes in the Installing Games section.

Most of the newer games on the Macintosh shipped with only a single data file (note that in some cases this data file was made invisible, so you may need extra tools in order to copy it). ScummVM is able to directly use such a data file; simply point ScummVM at the directory containing it, and it should work (just like with every other supported game).

We also provide a tool called 'extract_scumm_mac' in the tools package to extract the data from these data files, but this is neither required nor recommended.

Maniac Mansion NES

Supported versions are English GB (E), French (F), German (G), Swedish(SW) and English US (U). ScummVM requires just the PRG section to run and not the whole ROM.

In order to get the game working, you will have to strip out the first 16 bytes from the ROM you are trying to work with. Any hex editor will work as long as you are able to copy/paste. After you open the ROM with the hex editor, copy everything from the second row (17th byte) to the end. After you do this, paste it to a new hex file. Name the new file "Maniac Mansion (XX).prg" while XX stands for the version you are working with (E, F, G, SW, or U). The final size should be exactly 262144 bytes.

If you add the game manually make sure that the platform is set to NES.

Most common mistakes which prevents the game from running:

  • Bad file
  • ROM extracted with the 0.7.0 tools
  • You try to feed ScummVM with the FULL ROM and not just the PRG section.

It is also possible to extract the separate LFL files from the PRG section. To do so use the 'extract_mm_nes' utility from the tools package.

Maniac Mansion Commodore 64

This games is detected and runs in ScummVM but is not yet completable. Simply name the D64 disks "maniac1.d64" and "maniac2.d64", then ScummVM should be able to automatically detect the game if you point it at the right directory.

Alternatively, you can use 'extract_mm_c64' from the tools package to extract the data files. But then the game will not be properly auto-detected by ScummVM, and you must make sure that the platform is set to Commodore64. We recommend using the much simpler approach described in the previous paragraph.

ZakMcKracken Commodore 64

Rename the D64 disks "zak1.d64" and "zak2.d64", then ScummVM should be able to automatically detect the game if you point it at the right directory.

Alternatively, you can use 'extract_zak_c64' from the tools package to extract the data files. But then the game will not be properly auto-detected by ScummVM, and you must make sure that the platform is set to Commodore64. We recommend using the much simpler approach described in the previous paragraph.

Hotkeys

Hotkey Description
Ctrl 0-9 Load game state
Alt 0-9 Save game stat
Crtl-d Starts the debugger
Crtl-f Toggle fast mode
Crtl-g Runs in really REALLY fast mode
Crtl-t Switch between 'Speech only', 'Speech and Subtitles' and 'Subtitles only'
Tilde (~) Show/hide the debugging console
[ and ] Music volume, down/up
- and + Text speed, slower/faster
F5 Displays a save/load box (see ScummVM in-game menu).
Alt-F5 Displays the original save/load box, if the game has one (see ScummVM in-game menu).
i Displays IQ points (Indiana Jones and the Last Crusade, and Indiana Jones and the Fate of Atlantis)
Space Pauses
Period (.) Skips current line of text in some games
Enter Simulate left mouse button press
Tab Simulate right mouse button press

ScummVM in-game menu

This is the menu that you get by pressing F5 in the LucasArts games. It replaces the original menu present in some of the games. You can still access the original menu using Alt-F5 and you can save and load games using this, however it is not intended for this purpose, and may even crash ScummVM in some games.

TO DO: add screenshot and description of in-game menu.

Revolution Software Games

Beneath a Steel Sky

Installation

In August 2003, the creators and copyright holders of Beneath a Steel Sky, Revolution Software, released the game as freeware for use with ScummVM. You can therefore download the game from our Downloads page. Then follow the general installation instructions.

Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to run Beneath a Steel Sky. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the Downloads page of the ScummVM website. You can place it in either the directory containing the other game data files (SKY.DNR, SKY.DSK), in your extrapath, or in the directory where your ScummVM executable resides.

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
Crtl-g Runs in really REALLY fast mode
F5 Displays a save/load box
Escape Skips the game intro
Period (.) Skips current line of text

Broken Sword 1

Installation

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.

In addition, you will need a music subdirectory with all of the files from the music subdirectories on both CDs. Some of these files appear on both CDs, but in these cases they are either identical or, in one case, so nearly identical that it makes little difference.

ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them. Revolution Software kindly permitted us to reencode them into DXA and distribute them freely on our site. You can get them on the download page. If you want to see the cutscenes when playing these games with ScummVM you need to download these reencoded cutscenes and install them in the directory in which you copied the other games files on your hard drive.

Hotkeys

Hotkey Description
F5 or Escape Displays save/load box

Broken Sword 2

Installation

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.

In addition, you will need the cd.bin, cd.inf and startup.inf files from the sword2 directory on CD 1.

ScummVM does not support the original cutscene files (with file extension .smk) for legal reasons, so there is no need to copy them. Revolution Software kindly permitted us to reencode them into DXA and distribute them freely on our site. You can get them on the download page. If you want to see the cutscenes when playing these games with ScummVM you need to download these reencoded cutscenes and install them in the directory in which you copied the other games files on your hard drive.

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
p Pauses

Configuration

This game has some specific configuration settings described in the Configuration section.

Adventure Soft Games

Simon the Sorcerer 1 and 2

Installation

If you have the dual version of Simon the Sorcerer 1 or 2 on CD, you will find the Windows version in the main directory of the CD and the DOS version in the DOS directory of the CD. Both are supported by ScummVM but depending on the version you want to use you will not need to copy the same files (see the game datafiles page for more details).

Hotkeys

Hotkey Description
Ctrl 0-9 Load game state
Alt 0-9 Save game state
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
F1 - F3 Text speed, faster - slower
F10 Shows all characters and objects you can interact with
Escape Skip cutscenes
- and + Music volume, down/up
m Music on/off
s Sound effects on/off
b Background sounds on/off (Simon the Sorcerer 2 only)
p Pauses
t Switch between speech and subtitles
v Switch between subtitles only and combined speech and subtitles (Simon the Sorcerer 2 only)

Simon the Sorcerer's Puzzle Pack

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
- and + Music volume, down/up
m Music on/off
s Sound effects on/off
p Pauses

The Feeble Files

Installation

TODO

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
F7 Switch characters
F9 Hitbox names on/off
s Sound effects on/off
p Pauses
t Switch between speech and subtitles
v Switch between subtitles only and combined speech and subtitles

Flight of the Amazon Queen

Installation

In March 2004, the creators and copyright holders of Flight of the Amazon Queen, John Passfield and Steve Stamatiadis, released the game as freeware for use with ScummVM. You can therefore download the game from our Downloads page. Then follow the general installation instructions.

If you have the original CD of the game game and would like to play this version, you will also need the 'queen.tbl' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the Downloads page of the ScummVM website. You can place it in either the directory containing the 'queen.1' file, in your extrapath, or in the directory where your ScummVM executable resides.

Alternatively you can use the 'compress_queen' tool from the tools package to 'rebuild' your FOTAQ data file to include the table for that specific version, and thus removing the run-time dependency on the 'queen.tbl' file. This tool also allows you to compress the speech and sound effects with MP3, OGG or FLAC.

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
Ctrl-f Toggle fast mode
F1 Use Journal (saving/loading)
F11 Quicksave
F12 Quickload
Escape Skips cutscenes
Space Skips current line of text

Future Wars

Hotkeys

Hotkey Description
F1 Examine
F2 Take
F3 Inventory
F4 Use
F5 Activate
F6 Speak
F9 "Activate" menu
F10 "Use" menu
Escape Show command menu

Nippon Safes

Hotkeys

Hotkey Description
Ctrl-d Starts the debugger
l Load game
s Save game

The Legend of Kyrandia

Installation

To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the Downloads page of the ScummVM website. You can place it in either the directory containing the other game data files, in your extrapath, or in the directory where your ScummVM executable resides.

Hotkeys

Hotkey Description
Ctrl 0-9 Load game state
Alt 0-9 Save game state
Ctrl-d Starts the debugger

Touché: The Adventures of the Fifth Musketeer

Hotkeys

Hotkey Description
Ctrl-f Toggle fast mode
F5 Displays options
F9 Turn fast walk mode on
F10 Turn fast walk mode off
Escape Quit
Space Skips current line of text
t Switch between 'Voice only', 'Voice and Text' and 'Text only'

Drascula: The Vampire Strikes Back

Installation

In August 2008, the creators and copyright holders of Drascula: The Vampire Strikes Back, Alcachofa Soft, released the game as freeware for use with ScummVM. It is available for download from our Downloads page.

  1. You will need to download the English version (even if you want to play it in another language). You will also need the 'DRASCULA.DAT' file. This file is distributed with ScummVM on most platforms. If ScummVM complains that it cannot find this file or that it has the wrong version you can download it on the Downloads page of the ScummVM website. You can place it in either the directory containing the 'PACKET.001' game data file, in your extrapath, or in the directory where your ScummVM executable resides.
  2. Then if you want to play the game in another language (Spanish, German, French or Italian) you will also need to download the international pack and put the files together with the English version file (i.e. have all the PACKET.00# and DRASCULA.DAT files in the same directory).
  3. Finally to play the game with a music score you will need to download the Music Add-on and put the ogg files together with the other game files.
  4. Then follow the general instructions to add the game in ScummVM. If you have installed the international pack, it will ask you in which language you want to play the game when adding it in ScummVM. You can add the game several times with a different language if you want to. The english and spanish versions both have voice over in that language. The other versions will use english voice over with subtitles in the language you selected.

Note: in the Music add-on the ogg files are in an audio directory, if you keep them in that directory you will need to add it in the Game extra path. To do so, after adding the game in ScummVM, select the game in the ScummVM launcher and click on Edit Game. Then go to the Paths tab and in Extra Path add the path to the Music directory in which all the ogg files should be. Alternatively you can move all the ogg files in the same directory where you have the data files (the PACKET.00# files), and it will pick up the music without having to select an extra path.