ScummVMLink

Contribute to this documentationLink

DOCUMENTATION IS A WORK IN PROGRESS

In order to propose improvements to this document, visit its corresponding source page on github. Changes are proposed using "Pull Requests."

There is a To-Do list for libretro/docs here

You can submit suggestions or issues regarding documentation at the libretro/docs issue tracker or in our forum thread.

BackgroundLink

ScummVM is an interpreter 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

Why use this core?Link

Awaiting description.

How to get and install the ScummVM core:Link

  • Start up RetroArch. Inside the main menu, go to 'Online Updater'.

  • Just to make sure we have the latest info files, select 'Update Core Info FIles'. Wait until this is done. Then, select 'Core Updater'.

  • Browse through the list and select 'ScummVM'.

After this has finished downloading, the core should now be ready for use!

How to start (after installation):Link

  • Go back to RetroArch's main menu screen. Select 'Load Content'.

  • Browse to the folder that contains the content you want to run.

  • Select the content that you want to run.

  • If you are asked which core to select, choose 'ScummVM'.

The content should now start running!

AuthorsLink

LicenseLink

A summary of the licenses behind RetroArch and its cores have found here.

The ScummVM core is licensed under

ExtensionsLink

Content that can be loaded by the ScummVM core have the following file extensions:

  • .scummvm

DatabasesLink

RetroArch database(s) that are associated with the ScummVM core:

FeaturesLink

RetroArch-level settings or features that the ScummVM core respects.

Feature Supported
Restart
Screenshots
Saves
States
Rewind
Netplay
Core Options
RetroAchievements
RetroArch Cheats
Native Cheats
Controls
Remapping
Multi-Mouse
Rumble
Sensors
Camera
Location
Subsystem
Softpatching
Disk Control
Username
Language
Crop Overscan

DirectoriesLink

The ScummVM core's directory name is 'scummvm'

The ScummVM core saves/loads to/from these directories.

RetroArch's Save directory

  • Game saves

RetroArch's System directory

  • scummvm.ini

Geometry and timingLink

  • The ScummVM core's internal FPS is 60
  • The ScummVM core's internal sample rate is 44100 Hz
  • The ScummVM core's core provided aspect ratio is 4/3

Scanning SupportLink

To allow launching ScummVM games from the menu, you'll need to do the following:

  1. Look up the Game ID of the game you're looking to add to the menu. Game IDs can be found in ScummVM's compatibility list. > monkey for Monkey Island

  2. Inside the game directory, create a .scummvm file, named by the Game ID > monkey.scummvm for Monkey Island

  3. Open up the file in a text editor, and enter in the Game ID. > echo monkey > monkey.scummvm

  4. (Optional) Alternatively, you could download a prepared .scummvm file from libretro-database-scummvm.

  5. Scan each game directory

This is an example of what the playlist would look like:

1
2
3
4
5
6
    /storage/roms/scummvm/monkey/monkey.scummvm
    The Secret of Monkey Island
    /tmp/cores/scummvm_libretro.so
    ScummVM
    b0e2af30|crc
    ScummVM.lpl

ControllersLink

Device typesLink

The ScummVM core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):

User 1 device typesLink

  • None - Doesn't disable input.
  • RetroPad - Joypad
  • RetroPad w/Analog - Joypad - There's no reason to switch to this.

Controller tablesLink

Joypad and analog device type tableLink

User 1 Remap descriptors RetroPad Inputs RetroPad
Mouse Button 2 Mouse Button 2
ScummVM GUI ScummVM GUI
Esc Esc
Mouse Up Mouse Up
Mouse Down Mouse Down
Mouse Left Mouse Left
Mouse Right Mouse Right
Mouse Button 1 Mouse Button 1
X Mouse Left/Right
Y Mouse Up/Down
X
Y

Mouse device type tableLink

RetroMouse Inputs Mouse
Mouse Cursor
Mouse Left Button
Mouse Right Button

CompatibilityLink

ScummVM Compatibility List