scummvm(6)

1SCUMMVM(6)                     BSD Games Manual                     SCUMMVM(6)
2

NAME

4     scummvm — graphic adventure game interpreter
5

SYNOPSIS

7     scummvm [OPTIONS] [GAME]
8

DESCRIPTION

10     scummvm is an interpreter that will play graphic adventure games based on
11     a variety of game engines.
12
13     GAME is a short name of game to load. For example, monkey for Monkey
14     Island. This can be either a built-in gameid, or a user configured tar‐
15     get.
16

OPTIONS

18     Please note that more detailed information for the following options can
19     be found in the README file.
20
21     The meaning of most long options (that is, those options starting with a
22     double-dash) can be inverted by prefixing them with no-. For example,
23     --no-aspect-ratio will turn aspect ratio correction off. This is useful
24     if you want to override a setting in the configuration file.
25
26     -v, --version
27             Display ScummVM version information and exit.
28
29     -h, --help
30             Display a brief help text and exit.
31
32     -z, --list-games
33             Display list of supported games and exit.
34
35     -t, --list-targets
36             Display list of configured targets and exit.
37
38     --list-saves
39             Display a list of saved games for the target specified with
40             --game=TARGET or all targets if none is specified.
41
42     -a, --add
43             Add all games from current or specified directory. If --game=ID
44             is passed only the game with id ID is added. See also --detect.
45             Use --path=PATH to specify a directory.
46
47     --detect
48             Display a list of games with their ID from current or specified
49             directory without adding it to the config. Use --path=PATH to
50             specify a directory.
51
52     --game=ID
53             In combination with --add or --detect only adds or attempts to
54             detect the game with id ID.
55
56     --auto-detect
57             Display a list of games from current or specified directory and
58             start the first one. Use --path=PATH to specify a directory.
59
60     --recursive
61             In combination with --add or --detect recurse down all subdirec‐
62             tories
63
64     -c, --config=CONFIG
65             Use alternate configuration file.
66
67     -p, --path=PATH
68             Path to where the game is installed.
69
70     -x, --save-slot=[SLOT]
71             Saved game slot to load (default: autosave).
72
73     -f, --fulscreen
74             Force full-screen mode.
75
76     -F, --no-fullscreen
77             Force windowed mode.
78
79     -g, --gfx-mode=MODE
80             Select graphics scaler:
81
82             1x          No filtering, no scaling. Fastest.
83
84             2x          No filtering, factor 2x (default for non 640x480
85                         games).
86
87             3x          No filtering, factor 3x.
88
89             2xsai       2xSAI filter, factor 2x.
90
91             super2xsai  Enhanced 2xSAI filtering, factor 2x.
92
93             supereagle  Less blurry than 2xSAI, but slower. Factor 2x.
94
95             advmame2x   Doesn't rely on blurring like 2xSAI, fast. Factor 2x.
96
97             advmame3x   Doesn't rely on blurring like 2xSAI, fast. Factor 3x.
98
99             hq2x        Very nice high quality filter but slow. Factor 2x.
100
101             hq3x        Very nice high quality filter but slow. Factor 3x.
102
103             tv2x        Interlace filter, tries to emulate a TV. Factor 2x.
104
105             dotmatrix   Dot matrix effect. Factor 2x.
106
107     --stretch-mode=MODE
108             Select stretch mode (center, integral, fit, stretch)
109
110     --filtering
111             Force filtered graphics mode
112
113     --no-filtering
114             Force unfiltered graphics mode
115
116     --gui-theme=THEME
117             Select GUI theme (default, modern, classic)
118
119     --themepath=PATH
120             Path to where GUI themes are stored
121
122     --list-themes
123             Display list of all usable GUI themes
124
125     -e, --music-driver=MODE
126             Select music driver:
127
128             null        Null output. Don't play any music.
129
130             adlib       Internal AdLib emulation
131
132             fluidsynth  FluidSynth MIDI emulation
133
134             mt32        Internal MT-32 emulation
135
136             pcjr        Internal PCjr emulation (only usable in SCUMM games)
137
138             pcspk       Internal PC Speaker emulation
139
140             towns       Internal FM-TOWNS YM2612 emulation (only usable in
141                         SCUMM FM-TOWNS games)
142
143             alsa        Output using ALSA sequencer device
144
145             core        CoreAudio sound, for Mac OS X users
146
147             coremidi    CoreMIDI sound, for Mac OS X users. Use only if you
148                         have a hardware MIDI synthesizer.
149
150             seq         Use /dev/sequencer for MIDI, *nix users.
151
152             timidity    Connect to TiMidity++ MIDI server.
153
154             windows     Windows built in MIDI sequencer for Windows users
155
156     --list-audio-devices
157             List all available audio devices
158
159     -q, --language=LANG
160             Select game's language:
161
162             cz      Czech
163
164             de      German
165
166             en      English (USA) (default)
167
168             es      Spanish
169
170             fr      French
171
172             gb      English (Great Britain)
173
174             hb      Hebrew
175
176             it      Italian
177
178             jp      Japanese
179
180             kr      Korean
181
182             pt      Portuguese
183
184             ru      Russian
185
186             se      Swedish
187
188             zh      Chinese
189
190     -m, --music-volume=NUM
191             Set the music volume, 0-255 (default: 192).
192
193     -s, --sfx-volume=NUM
194             Set the sfx volume to, 0-255 (default: 192).
195
196     -r, --speech-volumeNUM
197             Set the voice volume to, 0-255 (default: 192).
198
199     --midi-gain=NUM
200             Set the gain for MIDI playback, 0-1000 (default: 100)
201             (only supported by some MIDI drivers)
202
203     -n, --subtitles
204             Enable subtitles (use with games that have voice).
205
206     -b, --boot-param=NUM
207             Pass number to the boot script (boot param).
208
209     -d, --debuglevel=NUM
210             Set debug verbosity level
211
212     --debugflags=Arm FLAGS
213             Enable engine specific debug flags (separated by commas)
214
215     -u, --dump-scripts
216             Enable script dumping if a directory called dumps exists in the
217             current directory.
218
219     --cdrom=NUM
220             CD drive to play CD audio from (default: 0 = first drive).
221
222     --joystick=[NUM]
223             Enable joystick input (default: 0 = first joystick).
224
225     --platform=WORD
226             Specify platform of game (allowed values: 2gs, 3do, acorn, amiga,
227             atari, c64, fmtowns, mac, nes, pc, pce, segacd, windows)
228
229     --savepath=PATH
230             Path to where saved games are stored
231
232     --extrapath=PATH
233             Extra path to additional game data
234
235     --soundfont=FILE
236             Select the SoundFont for MIDI playback (only supported by some
237             MIDI drivers).
238
239     --multi-midi
240             Enable combination of AdLib and native MIDI.
241
242     --native-mt32
243             True Roland MT-32 MIDI (disable GM emulation).
244
245     --enable-gs
246             Enable Roland GS mode for MIDI playback.
247
248     --output-rate=RATE
249             Set output sample rate in Hz (e.g. 22050).
250
251     --opl-driver=DRIVER
252             Select AdLib (OPL) emulator (db, mame, nuked)
253
254     --aspect-ratio
255             Enable aspect ratio correction.
256
257     --render-mode=MODE
258             Enable additional render modes (hercGreen, hercAmber, cga, ega,
259             vga, amiga, fmtowns, pc9821, pc9801, 2gs, atari, macintosh)
260
261     --alt-intro
262             Use alternative intro for CD versions of Beneath a Steel Sky and
263             Flight of the Amazon Queen.
264
265     --copy-protection
266             Enable copy protection in games, when ScummVM disables it by
267             default.
268
269     --talkspeed=NUM
270             Set talk delay for SCUMM games, or talk speed for other games
271             (default: 60)
272
273     --demo-mode
274             Start demo mode of Maniac Mansion (Classic version)
275
276     --tempo=NUM
277             Set music tempo (in percent, 50-200) for SCUMM games (default:
278             100).
279

