Difference between revisions of "User Manual"

Jump to navigation Jump to search

User Manual (view source)

Revision as of 22:16, 5 December 2007

13,724 bytes removed ,  22:16, 5 December 2007
→‎Running and using ScummVM: Split section out to User_Manual/Running_and_Using_ScummVM
(→‎Appendix: Tools: Section split off to User_Manual/Appendix:_Tools)
(→‎Running and using ScummVM: Split section out to User_Manual/Running_and_Using_ScummVM)
Line 200: Line 200:
== First steps ==
== First steps ==


= Running and using ScummVM =
{{ManualSection|location=User_Manual/Running_and_Using_ScummVM|name=Running and using ScummVM|desc=How to use ScummVM, including both graphical and command line usage}}
== The Launcher ==
=== Managing your games ===
==== Adding a game ====
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.
# {{ManualScreenshot|name=Emptylauncher.png|desc=The ScummVM Launcher}} Click on the "Add Game..." button on the right-hand side of the Launcher.{{-}}
# {{ManualScreenshot|name=Adddialog.png|desc=Add Game Dialog Box}} You will now be presented with a file browser. You should use this browser to locate the directory in which the files from your game's disks are located. Double click on the name of a directory to go into it, and use the "Go up" button to go back up one level. Once you are in the correct folder, click the "Choose" button.{{-}}
# {{ManualScreenshot|name=Addgamesettings.png|desc=Game Settings Dialog Box}} If ScummVM detected the game correctly, it will now display a dialog box which lets you change various settings about the game, including the name that appears in the main window of the Launcher. There are six tabs full of settings to change, and these are discussed later on in the [[#Configuration|configuration]] section, but you don't need to change any of them. To finish adding your game, just click the "OK" 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 ====
 
