Difference between revisions of "Compiling ScummVM/macOS"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Add a bare-bone Mac OS X compilation page)
 
(→‎4. Manual compilation: -- removed duplicate)
 
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
TODO: This page needs to be filled with content.
+
== Compiling ScummVM under macOS ==
  
You should install Apple's XCode to get the compilers required for ScummVM.
+
Compiling ScummVM under macOS requires setting up the build environment first, and then compiling the sources either via command line, or the Xcode GUI.
  
Also, ScummVM needs several libraries, foremost SDL. An easy way to install those is using [http://www.finkproject.org Fink] or [http://www.macports.org MacPorts]. Alternatively, you can install these manually. See [[Compiling_ScummVM/Mac_OS_X_10.2.8]] for some (possibly outdated) notes on that.
+
== Things needed ==
  
TODO: List which packages should be installed, ideally give instructions for both Fink and MacPorts
+
=== Xcode ===
 +
This can be installed from the [https://itunes.apple.com/us/app/xcode/id497799835?mt=12 Mac App Store].
 +
 
 +
=== Xcode command line tools ===
 +
After installing Xcode, open a terminal and type:
 +
 
 +
<syntaxhighlight lang="bash">
 +
xcode-select --install
 +
</syntaxhighlight>
 +
 
 +
=== Package manager ===
 +
Getting the required libraries is easier with a package manager. The three most well-known ones are [http://brew.sh/ Homebrew], [https://www.macports.org/ MacPorts], and [http://www.finkproject.org/ 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)"
 +
</syntaxhighlight>
 +
 
 +
==== 2. MacPorts ====
 +
Install MacPorts by downloading and running the installer from the [https://www.macports.org/install.php MacPorts installation page].
 +
 
 +
==== 3. Fink ====
 +
Install Fink by downloading and building the source from the [http://www.finkproject.org/download/srcdist.php 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 a52dec curl-openssl faad2 flac fluid-synth freetype jpeg-turbo libmad libmpeg2 libogg libpng libvorbis lzlib pkg-config sdl2 sdl2_net theora
 +
</syntaxhighlight>
 +
 
 +
=== 2. MacPorts ===
 +
<syntaxhighlight lang="bash">
 +
sudo port install libsdl2 libsdl2_net libjpeg-turbo libmpeg2 libogg libvorbis flac libmad libpng libtheora faad2 a52dec freetype zlib fluidsynth
 +
</syntaxhighlight>
 +
 
 +
=== 3. Fink ===
 +
<syntaxhighlight lang="bash">
 +
TODO
 +
</syntaxhighlight>
 +
 
 +
=== 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:
 +
** [https://www.libsdl.org SDL 2 or 1.2] (prefer SDL 2 unless you are on a very old version of MacOS X)
 +
*Optional:
 +
** [http://zlib.net zlib]
 +
** [http://www.ijg.org/ jpeg]
 +
** [http://www.libpng.org/pub/png/libpng.html libpng]
 +
** [http://www.xiph.org/vorbis/ libogg and libvorbis]
 +
** [http://www.xiph.org/flac FLAC]
 +
** [http://www.underbit.com/products/mad/ libmad]
 +
** [http://libmpeg2.sourceforge.net mpeg2]
 +
** [http://www.audiocoding.com/faad2.html FAAD2]
 +
** [http://liba52.sourceforge.net liba52]
 +
** [https://theora.org Theora]
 +
** For cloud support:
 +
*** [https://www.libsdl.org/projects/SDL_net/ SDL_net 2] or [https://www.libsdl.org/projects/SDL_net/release-1.2.html 1.2] (use same version as SDL)
 +
*** [https://curl.haxx.se/ libcurl]
 +
** For Freetype
 +
*** [http://www.bzip.org bzip2]
 +
*** [http://www.freetype.org/ FreeType]
 +
** For Fluidsynth
 +
*** [https://www.freedesktop.org/wiki/Software/pkg-config/ pkg-config]
 +
*** [https://sourceware.org/libffi/ libffi]
 +
*** [https://www.gnu.org/software/gettext/ gettext]
 +
*** [https://git.gnome.org/browse/glib glib]
 +
*** [http://www.fluidsynth.org 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
 +
</syntaxhighlight>
 +
 
 +
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
 +
</syntaxhighlight>
 +
 
 +
If you want your compilation to be compatible with older systems, 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"
 +
</syntaxhighlight>
 +
 
 +
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
 +
</syntaxhighlight>
 +
 
 +
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.
 +
{| cellspacing="2" cellpadding="5" width=100% style="border: 1px solid #333333;"
 +
|- style="background:#efefef"
 +
! width=100|Library !! configure flags !! Comments
 +
|- style="background-color: #fafafa;"
 +
| align=center valign=top| pkg-config || --with-internal-glib ||
 +
|- style="background-color: #fafafa;"
 +
| align=center valign=top| glib || --enable-static ||
 +
|- style="background-color: #fafafa;"
 +
| align=center valign=top| libmpeg2 || --disable-sdl ||
 +
Need to add -std=gnu89 to CFLAGS (for example 'export CFLAGS="-std=gnu89"' before invoking configure)
 +
|- style="background-color: #fafafa;"
 +
| align=center valign=top| FLAC || --enable-static --disable-asm-optimizations ||
 +
|- style="background-color: #fafafa;"
 +
| align=center valign=top| 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
 +
</syntaxhighlight>
 +
 
 +
If no errors come up, you should be ready to compile ScummvM.
 +
For a list of optional features (e.g. additional, not yet enabled engines) run:
 +
<syntaxhighlight lang="bash">
 +
./configure --help
 +
</syntaxhighlight>
 +
 
 +
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 [https://sparkle-project.org/documentation/] 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
 +
</syntaxhighlight>
 +
 
 +
To recompile everything and not just the modified files:
 +
<syntaxhighlight lang="bash">
 +
make clean
 +
make -j4
 +
</syntaxhighlight>
 +
 
 +
=== Installing ScummVM ===
 +
You can run ScummVM from the command line in the build directory:
 +
<syntaxhighlight lang="bash">
 +
./scummvm
 +
</syntaxhighlight>
 +
 
 +
You can also generate an application bundle and move this one anywhere you want:
 +
<syntaxhighlight lang="bash">
 +
make bundle
 +
</syntaxhighlight>
 +
 
 +
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.
 +
 
 +
==== Important note about SDL2 ====
 +
The scummvm compilation assumes that the bundle uses the static SDL library. However if you have both a dynamic and static SDL2 library, SDL2 by default will instruct to use the dynamic library. To make bundles that work on other computers you can do one of two things:
 +
# Locate the installed sdl2-config script (for example ''/usr/local/bin/sdl2-config'') and edit the line after <code>--static-libs)</code>, replace <code>echo -L${exec_prefix}/lib -lSDL2</code> with <code>echo ${exec_prefix}/lib/libSDL2.a</code> (and preserve the rest of the line). This needs to be done before you make the bundle.
 +
# After creating the bundle, copy the dynamic libSDL2 to the bundle and instruct the executable where to find it:
 +
<syntaxhighlight lang="bash">
 +
otool -L ScummVM.app/Contents/MacOS/scummvm  | grep SDL2
 +
  <Note the path for the SDL2 library - below we assume it is /usr/local/lib/libSDL2-2.0.0.dylib>
 +
mkdir ScummVM.app/Contents/Frameworks/
 +
cp /usr/local/lib/libSDL2-2.0.0.dylib ScummVM.app/Contents/Frameworks/
 +
install_name_tool -change /usr/local/lib/libSDL2-2.0.0.dylib "@executable_path/../Frameworks/libSDL2-2.0.0.dylib"  ScummVM.app/Contents/MacOS/scummvm
 +
</syntaxhighlight>
 +
 
 +
Doing that is not needed if you are only going to use the ScummVM application on the same computer you compiled it on.
 +
 
 +
== Compiling ScummVM via the Xcode GUI ==
 +
 
 +
=== Creating an Xcode project ===
 +
* Compile '''create_project''' inside devtools/create_project
 +
<syntaxhighlight lang="bash">
 +
make devtools/create_project
 +
</syntaxhighlight>
 +
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
 +
</syntaxhighlight>
 +
* Run create_project '''from the root ScummVM directory''':
 +
<syntaxhighlight lang="bash">
 +
./devtools/create_project/create_project . --xcode
 +
</syntaxhighlight>
 +
 
 +
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 ==
 +
* [https://github.com/scummvm/scummvm/blob/master/README.md#100-compiling ScummVM README, Section 10.0]

Latest revision as of 19:23, 4 November 2019

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:

xcode-select --install

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:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

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

brew install a52dec curl-openssl faad2 flac fluid-synth freetype jpeg-turbo libmad libmpeg2 libogg libpng libvorbis lzlib pkg-config sdl2 sdl2_net theora

2. MacPorts

sudo port install libsdl2 libsdl2_net libjpeg-turbo libmpeg2 libogg libvorbis flac libmad libpng libtheora faad2 a52dec freetype zlib fluidsynth

3. Fink

TODO

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.

All the libraries are compiled and installed in the same way:

cd thelib-src
./configure --prefix=/path/to/install
make
make install

The default installation path is /usr/local, but you will need admin privileges to install the libraries in this location.

cd thelib-src
./configure
make
sudo make install

If you want your compilation to be compatible with older systems, 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:

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"

bzip2 is an exception. There is no configure and you directly call make with options. For example:

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

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:

./configure

If no errors come up, you should be ready to compile ScummvM. For a list of optional features (e.g. additional, not yet enabled engines) run:

./configure --help

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:

make -j4

To recompile everything and not just the modified files:

make clean
make -j4

Installing ScummVM

You can run ScummVM from the command line in the build directory:

./scummvm

You can also generate an application bundle and move this one anywhere you want:

make bundle

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.

Important note about SDL2

The scummvm compilation assumes that the bundle uses the static SDL library. However if you have both a dynamic and static SDL2 library, SDL2 by default will instruct to use the dynamic library. To make bundles that work on other computers you can do one of two things:

  1. Locate the installed sdl2-config script (for example /usr/local/bin/sdl2-config) and edit the line after --static-libs), replace echo -L${exec_prefix}/lib -lSDL2 with echo ${exec_prefix}/lib/libSDL2.a (and preserve the rest of the line). This needs to be done before you make the bundle.
  2. After creating the bundle, copy the dynamic libSDL2 to the bundle and instruct the executable where to find it:
otool -L ScummVM.app/Contents/MacOS/scummvm  | grep SDL2
   <Note the path for the SDL2 library - below we assume it is /usr/local/lib/libSDL2-2.0.0.dylib>
mkdir ScummVM.app/Contents/Frameworks/
cp /usr/local/lib/libSDL2-2.0.0.dylib ScummVM.app/Contents/Frameworks/
install_name_tool -change /usr/local/lib/libSDL2-2.0.0.dylib "@executable_path/../Frameworks/libSDL2-2.0.0.dylib"  ScummVM.app/Contents/MacOS/scummvm

Doing that is not needed if you are only going to use the ScummVM application on the same computer you compiled it on.

Compiling ScummVM via the Xcode GUI

Creating an Xcode project

  • Compile create_project inside devtools/create_project
make devtools/create_project

Or alternatively you can use the Xcode project in devtools/create_project/xcode. Open it in Xcode or run the following command:

cd devtools/create_project/xcode; xcodebuild
  • Run create_project from the root ScummVM directory:
./devtools/create_project/create_project . --xcode

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