Open main menu
ScummVM :: Wiki

Difference between revisions of "User Manual"

User Manual (view source)

Revision as of 00:16, 26 November 2007

646 bytes added ,  00:16, 26 November 2007
→‎Command line options: Reorganize, revamp and neaten the command line section
(I don't know HOW I broke the title by editing a section in the middle, but this seems to fix it)
(→‎Command line options: Reorganize, revamp and neaten the command line section)
Line 227: Line 227:
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.


=== Command line options ===
=== Running ScummVM from the command line ===
TODO: The following list looks ugly :-/
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>


<code>scummvm [OPTIONS] ''GAME''</code>
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.
;-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 <xref linkend="sec.graphics-filter"/>)
;--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 <xref linkend="sec.music-driver"/>)
;-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)
;-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)
;--multi-midi:Enable combination of Adlib and native MIDI
;--native-mt32:True Roland MT-32 (disable GM emulation)
;--enable-gs:Enable Roland GS mode for MIDI playback
;--output-rate=''RATE'':Select output sample rate in Hz (e.g. 22050)
;--aspect-ratio:Enable aspect ratio correction
<!-- TODO: Explain this either here or link to an explanation -->
;--render-mode=''MODE'':Enable additional render modes (cga, ega, hercGreen, hercAmber, amiga)
<!-- TODO: Explain this either here or link to an explanation -->
;--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 -->
;--demo-mode:Start demo mode of Maniac Mansion (Classic version)
;--tempo=''NUM'':Set music tempo (in percent, 50-200) for SCUMM games (default: 100)
;--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)


The meaning of most long options (that is, those options starting with a
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,
double-dash) can be inverted by prefixing them with "no-". For example,
--no-aspect-ratio will turn aspectio ratio correction off. This is useful
"--no-aspect-ratio" will turn aspect ratio correction off. This is useful
if you want to override a setting in the configuration file.
if you want to override a setting in the configuration file.


The short game name ('game target') you see at the end of the command
==== Command line options ====
line specifies which game is started. It either corresponds to an arbitrary
{|class="wikitable"
user defined target (from the configuration file), or to a built-in gameid.
|+ <pre>scummvm [OPTIONS] GAME</pre>
A brief list of the latter can be found in the supported games section.
|-
! 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 <xref linkend="sec.graphics-filter"/>)
|-
|
| --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 <xref linkend="sec.music-driver"/>)
|-
| -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)
|-
| -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)
|-
|
| --multi-midi
| Enable combination of Adlib and native MIDI
|-
|
| --native-mt32
| True Roland MT-32 (disable GM emulation)
|-
|
| --enable-gs
| Enable Roland GS mode for MIDI playback
|-
|
| --output-rate=''RATE''
| Select output sample rate in Hz (e.g. 22050)
|-
|
| --aspect-ratio
| Enable aspect ratio correction
<!-- TODO
|  Explain this either here or link to an explanation -->
|-
|
| --render-mode=''MODE''
| Enable additional render modes (cga, ega, hercGreen, hercAmber, amiga)
<!-- TODO
|  Explain this either here or link to an explanation -->
|-
|
| --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 ====
==== Examples of Command Line Usage ====
Spookypeanut
306

edits

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