ScummVM - lmerckx/recalbox-os GitHub Wiki

What is SCUMM?

Script Creation Utility for Maniac Mansion (SCUMM) is a video game engine developed at Lucasfilm Games, later renamed LucasArts, to ease development on their first graphic adventure game Maniac Mansion (1987). It was subsequently used as the engine for later LucasArts adventure games.

It falls somewhere between a game engine and a programming language, allowing designers to create locations, items and dialogue sequences without writing code in the language in which the game source code ends up. This also allowed the game's script and data files to be cross-platform, i.e., re-used across various platforms. SCUMM is also a host for embedded game engines such as the Interactive MUsic Streaming Engine (iMUSE), the INteractive Streaming ANimation Engine (INSANE), CYST (in-game animation engine), FLEM (places and names object inside a room), and MMUCUS. SCUMM has been released on these platforms: 3DO, Amiga, Apple II, Atari ST, CDTV, Commodore 64, Fujitsu FM Towns & Marty, Apple Macintosh, Nintendo Entertainment System, DOS, Microsoft Windows, Sega CD (Mega-CD), and TurboGrafx-16/PC Engine.

What is ScummVM?

ScummVM is a program which allows you to run certain classic graphical point-and-click adventure games, provided you already have their data files. The clever part about this: ScummVM just replaces the executables shipped with the games, allowing you to play them on systems for which they were never designed!

How do I play SCUMM Games in Recalbox?

To add a Scummvm game, create a folder with the name of the game followed by the ".scummvm" extension and copy files of the game in it. In this folder, you will have to add a single file, named [gameshortname].scummvm

You can find short names for all supported games at http://scummvm.org/compatibility/

Tip: Add the Game Full Name from the previous site inside [gameshortname].scummvm for the scraper to detect it easily.

For example, you can copy the game "Broken Sword" in the directory "Broken Sword 1.scummvm" under the scummvm directory. In this folder create a file named sword1.scummvm

scummvm
|- Broken Sword 1.scummvm
|  |- sword1.scummvm
|  |- ... other files of the game

The name of your directory will be displayed as the name of the game in Recalbox menu. Selecting it will start the game.

You can quit the game and get Scummvm options by using the Ctrl + F5 shortcut.

Are all SCUMM Games compatible?

Please see the Compatibility List on the ScummVM website that contains an up to date list of which games work, and how well they work.

Controls

Since Recalbox v6, the controls have been standardized in ScummVM:

Control Definition
Left joystick Mouse cursor movement
B Button Standard action (left button of the mouse)
A Button Alternate action (right button of the mouse)
Y Button Skip dialog (period key)
Right shoulder + Y Button Pause (space key)
X Button Skip cutscene (escape key)
Select button Virtual keyboard
Start button ScummVM menu
Left shoulder Game menu
Up Up
Right shoulder + Up Up+Right
Down Down
Right shoulder + Down Down+Left
Left Left
Right shoulder + Left Up+Left
Right Right
Right shoulder + Right Down+Right

How to configure Roland MT-32 emulation for ScummVM games?

Global Option

First, you have to copy MT32 ROMs (MT32_CONTROL.ROM and MT32_PCM.ROM) in one directory, say for instance /recalbox/share/bios. Then, edit your ScummVM configuration file (/recalbox/share/system/.config/scummvm/scummvm.ini or .scummvmrc) and add following lines in [scummvm] section:

extrapath=/recalbox/share/bios
mt32_device=mt32
music_driver=mt32

Option per game

Other solution: you can also simply copy the two ROM files in the game directory. So, no need to change the configuration file but these files will be duplicated for each game you want Roland music for!

You have to use ROM files supported by ScummVM, for instance with following MD5 signature:

5626206284b22c2734f3e9efefcd2675  MT32_CONTROL.ROM
89e42e386e82e0cacb4a2704a03706ca  MT32_PCM.ROM