Compiling ScummVM/macOS

Compiling ScummVM under macOS

Compiling ScummVM under macOS requires setting up the build environment first, and then compiling the sources either via command line, or the Xcode GUI.

Things needed

Xcode

This can be installed from the Mac App Store.

Xcode command line tools

After installing Xcode, open a terminal and type:

<syntaxhighlight lang="bash"> xcode-select --install </source>

Package manager

Getting the required libraries is easier with a package manager. The three most well-known ones are Homebrew, MacPorts, and Fink.

1. Homebrew (recommended)

Install Homebrew by pasting the following into a terminal:

<syntaxhighlight lang="bash"> ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" </source>

2. MacPorts

Install MacPorts by downloading and running the installer from the MacPorts installation page.

3. Fink

Install Fink by downloading and building the source from the Fink Source Release page.

Obtaining the required libraries

After downloading the Xcode command line tools and a package manager, enter the following command to install all the required libraries:

1. Homebrew

<syntaxhighlight lang="bash"> brew install sdl2 sdl2_net jpeg-turbo libmpeg2 libogg libvorbis flac libmad libpng theora faad2 freetype lzlib fluid-synth </source>

2. MacPorts

<syntaxhighlight lang="bash"> sudo port install libsdl2 libsdl2_net libjpeg-turbo libmpeg2 libogg libvorbis flac libmad libpng libtheora faad2 freetype zlib fluidsynth </source>

3. Fink

<syntaxhighlight lang="bash"> TODO </source>

4. Manual compilation

Get the source code from the libraries. With this method you will not only need to get the libraries ScummVM uses directly, but also those they depend on.

• Required:
  • SDL 2 or 1.2 (prefer SDL 2 unless you are on a very old version of MacOS X)
• Optional:
  • zlib
  • jpeg
  • libpng
  • libogg and libvorbis
  • FLAC
  • libmad
  • mpeg2
  • FAAD2
  • Theora
  • SDL_net 2 or 1.2 (use same version as SDL)
  • For Freetype
    • bzip2
    • FreeType
  • For Fluidsynth
    • pkg-config
    • libffi
    • gettext
    • glib
    • FluidSynth

All the libraries are compiled and installed in the same way: <syntaxhighlight lang="bash"> cd thelib-src ./configure --prefix=/path/to/install make make install </source>

The default installation path is /usr/local, but you will need admin privileges to install the libraries in this location. <syntaxhighlight lang="bash"> cd thelib-src ./configure make sudo make install </source>

If you want your compilation to be compatible with older system, use the -mmacosx-version-min flag (for example -mmacosx-version-min=10.5). To force compilation in 32 bits use -arch i386. You can do that by setting environment variables before compiling all the libraries and ScummVM: <syntaxhighlight lang="bash"> export LDFLAGS="-arch i386 -mmacosx-version-min=10.5" export CFLAGS="-arch i386 -mmacosx-version-min=10.5" export CXXFLAGS="-arch i386 -mmacosx-version-min=10.5" </source>

bzip2 is an exception. There is no configure and you directly call make with options. For example: <syntaxhighlight lang="bash"> make CFLAGS="-arch i386 -mmacosx-version-min=10.5 -Wall -Winline -O2 -g -D_FILE_OFFSET_BITS=64" LDFLAGS="-arch i386 -mmacosx-version-min=10.5" make install PREFIX=/Users/criezy/Dev/scummvm-releases/libs </source>

If you plan to build the ScummVM app bundle, you will need to generate static libraries. For most of the libraries this is done by default, but for a few you need to specify you want static libraries when invoking configure. Here are suggested configure options for each library. If the library is not listed in the table below this means the default is fine.

Library	configure flags	Comments
pkg-config	--with-internal-glib
glib	--enable-static
libmpeg2	--disable-sdl	Need to add -std=gnu89 to CFLAGS (for example 'export CFLAGS="-std=gnu89"' before invoking configure)
FLAC	--enable-static --disable-asm-optimizations
Theora	--disable-examples	Need to edit configure before running it to remove flag -fforce-addr Examples do not compile with libpng 1.6

Compiling ScummVM via the command line

Configuring ScummVM

Run the configure script: <syntaxhighlight lang="bash"> ./configure </source>

If no errors come up, you should be ready to compile ScummvM. For a list of optional features (eg additional, not yet enabled engines) run: <syntaxhighlight lang="bash"> ./configure --help </source>

Here is a list of some options you may want to use:

• --enable-all-engines or --enable-engine=foo,bar to enable unsupported engines (not compiled by default)
• --with-staticlib=/path/to/install/dir if your libraries are not in a standard place (e.g. you compiled the libraries manually with a custom installation directory). This is only used when building the application bundle.
• --enable-updates --with-sparkle-prefix=/path/to/sparkle to enable Sparkle (disabled by default). The path should be the path to the directory that contains the Sparkle.framework and not the path to the Sparkle.framework itself.

Note: If you want to use Sparkle, there are some additional steps to do such as setting up DSA signatures. See [1] for details. ScummVM expects to find the DSA public key in dist/macosx.dsa_pub.pem.

Compiling ScummVM

Just run make (with -j to compile several files in parallel). For example <syntaxhighlight lang="bash"> make -j4 </source>

To recompile everything and not just the modified files: <syntaxhighlight lang="bash"> make clean make -j4 </source>

Installing ScummVM

You can run ScummVM from the command line in the build directory: <syntaxhighlight lang="bash"> ./scummvm </source>

You can also generate an application bundle and move this one anywhere you want: <syntaxhighlight lang="bash"> make bundle </source>

Some features such as dock integration are only available if you build the bundle.

Also if you run scummvm from the command line, you will need to set the Theme path in the ScummVM options so that it finds the modern theme. The themes are in gui/themes/ in the source code repository.

Compiling ScummVM via the Xcode GUI

Creating an Xcode project

• Compile create_project inside devtools/create_project

<syntaxhighlight lang="bash"> make devtools/create_project </source> Or alternatively you can use the Xcode project in devtools/create_project/xcode. Open it in Xcode or run the following command: <syntaxhighlight lang="bash"> cd devtools/create_project/xcode; xcodebuild </source>

• Run create_project from the root ScummVM directory:

<syntaxhighlight lang="bash"> ./devtools/create_project/create_project . --xcode </source>

Note that `create_project` accepts most of the same flags that `configure` accepts.

Build the Xcode project

• Open the Xcode project
• Go to Product -> Scheme and set the scheme to "ScummVM-macOS"
• Go to Product -> Scheme -> Edit Scheme -> Run tab -> Options tab and uncheck "Allow debugging when using document Versions Browser"
• Build with Product -> Build or Product -> Run

Further reading

• ScummVM README, Section 9.0