# {{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=Massaddbrowse.png | desc=File browser for mass add}} You will then be presented with the same file browser that we used previously to select just one game. This time, however, click "Choose" when you are in the top-level directory which all your game directories are inside.{{-}}
# {{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 ====
{{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 ===
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 ==
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>
 
Note this command is dependent on your system. You may have to specify exactly where ScummVM is installed to, for example in Windows:
<pre>c:\games\scummvm\scummvm.exe samnmax</pre>
Or in Unix:
<pre>/home/username/scummvm/scummvm samnmax</pre>
 
The short game name you see at the end of the command line ("samnmax" in this case) specifies which game is started. It either corresponds to a user-defined target (i.e. one that has been added using the Launcher: this is the case in the example above), or to a built-in gameid. A brief list of the latter can be found in the supported games section.
 
There are many different ''options'' that can be specified to make ScummVM run the game just the way you want, and these are listed in the table below. The meaning of most long options (that is, those options starting with a
double-dash) can be inverted by prefixing them with "no-". For example,
"--no-aspect-ratio" will turn aspect ratio correction off. This is useful
if you want to override a setting in the configuration file.
 
=== Command line options ===
{|class="wikitable"
|+ <pre>scummvm [OPTIONS] GAME</pre>
|-
! Short
! Long
! Description
|-
| -v
| --version
| Display ScummVM version information and exit
|-
| -h
| --help
| Display a brief help text and exit
|-
| -z
| --list-games
| Display list of supported games and exit
|-
| -t
| --list-targets
| Display list of configured targets and exit
|-
| -c
| --config=''CONFIG''
| Use alternate configuration file
|-
| -p
| --path=''PATH''
| Path to where the game is installed
|-
| -x
| --save-slot[=''NUM'']
| Save game slot to load (default: autosave)
|-
| -f
| --fullscreen
| Force full-screen mode
|-
| -F
| --no-fullscreen
| Force windowed mode
|-
| -g
| --gfx-mode=''MODE''
| Select graphics scaler (see also [[#Graphic_filters|Graphic filters]])
|-
|
| --gui-theme=''THEME''
| Select GUI theme (default, modern, classic)
|-
|
| --themepath=''PATH''
| Path to where GUI themes are stored
|-
| -e
| --music-driver=''MODE''
| Select music driver (see also [[#Music_drivers|Music drivers]])
|-
| -q
| --language=''LANG''
| Select language (see also section TODO)
|-
| -m
| --music-volume=''NUM''
| Set the music volume, 0-255 (default: 192)
|-
| -s
| --sfx-volume=''NUM''
| Set the sfx volume, 0-255 (default: 192)
|-
| -r
| --speech-volume=''NUM''
| Set the voice volume, 0-255 (default: 192)
|-
|
| --midi-gain=''NUM''
| Set the gain for MIDI playback, 0-1000 (default:100) (only supported by some MIDI drivers: see [[#Music_drivers|Music drivers]])
|-
| -n
| --subtitles
| Enable subtitles (use with games that have voice)
|-
| -b
| --boot-param=''NUM''
| Pass number to the boot script (boot param)
|-
| -d
| --debuglevel=''NUM''
| Set debug verbosity level
|-
|
| --debugflags=''FLAGS''
| Enables engine specific debug flags (separated by commas)
|-
| -u
| --dump-scripts
| Enable script dumping if a directory called 'dumps' exists in the current directory
|-
|
| --cdrom=''NUM''
| CD drive to play CD audio from (default: 0 = first drive)
|-
|
| --joystick[=''NUM'']
| Enable joystick input (default: 0 = first joystick)
|-
|
| --platform=''WORD''
| Specify version of game (allowed values: 3do, acorn, amiga, atari, c64, fmtowns, mac, nes, pc, segacd, windows)
|-
|
| --savepath=''PATH''
| Path to where savegames are stored
|-
|
| --extrapath=''PATH''
| Extra path to additional game data
|-
|
| --soundfont=''FILE''
| Select the SoundFont for MIDI playback (only supported by some MIDI drivers: see [[#Music_drivers|Music drivers]])
|-
|
| --multi-midi
| Enable combination of Adlib and native MIDI (see [[#Music_drivers|Music drivers]])
|-
|
| --native-mt32
| True Roland MT-32 (disable GM emulation) (see [[#Music_drivers|Music drivers]])
|-
|
| --enable-gs
| Enable Roland GS mode for MIDI playback (see [[#Music_drivers|Music drivers]])
|-
|
| --output-rate=''RATE''
| Select output sample rate in Hz (e.g. 22050) (see [[#Output_sample_rate|Output sample rate]])
|-
|
| --aspect-ratio
| Enable aspect ratio correction (see [[#Graphics_tab|Graphics settings]])
|-
|
| --render-mode=''MODE''
| Enable additional render modes (see [[#Graphics_tab|Graphics settings]])
|-
|
| --alt-intro
| Use alternative intro for CD versions of Beneath a Steel Sky and Flight of the Amazon Queen
|-
|
| --copy-protection
| Enable copy protection in SCUMM games, when ScummVM disables it by default. '''''***TODO Add link to the copy protection section***'''''
|-
|
| --talkspeed=''NUM''
| Set talk speed for SCUMM games
|-
|
| --demo-mode
| Start demo mode of Maniac Mansion
|-
|
| --tempo=''NUM''
| Set music tempo (in percent, 50-200) for SCUMM games (default: 100)
|}
 
=== 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 Full Throttle from CD, fullscreen and with subtitles enabled (Win32):<code>C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft</code>
;Running Monkey Island, fullscreen, from a hard disk (Unix):<code>/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey</code>
;Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix):<code>/path/to/scummvm -f -n -p/cdrom/resource/ ft</code>
 
== Hotkeys ==
TODO
 
== Saving and loading ==
TODO
 
== 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.
 
Start up HFVExplorer; if you don't have a shortcut for it, find it in "C:\Program Files\HFVExplorer". It should open the HFS (Macintosh filesystem) CD-ROM automatically when you insert the disc. Make sure HFVExplorer is displaying hidden files: Select View->Options and enable "Show invisible Mac files" on the "File attributes" tab.
 
Now, look for the data file in the right pane. It will probably end with the word "Data" and will be the largest file on the volume. For instance (using Sam &amp; Max Hit the Road as an example), it is called "Sam &amp; Max Data" on the "Sam &amp; Max" CD-ROM. Select the data file and copy it (use Ctrl+C or Edit->Copy). In the left HFVExplorer pane, navigate to the directory where you want the game to reside on your hard disc. We recommend selecting drive C: and creating a new folder called "SamNMax" or a name that better reflects your particular game.
 
Paste the data file (with Ctrl+V or Edit->Paste) and allow HFVExplorer to choose the copy mode. Now, wait while the program copies several hundred megabytes from the CD. When the file is copied, close HFVExplorer.
 
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 ==
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.
 
Fortunately, ScummVM has no problems running the games entirely from hard disk, if you create a directory with the correct combination of files. Usually, when a file appears on more than one CD you can pick either of them.
 
These instructions are written for the PC versions (which in some case is the only version) of the games. Windows and DOS use case-insensitive file systems, so if one CD has a file called MONKEY.DAT and another has a file called monkey.dat, they are the same files. These instructions give file names in all lower-case names, even if that’s not always how they appear on the CDs. In fact, on case-sensitive file systems you will have to make sure that all filenames use either all upper- or all lower-case letters for ScummVM to be able to find the files.
 
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 ===
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.
 
=== 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.
 
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.
 
=== 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.
 
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.
 
=== The Feeble Files ===
 
TODO


{{ManualSection|location=User_Manual/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}}
{{ManualSection|location=User_Manual/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}}
Spookypeanut
306

edits

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/7718"

Navigation menu