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

INGAME HOTKEYS

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

ENVIRONMENT

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

FILES

328     $HOME/.scummvmrc
329             Configuration file on UNIX.
330
331     $HOME/Library/Preferences/ScummVM Preferences
332             Configuration file on Mac OS X.
333

EXAMPLES

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

AUTHORS

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