Compiling xoreos: Difference between revisions

From xoreos Wiki
Jump to navigation Jump to search
m (→‎Libraries: Boost was bumped to 1.48.0)
 
(62 intermediate revisions by 2 users not shown)
Line 4: Line 4:
==Compiler and build system==
==Compiler and build system==


xoreos is written in C++, so a C++ compiler, like [https://gcc.gnu.org/ GCC] or [http://clang.llvm.org/ clang] is required. Its build system is based on [https://en.wikipedia.org/wiki/GNU_build_system Autotools], more specifically [https://www.gnu.org/software/autoconf/ Autoconf], [https://www.gnu.org/software/automake/ Automake] and [https://www.gnu.org/software/libtool/ Libtool].
xoreos is written in C++, so a C++ compiler, like [https://gcc.gnu.org/ GCC] or [http://clang.llvm.org/ clang] is required. xoreos follows the C++14 standard. It has two build systems: [https://en.wikipedia.org/wiki/GNU_build_system Autotools] ([https://www.gnu.org/software/autoconf/ Autoconf], [https://www.gnu.org/software/automake/ Automake] and [https://www.gnu.org/software/libtool/ Libtool]) and [https://en.wikipedia.org/wiki/CMake CMake]. Use whichever you feel more comfortable with.


===GNU/Linux===
===GNU/Linux===
Line 10: Line 10:
On Debian-based distributions (including Ubuntu), you should be able to install the required compiler and build system packages with
On Debian-based distributions (including Ubuntu), you should be able to install the required compiler and build system packages with


  <nowiki>apt-get install libc6-dev g++ make autoconf automake libtool</nowiki>
  <nowiki>sudo apt-get install libc6-dev g++ make autoconf automake libtool gettext cmake</nowiki>


On other distributions, it should work similarily.  
On Arch Linux, you can install the necessary packages with
 
<nowiki>sudo pacman -S base-devel cmake</nowiki>
 
On other distributions, it should work similarily.


===Mac OS X===
===Mac OS X===
Line 20: Line 24:
===Windows===
===Windows===


Our build system is autotools-based, so we unfortunately do not support Visual Studio. Windows users need to install [http://www.mingw.org/ MinGW]. For further information, please read [[#A note on build systems and Visual Studio|this note]].
Since Visual Studio does not work with autotools, you have to use the CMake build system if you want to compile xoreos with Visual Studio. If you're using [http://www.mingw.org/ MinGW], however, you're free to choose either build system.
 
On Windows, it is recommended that instead of Visual Studio, you use [https://msys2.github.io/ MSYS2] together with [https://mingw-w64.org/ Mingw-w64] (which can produce both 32-bit and 64-bit binaries). MSYS2 provides a package manager, with which you can install xoreos' library dependencies very easily.
 
You can install the 32-bit toolchain in MSYS2 with
 
<nowiki>pacman -S base-devel git mingw-w64-i686-toolchain mingw-w64-i686-cmake</nowiki>
 
You can install the 64-bit toolchain in MSYS2 with
 
<nowiki>pacman -S base-devel git mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake</nowiki>


==Libraries==
==Libraries==
Line 29: Line 43:
* [http://www.zlib.net/ zlib] (>= 1.2.3.4)
* [http://www.zlib.net/ zlib] (>= 1.2.3.4)
* [http://tukaani.org/xz/ liblzma] (>= 5.0.5)
* [http://tukaani.org/xz/ liblzma] (>= 5.0.5)
* [http://www.boost.org/ Boost] (>= 1.48.0)
* [http://www.xmlsoft.org/ libxml2] (>= 2.8.0)
* [http://www.boost.org/ Boost] (>= 1.53.0)
** Boost.Utility
** Boost.StringAlgo
** Boost.StringAlgo
** Boost.System
** Boost.System
** Boost.Filesystem
** Boost.Filesystem
** Boost.Regex
** Boost.Unordered
** Boost.Hash
** Boost.Date_Time
** Boost.Date_Time
** Boost.Function
** Boost.Bind
** Boost.Uuid
** Boost.Uuid
** Boost.Smart_Ptr
** Boost.Smart_Ptr
** Boost.Atomic
** Boost.ScopeExit
** Boost.Locale
* [https://en.wikipedia.org/wiki/OpenGL OpenGL] (>= 2.1)
* [https://en.wikipedia.org/wiki/OpenGL OpenGL] (>= 2.1)
* [https://www.libsdl.org/ SDL2] (>= 2.0.0)
* [https://www.libsdl.org/ SDL2] (>= 2.0.4)
* [http://www.freetype.org/ FreeType 2] (>= 2.4.0 (libtool number >= 11.0.5))
* [http://www.freetype.org/ FreeType 2] (>= 2.4.0 (libtool number >= 11.0.5))
* [https://en.wikipedia.org/wiki/OpenAL OpenAL] (>= 1.12)
* [https://en.wikipedia.org/wiki/OpenAL OpenAL] (>= 1.12) ('''See below''')
* [http://www.underbit.com/products/mad/ MAD] (>= 1.15.1b)
* [http://www.underbit.com/products/mad/ MAD] (>= 0.15.1b)
* [https://www.xiph.org/downloads/ libogg] (>= 1.2.0)
* [https://www.xiph.org/downloads/ libogg] (>= 1.2.0)
* [https://www.xiph.org/downloads/ libvorbis] (>= 1.3.1)
* [https://www.xiph.org/downloads/ libvorbis] (>= 1.3.1)
* [http://www.audiocoding.com/faad2.html libfaad] (>= 2.7)
* [http://www.audiocoding.com/faad2.html libfaad] (>= 2.7)
* [https://www.xvid.org/ libxvidcore] (>= 1.2.2)
* [https://www.xvid.org/ libxvidcore] (>= 1.2.2)
* [https://www.webmproject.org/code/ libvpx] (>= 1.6.0)


On Debian-based GNU/Linux distribution (including Ubuntu), you should be able to install these libraries and their development packages with
On Debian-based GNU/Linux distribution (including Ubuntu), you should be able to install these libraries and their development packages with


  apt-get install zlib1g-dev liblzma-dev libboost-all-dev libsdl2-dev libfreetype6-dev \
  sudo apt-get install zlib1g-dev liblzma-dev libxml2-dev libboost-all-dev libsdl2-dev \
    libopenal-dev libmad0-dev libogg-dev libvorbis-dev libfaad-dev libxvidcore-dev
    libfreetype6-dev libopenal-dev libmad0-dev libogg-dev libvorbis-dev libfaad-dev \
    libxvidcore-dev libvpx-dev


Other GNU/Linux distributions should work similarily. Windows users have to visit each website manually and download a precompiled version, or, if not available, download the source and compile the library themselves.
On Arch Linux, you can install these dependencies with
 
sudo pacman -S zlib xz libxml2 boost boost-libs sdl2 freetype2 openal libmad libogg \
    libvorbis faad2 xvidcore libvpx
 
Other GNU/Linux distributions should work similarily.
 
On Windows, if you're using MSYS2, you can install these dependencies for 32-bit with
 
  pacman -S mingw-w64-i686-zlib mingw-w64-i686-xz mingw-w64-i686-libxml2 \
    mingw-w64-i686-boost mingw-w64-i686-SDL2 mingw-w64-i686-freetype \
    mingw-w64-i686-openal mingw-w64-i686-libmad mingw-w64-i686-libogg \
    mingw-w64-i686-libvorbis  mingw-w64-i686-faad2 mingw-w64-i686-xvidcore \
    mingw-w64-i686-libvpx
 
On Windows, if you're using MSYS2, you can install these dependencies for 64-bit with
 
  pacman -S mingw-w64-x86_64-zlib mingw-w64-x86_64-xz mingw-w64-x86_64-libxml2 \
    mingw-w64-x86_64-boost mingw-w64-x86_64-SDL2 mingw-w64-x86_64-freetype \
    mingw-w64-x86_64-openal mingw-w64-x86_64-libmad mingw-w64-x86_64-libogg \
    mingw-w64-x86_64-libvorbis  mingw-w64-x86_64-faad2 mingw-w64-x86_64-xvidcore \
    mingw-w64-x86_64-libvpx
 
Windows users not using MSYS2 will have to visit each website manually and download a precompiled version, or, if not available, download the source and compile the library themselves. Alternatively, vcpkg can be used to install most of these libraries.
 
=== A note on OpenAL ===
 
On Mac OS X, we're using Apple's OpenAL implementation, so OpenAL does not need to be installed separately there.
 
On both GNU/Linux and Microsoft Windows, we require [http://kcat.strangesoft.net/openal.html OpenAL Soft]. There is a propriety OpenAL implementation by Creative Labs, Inc. for Microsoft Windows, which can be found at [http://openal.org/ http://openal.org/], but it's unfortunately old, outdated and abandoned. We do not recommend its use.
 
Likewise, on NetBSD and other systems using pkgsrc, you should use [http://pkgsrc.se/audio/openal-soft openal-soft] instead of [http://pkgsrc.se/audio/openal openal].


==Compiling xoreos==
==Compiling xoreos==


Open a terminal, change into the directory of your sources and type
Make sure you have your compiler, build system and libraries installed correctly. Then open a terminal and change into the directory of your sources.
 
===autotools===
 
Type


  <nowiki>./autogen.sh && ./configure && make</nowiki>
  <nowiki>./autogen.sh && ./configure && make</nowiki>


This ''should'' compile xoreos successfully if the compiler, build system and libraries have been installed correctly. The binary can be found in the src subdirectory, called "xoreos" or, on Windows, "xoreos.exe". Alternatively, you can install it system-wide with
The binary can be found in the src subdirectory, called "xoreos" or, on Windows, "xoreos.exe".
 
Optional, non-conventional ./configure flags:
 
{|
|
* --with-werror &nbsp;
|| Compile with -Werror
|-
|
* --without-warnings &nbsp;
|| Compile without the extra warnings enabled
|-
|
* --with-lto &nbsp;
|| Compile with link-time optimization
|-
|
* --disable-external-glew &nbsp;
|| Always compile against the internal GLEW libraries
|}
 
===CMake ===
 
Type
 
<nowiki>cmake . && make</nowiki>
 
The binary can be found in the bin subdirectory, called "xoreos" or, on Windows, "xoreos.exe".
 
This builds xoreos without any optimizations, so you might want to use
 
<nowiki>cmake -DCMAKE_BUILD_TYPE=Release . && make</nowiki>
 
(optimized, no debug information) or
 
<nowiki>cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo . && make</nowiki>
 
(optimized, with debug information) instead.
 
Please read [http://www.cmake.org/runningcmake/ Running CMake] on the CMake website for in-depth information on invoking CMake.
 
Optional, non-conventional cmake flags:
 
{|
|
* -DBoost_USE_STATIC_LIBS=on &nbsp;
|| Link Boost statically instead of dynamically
|-
|
* -DGLEW_INTERNAL=on &nbsp;
|| Always use internal GLEW library
|}
 
'''Note''': The CMake's stock FindBoost.cmake doesn't correctly detect dependencies when linking statically. In this case, xoreos might fail to link, missing symbols for ICU, when linking Boost statically.
 
Moreover, if you're running GNU/Linux and have wrapper scripts installed that force the building of "hardened" binaries (often called "hardening-wrapper", but differs between Linux distributions), compiling xoreos might fail during the linking stage, when using statically linking Boost libraries. This is due to those static Boost libraries being incompatible with the compiler option "-fPIE", which is often added by hardening wrapper scripts. A workaround is to disable -fPIE for this compilation (which is distribution-specific).
 
==Unit tests==


<nowiki>make install</nowiki>
On both build systems,


Please also have a look at the [[Running xoreos]] page.
<nowiki>make check</nowiki>


==A note on build systems and Visual Studio==
compiles and runs our unit tests.


There are certain build systems that promise to generate both standard Makefiles and Visual Studio project files. I have tried CMake, SCons and qmake, and found them all lacking, so they're unfortunately not an option for xoreos.
==Running xoreos==


Another options would be to parse our Automake files, and generate Visual Studio project files out of them. ScummVM does something similar with its [https://github.com/scummvm/scummvm/tree/master/devtools/create_project create_project], but their Makefiles are a bit different than ours. Somebody™ "just" needs to adapt ScummVM's create_project. So far, no one has.
Please have a look at the [[Running xoreos]] page.

Latest revision as of 13:29, 26 August 2020

This page gives a few tips and pointers on how to compile xoreos on various platforms.

Compiler and build system

xoreos is written in C++, so a C++ compiler, like GCC or clang is required. xoreos follows the C++14 standard. It has two build systems: Autotools (Autoconf, Automake and Libtool) and CMake. Use whichever you feel more comfortable with.

GNU/Linux

On Debian-based distributions (including Ubuntu), you should be able to install the required compiler and build system packages with 

sudo apt-get install libc6-dev g++ make autoconf automake libtool gettext cmake

On Arch Linux, you can install the necessary packages with 

sudo pacman -S base-devel cmake

On other distributions, it should work similarily.

Mac OS X

Due to the dependency on SDL2 (see below), you need at least Mac OS X 10.5 if you use a precompiled SDL2 library, and at least Mac OS X 10.7 if you're compiling SDL2 yourself.

Windows

Since Visual Studio does not work with autotools, you have to use the CMake build system if you want to compile xoreos with Visual Studio. If you're using MinGW, however, you're free to choose either build system.

On Windows, it is recommended that instead of Visual Studio, you use MSYS2 together with Mingw-w64 (which can produce both 32-bit and 64-bit binaries). MSYS2 provides a package manager, with which you can install xoreos' library dependencies very easily.

You can install the 32-bit toolchain in MSYS2 with 

pacman -S base-devel git mingw-w64-i686-toolchain mingw-w64-i686-cmake

You can install the 64-bit toolchain in MSYS2 with 

pacman -S base-devel git mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake

Libraries

xoreos uses the following libraries to function:

On Debian-based GNU/Linux distribution (including Ubuntu), you should be able to install these libraries and their development packages with 

sudo apt-get install zlib1g-dev liblzma-dev libxml2-dev libboost-all-dev libsdl2-dev \
    libfreetype6-dev libopenal-dev libmad0-dev libogg-dev libvorbis-dev libfaad-dev \
    libxvidcore-dev libvpx-dev

On Arch Linux, you can install these dependencies with 

sudo pacman -S zlib xz libxml2 boost boost-libs sdl2 freetype2 openal libmad libogg \
    libvorbis faad2 xvidcore libvpx

Other GNU/Linux distributions should work similarily.

On Windows, if you're using MSYS2, you can install these dependencies for 32-bit with 

 pacman -S mingw-w64-i686-zlib mingw-w64-i686-xz mingw-w64-i686-libxml2 \
    mingw-w64-i686-boost mingw-w64-i686-SDL2 mingw-w64-i686-freetype \
    mingw-w64-i686-openal mingw-w64-i686-libmad mingw-w64-i686-libogg \
    mingw-w64-i686-libvorbis  mingw-w64-i686-faad2 mingw-w64-i686-xvidcore \
    mingw-w64-i686-libvpx

On Windows, if you're using MSYS2, you can install these dependencies for 64-bit with 

 pacman -S mingw-w64-x86_64-zlib mingw-w64-x86_64-xz mingw-w64-x86_64-libxml2 \
    mingw-w64-x86_64-boost mingw-w64-x86_64-SDL2 mingw-w64-x86_64-freetype \
    mingw-w64-x86_64-openal mingw-w64-x86_64-libmad mingw-w64-x86_64-libogg \
    mingw-w64-x86_64-libvorbis  mingw-w64-x86_64-faad2 mingw-w64-x86_64-xvidcore \
    mingw-w64-x86_64-libvpx

Windows users not using MSYS2 will have to visit each website manually and download a precompiled version, or, if not available, download the source and compile the library themselves. Alternatively, vcpkg can be used to install most of these libraries.

A note on OpenAL

On Mac OS X, we're using Apple's OpenAL implementation, so OpenAL does not need to be installed separately there.

On both GNU/Linux and Microsoft Windows, we require OpenAL Soft. There is a propriety OpenAL implementation by Creative Labs, Inc. for Microsoft Windows, which can be found at http://openal.org/, but it's unfortunately old, outdated and abandoned. We do not recommend its use.

Likewise, on NetBSD and other systems using pkgsrc, you should use openal-soft instead of openal.

Compiling xoreos

Make sure you have your compiler, build system and libraries installed correctly. Then open a terminal and change into the directory of your sources.

autotools

Type 

./autogen.sh && ./configure && make

The binary can be found in the src subdirectory, called "xoreos" or, on Windows, "xoreos.exe".

Optional, non-conventional ./configure flags:

  • --with-werror  
 Compile with -Werror
  • --without-warnings  
 Compile without the extra warnings enabled
  • --with-lto  
 Compile with link-time optimization
  • --disable-external-glew  
 Always compile against the internal GLEW libraries

CMake

Type 

cmake . && make

The binary can be found in the bin subdirectory, called "xoreos" or, on Windows, "xoreos.exe".

This builds xoreos without any optimizations, so you might want to use 

cmake -DCMAKE_BUILD_TYPE=Release . && make

(optimized, no debug information) or 

cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo . && make

(optimized, with debug information) instead.

Please read Running CMake on the CMake website for in-depth information on invoking CMake.

Optional, non-conventional cmake flags:

  • -DBoost_USE_STATIC_LIBS=on  
 Link Boost statically instead of dynamically
  • -DGLEW_INTERNAL=on  
 Always use internal GLEW library

Note: The CMake's stock FindBoost.cmake doesn't correctly detect dependencies when linking statically. In this case, xoreos might fail to link, missing symbols for ICU, when linking Boost statically.

Moreover, if you're running GNU/Linux and have wrapper scripts installed that force the building of "hardened" binaries (often called "hardening-wrapper", but differs between Linux distributions), compiling xoreos might fail during the linking stage, when using statically linking Boost libraries. This is due to those static Boost libraries being incompatible with the compiler option "-fPIE", which is often added by hardening wrapper scripts. A workaround is to disable -fPIE for this compilation (which is distribution-specific).

Unit tests

On both build systems, 

make check

compiles and runs our unit tests.

Running xoreos

Please have a look at the Running xoreos page.

Retrieved from "https://wiki.xoreos.org/index.php?title=Compiling_xoreos&oldid=460"