INGAME HOTKEYS

281     Ctrl-F5        Display the Global Menu
282
283     Cmd-q          Quit (Mac OS X)
284
285     Ctrl-q         Quit (Most platforms)
286
287     Ctrl-u         Mute all sounds
288
289     Ctrl-m         Toggle mouse capture
290
291     Ctrl-Alt 1-8   Switch between graphics filters
292
293     Ctrl-Alt +     Increase scale factor
294
295     Ctrl-Alt -     Decrease scale factor
296
297     Ctrl-Alt a     Toggle aspect-ratio correction
298
299     Ctrl-Alt f     Toggle graphics filtering
300
301     Ctrl-Alt s     Cycle through scaling modes
302
303     Alt-Enter      Toggle full screen/windowed
304
305     Alt-s          Make a screenshot (SDL backend only)
306
307     Ctrl-F7        Open virtual keyboard (if enabled). This can also be trig‐
308                    gered by a long press of the middle mouse button or wheel.
309
310     There are many more SCUMM and game-specific hotkeys. See the README file.
311

ENVIRONMENT

313     SCUMMVM_MIDI
314              The sequencer device to use with the ‘seq’ MIDI driver.
315
316     SCUMMVM_MIDIPORT
317              The number of the sequencer to use when using the ‘seq’ MIDI
318              driver.
319
320     SCUMMVM_PORT
321              The ALSA port to open for output when using the ‘alsa’ MIDI
322              driver.
323

FILES

325     $HOME/.scummvmrc
326             Configuration file on UNIX.
327
328     $HOME/Library/Preferences/ScummVM Preferences
329             Configuration file on Mac OS X.
330

EXAMPLES

332     Running the builtin game launcher:
333
334           $ scummvm
335
336     Running Day of the Tentacle specifying the path:
337
338           $ scummvm -p /usr/local/share/games/tentacle tentacle
339
340     Running The Dig with advmame2x filter with subtitles:
341
342           $ scummvm -g advmame2x -n dig
343
344     Running the Italian version of Maniac Mansion fullscreen:
345
346           $ scummvm -q it -f maniac
347

AUTHORS

353     This manual page written by Jonathan Gray <khalek at scummvm.org>.  Scum‐
354     mVM was written by the ScummVM team.  See AUTHORS file for more informa‐
355     tion.
356
357BSD                            December 15, 2004                           BSD