1SCUMMVM(6) BSD Games Manual SCUMMVM(6)
2
4 scummvm — adventure and role-playing game interpreter
5
7 scummvm [OPTIONS] [GAME]
8
10 scummvm is an interpreter that will play numerous adventure and role-
11 playing games based on a variety of game engines.
12 GAME is a short name of game to load. This can be either a built-in
14 gameid (as given by --list-games), or a user-configured target (as given
15 by --list-targets).
16
18 The meaning of most long options (that is, those options starting with a
19 double-dash) can be inverted by prefixing them with no-. For example,
20 --no-aspect-ratio will turn aspect ratio correction off. This is useful
21 if you want to override a setting in the configuration file.
22 -a | --add
24 Add all games from current or specified (with --path=PATH) direc‐
25 tory. If --game=ID is passed, only the game with id ID is added.
26 See also --detect.
28 -b | --boot-param=NUM
30 Pass number NUM to the boot script, for games supporting this
31 feature.
32 -c | --config=CONFIG
34 Use alternate configuration file.
35 -d | --debuglevel[=NUM]
37 Enable and set debug verbosity level (default: 0).
38 -e | --music-driver=MODE
40 Select music driver:
41 adlib Internal AdLib emulation.
43 alsa Output using ALSA sequencer device.
45 core CoreAudio sound (macOS).
47 coremidi CoreMIDI sound (macOS).
49 fluidsynth FluidSynth MIDI emulation.
51 mt32 Internal MT-32 emulation.
53 null Null output. Don't play any music.
55 pcjr Internal PCjr emulation.
57 pcspk Internal PC Speaker emulation.
59 seq Use /dev/sequencer for MIDI (some Unix systems).
61 sndio Use sndio MIDI.
63 timidity Connect to TiMidity++ MIDI server.
65 towns Internal FM-TOWNS YM2612 emulation (only usable in
67 SCUMM FM-TOWNS games). Use only if you have a hard‐
68 ware MIDI synthesizer.
69 windows Windows built-in MIDI sequencer (Windows).
71 -F | --no-fullscreen
73 Force windowed mode.
74 -f | --fullscreen
76 Force full-screen mode.
77 -g | --gfx-mode=MODE
79 Select graphics mode (opengl, surfacesdl).
80 -h | --help
82 Display a brief help text, and exit.
83 -l | --logfile=PATH
85 Use alternate path for log file.
86 -m | --music-volume=NUM
88 Set the music volume, 0–255 (default: 192).
89 -n | --[no-]subtitles
91 Enable subtitles (for games that have voice).
92 -p | --path=PATH
94 Set the path to where the game is installed.
95 -q | --language=LANG
97 Select game's language:
98 ar Arabic (Modern Standard)
99 ca Catalan
100 zh Chinese (Generic)
101 cn Chinese (Simplified)
102 tw Chinese (Traditional)
103 hr Croatian
104 cs Czech
105 da Danish
106 nl Dutch
107 en English (Generic, default)
108 gb English (Great Britain)
109 us English (US)
110 et Estonian
111 fi Finnish
112 be Flemish
113 fr French
114 de German
115 el Greek
116 he Hebrew
117 hu Hungarian
118 it Italian
119 ja Japanese
120 ko Korean
121 lv Latvian
122 nb Norwegian (Bokmål)
123 fa Persian
124 pl Polish
125 br Portuguese (Brazil)
126 pt Portuguese (Portugal)
127 ru Russian
128 sr Serbian
129 sk Slovak
130 es Spanish
131 se Swedish
132 tr Turkish
133 uk Ukrainian
134 -r | --speech-volume=NUM
136 Set the voice volume, 0–255 (default: 192).
137 -s | --sfx-volume=NUM
139 Set the SFX volume, 0–255 (default: 192).
140 -t | --list-targets
142 Display list of user-configured game targets, and exit.
143 -u | --dump-scripts
145 Enable script dumping if a directory called dumps exists in the
146 current directory.
147 -v | --version
149 Display ScummVM version information, and exit.
150 -x | --save-slot[=SLOT]
152 Set the saved game slot to load (default: 0 = autosave).
153 -z | --list-games
155 Display list of supported games, and exit.
156 --[no-]alt-intro
158 Toggle alternative intro for CD versions of Beneath a Steel Sky
159 and Flight of the Amazon Queen (default: disabled).
160 --[no-]aspect-ratio
162 Toggle aspect ratio correction.
163 --auto-detect
165 Display a list of games from current or specified directory, and
166 start the first one. Use --path=PATH to specify a directory.
167 --cdrom=DRIVE
169 Set the drive to play CD audio from; can either be a drive, path,
170 or numeric index (default: 0 = best choice drive).
171 --[no-]copy-protection
173 Enable copy protection in games, when ScummVM disables it by de‐
174 fault.
175 --[no-]dirtyrects
177 Toggle dirty rectangles optimisation in software renderer (de‐
178 fault: enabled).
179 --debug-channels-only
181 Show only the specified debug channels.
182 --debugflags=FLAGS
184 Enable engine specific debug flags (separated by commas).
185 --[no-]demo-mode
187 Toggle demo mode of Maniac Mansion or The 7th Guest (default:
188 disabled).
189 --detect
191 Display a list of games with their ID from current or specified
192 directory without adding it to the configuration file. Use
193 --path=PATH to specify a directory.
194 --dump-midi
196 Dump MIDI events to dump.mid (overwriting it), until quitting
197 from game.
198 --enable-gs
200 Enable patch mappings to emulate an MT-32 on a Roland GS device
201 for MIDI playback.
202 --engine=ID
204 In combination with --list-games or --list-all-games, only list
205 games for this engine.
206 --engine-speed=NUM
208 Set frame per second limit (0–100) for 3D games, 0 = no limit
209 (default: 60).
210 --extrapath=PATH
212 Set the extra path to additional game and ScummVM data.
213 --[no-]filtering
215 Force filtered/unfiltered graphics mode. Filtered graphics mode
216 uses bilinear interpolation while unfiltered graphics mode uses
217 nearest neighbor.
218 --game=ID
220 In combination with --add or --detect, only add or attempt to de‐
221 tect the game with id ID.
222 --gui-theme=THEME
224 Select a GUI theme, as given by --list-themes.
225 --joystick[=NUM]
227 Enable joystick input (default: 0 = first joystick).
228 --iconspath=PATH
230 Set the path to additional icons for the launcher grid view.
231 --list-all-debugflags
233 Display list of all engine debugflags, and exit.
234 --list-all-engines
236 Display list of all detection engines, and exit.
237 --list-all-games
239 Display list of all detected games, and exit.
240 --list-audio-devices
242 List all available audio devices, and exit.
243 --list-debugflags[=ENGINE]
245 Display list of engine specified debugflags, and exit. If the
246 ENGINE argument is “global”, or if it is not specified, list
247 global debugflags.
248 --list-engines
250 Display list of supported engines, and exit.
251 --list-saves
253 Display a list of saved games for the target specified with
254 --game=TARGET, or all targets if none is specified, and exit.
255 --list-themes
257 Display list of all usable GUI themes, and exit.
258 --md5 Show MD5 hash of the file given by --md5-path=PATH. If
260 --md5-length=NUM is passed, then show the MD5 hash of the first
261 (if positive) or last (if negative) NUM bytes of the file given
262 by PATH. If --md5-engine=ENGINE_ID is passed, fetch the MD5
263 length automatically, overriding --md5-length.
264 --md5mac
266 Like --md5, but for old Macintosh files. Show MD5 hash for both
267 the resource fork and data fork of the file.
268 --midi-gain=NUM
270 Set the gain for MIDI playback, 0–1000 (default: 100). Only sup‐
271 ported by some MIDI drivers.
272 --multi-midi
274 Enable combination of AdLib and native MIDI.
275 --native-mt32
277 Tell ScummVM that the MIDI device is an actual Roland MT-32 or
278 compatible device. This disables any GM emulation.
279 --opl-driver=DRIVER
281 Select AdLib (OPL) emulator (alsa, db, mame, nuked, opl2lpt).
282 --output-channels=RATE
284 Set output channel count (e.g. 2 for stereo).
285 --output-rate=RATE
287 Set output sample rate in Hz (e.g. 22050).
288 --platform=PLATFORM
290 Specify platform of game (2gs, 3do, acorn, amiga, android,
291 apple2, atari, atari8, beos, c64, cdi, coco, coco3, cpc, fmtowns,
292 ios, linux, macintosh, macintosh2, megadrive, nes, os2, pc, pc98,
293 pce, pippin, playstation, playstation2, ppc, saturn, segacd,
294 shockwave, ti994, wii, windows, xbox, zx).
295 --random-seed=NUM
297 Set the random seed number used to initialize entropy.
298 --[no-]recursive
300 In combination with --add or --detect, recurse down all subdirec‐
301 tories (default: disabled).
302 --render-mode=MODE
304 Enable additional render modes (2gs, amiga, atari, cga, cgaBW,
305 cgaComp, ega, fmtowns, hercAmber, hercGreen, macintosh,
306 macintoshbw, pc9801, pc9821, vga).
307 --renderer=RENDERER
309 Select 3D renderer (opengl, opengl_shaders, software).
310 --savepath=PATH
312 Specify where saved games are stored.
313 --scale-factor=FACTOR
315 Set the factor to scale the graphics by.
316 --scaler=MODE
318 Select graphics scaler (normal, hq, edge, advmame, sai, supersai,
319 supereagle, pm, dotmatrix, tv2x).
320 --screenshotpath=PATH
322 Specify path where screenshot files are created.
323 --[no-]show-fps
325 Toggle FPS info in 3D games.
326 --soundfont=FILE
328 Select the SoundFont for MIDI playback (only supported by some
329 MIDI drivers).
330 --start-movie=NAME@NUM
332 Start movie at frame for Director. Either argument can be speci‐
333 fied without the other.
334 --stretch-mode=MODE
336 Select stretch mode (center, even-pixels, fit, fit_force_aspect,
337 pixel-perfect, stretch).
338 --talkspeed=NUM
340 Set talk delay for SCUMM games, or talk speed for other games.
341 --tempo=NUM
343 Set music tempo (in percent, 50–200) for SCUMM games (default:
344 100).
345 --themepath=PATH
347 Set the path to GUI themes.
348 --window-size=W,H
350 Set the window size to the specified dimensions (OpenGL only).
351
353 Ctrl-F5 Display the Global Menu
354 Cmd-q Quit (macOS)
356 Ctrl-q Quit (Most platforms)
358 Ctrl-u Mute all sounds
360 Ctrl-m Toggle mouse capture
362 Ctrl-Alt 1-8 Switch between graphics filters
364 Ctrl-Alt + Increase scale factor
366 Ctrl-Alt - Decrease scale factor
368 Ctrl-Alt a Toggle aspect-ratio correction
370 Ctrl-Alt f Toggle graphics filtering
372 Ctrl-Alt s Cycle through scaling modes
374 Alt-Enter Toggle full screen/windowed mode
376 Alt-s Take a screenshot
378 Ctrl-F7 Open virtual keyboard (if available). This can also be
380 triggered by a long press of the middle mouse button or
381 wheel
382 Ctrl-Alt d Open the ScummVM debugger
384 There are many more game-specific hotkeys. See:
386 https://wiki.scummvm.org/index.php?title=Category:Supported_Games
387
389 SCUMMVM_MIDI
390 The sequencer device to use with the ‘seq’ MIDI driver.
391 SCUMMVM_MIDIPORT
393 The number of the sequencer to use when using the ‘seq’ MIDI
394 driver.
395 SCUMMVM_PORT
397 The ALSA port to open for output when using the ‘alsa’ MIDI
398 driver.
399 SCUMMVM_SAVEPATH
401 Override the default save path (POSIX systems).
402
404 $HOME/.config/scummvm/scummvm.ini
405 Configuration file on most Unix systems. XDG environment vari‐
406 ables take precedence, if defined.
407 $HOME/Library/Preferences/ScummVM Preferences
409 Configuration file on macOS.
410
412 Running the built-in game launcher:
413 $ scummvm
415 Running Day of the Tentacle, specifying the path:
417 $ scummvm -p /usr/local/share/games/tentacle scumm:tentacle
419 Running The Dig with advmame2x filter and subtitles (with the dig-steam
421 target already defined in the configuration file):
422 $ scummvm --scaler=advmame --scale-factor=2 -n dig-steam
424 Running the Italian version of Maniac Mansion fullscreen, from the con‐
426 tent of the current directory:
427 $ scummvm -q it -f scumm:maniac
429
431 https://docs.scummvm.org
432
434 ScummVM was written by the ScummVM team. See AUTHORS file for more in‐
435 formation.
436BSD August 29, 2022 BSD