Compiling ScummVM/GCC

From ScummVM :: Wiki
< Compiling ScummVM
Revision as of 22:26, 27 June 2020 by Ccawley2011 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Compiling ScummVM with GCC on Unix-based systems

Installing the needed libraries via a package manager

Debian-based distributions

The following should install all the needed libraries:

apt-get install g++ make git libsdl2-dev liba52-dev libjpeg62-turbo-dev libmpeg2-4-dev libogg-dev libvorbis-dev libflac-dev libmad0-dev libpng-dev libtheora-dev libfaad-dev libfluidsynth-dev libfreetype6-dev zlib1g-dev libfribidi-dev

For Ubuntu, you can also obtain libunity:

apt-get install libunity-dev

Ubuntu 16.04 to 20.04

apt install g++ make git libsdl2-dev liba52-dev libjpeg-turbo8-dev libmpeg2-4-dev libogg-dev libvorbis-dev libflac-dev libmad0-dev libpng-dev libtheora-dev libfaad-dev libfluidsynth-dev libfreetype6-dev zlib1g-dev libfribidi-dev

For cloud and lan features you also need the SDL2_net and curl libraries:

apt install libsdl2-net-dev libcurl4-openssl-dev

You can also obtain libunity (for taskbar integration), libgtk (to use the gtk file browser), and libspeechd (for text to speech):

apt install libunity-dev libgtk-3-dev libspeechd-dev

RPM-based distributions

The following should install all the needed libraries (apart from fluidsynth):

yum install gcc-c++ make SDL-devel libjpeg-turbo-devel libmpeg2-devel libogg-devel libvorbis-devel flac-devel libmad-devel libpng-devel libtheora-devel faad2-devel freetype-devel zlib-devel fribidi-devel

Arch Linux-based distributions

The following command installs the compiler toolchain and all the needed libraries:

pacman -S --needed base-devel git curl faad2 freetype2 flac fluidsynth libjpeg-turbo libogg libvorbis libmad libmpeg2 libtheora libpng nasm readline sdl2 sdl2_net zlib fribidi

Per default, some Arch based distributions like Manjaro and Antergos require the usage of "sudo" to gain root access.

FreeBSD-based distributions

The following should install all the needed libraries:

pkg install git gmake pkgconf sdl2 faad2 freetype2 libogg libvorbis libiconv libmpeg2 libtheora libmad png flac fluidsynth sndio liba52 fribidi jpeg-turbo

For cloud and lan features you also need the SDL2_net and curl libraries:

pkg install sdl2_net curl

You can also obtain libgtk (to use the gtk file browser), and speech-dispatcher (for text to speech):

pkg install gtk3 speech-dispatcher

OpenBSD-based distributions

The following should install all the needed libraries:

pkg_add git gmake sdl2 faad libogg libvorbis libiconv libmpeg2 libtheora libmad png flac fluidsynth liba52 fribidi jpeg

For cloud and lan features you also need the SDL2_net and curl libraries:

pkg_add sdl2-net curl

You can also obtain libgtk (to use the gtk file browser), and speech-dispatcher (for text to speech):

pkg_add gtk+3 speech-dispatcher

Configuring ScummVM

Run the configure script in the directory with the ScummVM source files:

./configure

If no errors come up, you should be ready to compile ScummvM.

It's possible to build ScummVM with Clang instead of GCC using the following command:

CXX=clang++ ./configure

This is necessary in order to build ScummVM on OpenBSD.

For a list of optional features (e.g. additional, not yet enabled engines) run:

./configure --help

Note: If you are building ScummVM on a system with low main memory (for example, lower than 256MB), you might run out of memory during linking. If you use GNU ld for compiling you can try exporting LDFLAGS="-Wl,--no-keep-memory" before running configure. This tells GNU ld to optimize for memory usage.

Compiling ScummVM

Run:

make clean
make

It is recommended to run parallel make. For example to run with 10 CPU cores use:

make -j10

A good number is to use the number of your CPU cores, including virtual ones, +2. Typical Intel Core i7 has 8 CPU cores.

On BSD systems, it is necessary to use GNU make, since BSD make will not work with ScummVM. Instead, run:

gmake clean
gmake

Installing ScummVM

either run ./scummvm from the current directory or run make install to install ScummVM (you can then run it using "scummvm" from any directory)

Further reading