ScummVM libretro core

Libretro core built directly from untouched mainline ScummVM source.

ScummVM main repo is cloned at build time. To sync the libretro core it should be sufficient to update the reference commit in dependencies.mk.

Reference updates are generally committed following ScummVM official releases (though it can be updated to any commit upstream, considering that adjustment to core makefiles and sources in src may be required to build). First three fields of core tags are relevant to upstream ScummVM version, last is libretro core revision (e.g. v2.6.1.1 is ScummVM 2.6.1, core revision 1).

Datafiles and themes bundle (scummvm.zip) and core.info files are built automatically based on current submodule source.

Build

To build the core with the default configuration, type in a shell the following:

git clone https://github.com/libretro/scummvm
cd scummvm
make

Use make all to build the core along with datafiles/themes (scummvm.zip) and core info file (which can be built separately with make datafiles/make coreinfo).

"Work in progress" engines are not built by default, to include them pass NO_WIP=0 to make.

To crossbuild for specific platforms, pass the relevant platform variable to make (refer to Makefile for supported ones).

Build for Android

To build for Android:

install android-sdk
install android-ndk (e.g. through sdkmanager included in android-sdk/cmdline-tools)
make sure all needed sdk/ndk paths are included in PATH
type in a shell the following:

git clone https://github.com/libretro/scummvm
cd scummvm/jni
ndk-build

Core will be built for all available android targets by default

Data files and themes

Data files required for certain games and core functions (e.g. virtual keyboard) and default ScummVM GUI themes are bundled during the build process in scummvm.zip file. Libretro core info file is created during build as well. Extract scummvm.zip and select relevant paths in ScummVM GUI (or modify scummvm.ini accordingly) to load properly needed data files/themes in the core.

Note that both datafiles and themes included in scummvm.zip need to be consistent with ScummVM version (e.g. v2.6.1.x), hence need to be generally rebuilt and replaced for each new version.

Core options and configuration

All options and configuration of the legacy libretro core are applicable to this one as well, refer to relevant link in Resources. Some additional options and features have been added to this core:

New options

Set D-pad cursor acceleration time

New features

On-screen virtual keyboard (retropad "select" button by default to activate/deactivate)
Resources from scummvm.zip are needed to be installed for this feature to be enabled.
Cloud saving
This feature is currently disabled by default (e.g. on buildbot) as it has shared dependencies (libcurl-openssl).
To enable the feature, compile passing USE_CLOUD=1 to make. libcurl package with openssl must be installed on host system as described here.
Note that by default the entire retroarch saves folder will be syncronized, which may be a plus considering that this feature is currently not available in retroarch.

Resources

Official ScummVM repository readme is here.

Legacy ScummVM libretro core documentation is here.

spleen1981/scummvm_mainline