Compiling Phaethon - Revision history

DrMcCoy: /* CMake */

2020-08-26T13:29:47Z

CMake

← Older revision		Revision as of 13:29, 26 August 2020
Line 130:		Line 130:
	<nowiki>cmake . && make</nowiki>		<nowiki>cmake . && make</nowiki>

	The ~~binaries~~ can ~~then~~ be found in the bin subdirectory.		The binary can be found in the bin subdirectory, called "phaethon" or, on Windows, "phaethon.exe".

			This builds Phaethon 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.		Please read [http://www.cmake.org/runningcmake/ Running CMake] on the CMake website for in-depth information on invoking CMake.

DrMcCoy: /* Libraries */

2020-05-18T10:41:53Z

Libraries

← Older revision		Revision as of 10:41, 18 May 2020
Line 44:		Line 44:
	** Boost.System		** Boost.System
	** Boost.Filesystem		** Boost.Filesystem
	** Boost.Unordered
	** Boost.Hash
	** Boost.Date_Time		** Boost.Date_Time
	** Boost.Chrono		** Boost.Chrono
	** Boost.Function
	** Boost.Uuid		** Boost.Uuid
	** Boost.Smart_Ptr		** Boost.Smart_Ptr

DrMcCoy: /* Libraries */ Update

2020-05-17T17:38:05Z

Libraries: Update

← Older revision		Revision as of 17:38, 17 May 2020
Line 39:		Line 39:
	* [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.xmlsoft.org/ libxml2] (>= 2.8.0)
	* [http://www.boost.org/ Boost] (>= 1.53.0)		* [http://www.boost.org/ Boost] (>= 1.53.0)
	** Boost.Utility		** Boost.Utility
Line 45:		Line 44:
	** Boost.System		** Boost.System
	** Boost.Filesystem		** Boost.Filesystem
	** Boost.Regex
	** Boost.Unordered		** Boost.Unordered
	** Boost.Hash		** Boost.Hash
Line 51:		Line 49:
	** Boost.Chrono		** Boost.Chrono
	** Boost.Function		** Boost.Function
	** Boost.Bind
	** Boost.Uuid		** Boost.Uuid
	** Boost.Smart_Ptr		** Boost.Smart_Ptr
	** Boost.ScopeExit		** Boost.ScopeExit
	** Boost.Atomic
	** Boost.Locale		** Boost.Locale
	** Boost.Thread
	* [https://www.qt.io/ Qt] (>= 5.7.1)		* [https://www.qt.io/ Qt] (>= 5.7.1)
	** Qt5Core		** Qt5Core
Line 70:		Line 65:
	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

	sudo apt-get install zlib1g-dev liblzma~~-dev libxml2~~-dev libboost-all-dev \		sudo apt-get install zlib1g-dev liblzma-dev libboost-all-dev \
	libopenal-dev libmad0-dev libogg-dev libvorbis-dev \		libopenal-dev libmad0-dev libogg-dev libvorbis-dev \
	qtbase5-dev, libqt5gui5, libqt5widgets5		qtbase5-dev, libqt5gui5, libqt5widgets5
Line 76:		Line 71:
	On Arch Linux, you can install these dependencies with		On Arch Linux, you can install these dependencies with

	sudo pacman -S zlib xz ~~libxml2~~ boost boost-libs openal libmad libogg \		sudo pacman -S zlib xz boost boost-libs openal libmad libogg \
	libvorbis qt5-base		libvorbis qt5-base

Line 83:		Line 78:
	On Windows, if you're using MSYS2, you can install these dependencies for 32-bit with		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~~ \		pacman -S mingw-w64-i686-zlib mingw-w64-i686-xz \
	mingw-w64-i686-boost mingw-w64-i686-openal mingw-w64-i686-libmad \		mingw-w64-i686-boost mingw-w64-i686-openal mingw-w64-i686-libmad \
	mingw-w64-i686-libogg mingw-w64-i686-libvorbis mingw-w64-i686-qt-creator		mingw-w64-i686-libogg mingw-w64-i686-libvorbis mingw-w64-i686-qt-creator
Line 89:		Line 84:
	On Windows, if you're using MSYS2, you can install these dependencies for 64-bit with		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~~ \		pacman -S mingw-w64-x86_64-zlib mingw-w64-x86_64-xz \
	mingw-w64-x86_64-boost mingw-w64-x86_64-openal mingw-w64-x86_64-libmad \		mingw-w64-x86_64-boost mingw-w64-x86_64-openal mingw-w64-x86_64-libmad \
	mingw-w64-x86_64-libogg mingw-w64-x86_64-libvorbis mingw-w64-x86_64-qt-creator		mingw-w64-x86_64-libogg mingw-w64-x86_64-libvorbis mingw-w64-x86_64-qt-creator

DrMcCoy: Add a page explaining how to compile Phaethon

2019-02-10T14:20:09Z

Add a page explaining how to compile Phaethon

New page

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

==Compiler and build system==

Phaethon is written in C++, so a C++ compiler, like [https://gcc.gnu.org/ GCC] or [http://clang.llvm.org/ clang] is required. Phaethon 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===

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 gettext</nowiki>

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.

===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 [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==

Phaethon uses the following libraries to function:

* [https://en.wikipedia.org/wiki/Iconv iconv]
* [http://www.zlib.net/ zlib] (>= 1.2.3.4)
* [http://tukaani.org/xz/ liblzma] (>= 5.0.5)
* [http://www.xmlsoft.org/ libxml2] (>= 2.8.0)
* [http://www.boost.org/ Boost] (>= 1.53.0)
** Boost.Utility
** Boost.StringAlgo
** Boost.System
** Boost.Filesystem
** Boost.Regex
** Boost.Unordered
** Boost.Hash
** Boost.Date_Time
** Boost.Chrono
** Boost.Function
** Boost.Bind
** Boost.Uuid
** Boost.Smart_Ptr
** Boost.ScopeExit
** Boost.Atomic
** Boost.Locale
** Boost.Thread
* [https://www.qt.io/ Qt] (>= 5.7.1)
** Qt5Core
** Qt5Gui
** Qt5Widgets
** Qt5Concurrent
* [https://en.wikipedia.org/wiki/OpenAL OpenAL] (>= 1.12) ('''See below''')
* [http://www.underbit.com/products/mad/ MAD] (>= 0.15.1b)
* [https://www.xiph.org/downloads/ libogg] (>= 1.2.0)
* [https://www.xiph.org/downloads/ libvorbis] (>= 1.3.1)

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 \
libopenal-dev libmad0-dev libogg-dev libvorbis-dev \
qtbase5-dev, libqt5gui5, libqt5widgets5

On Arch Linux, you can install these dependencies with

sudo pacman -S zlib xz libxml2 boost boost-libs openal libmad libogg \
libvorbis qt5-base

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-openal mingw-w64-i686-libmad \
mingw-w64-i686-libogg mingw-w64-i686-libvorbis mingw-w64-i686-qt-creator

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-openal mingw-w64-x86_64-libmad \
mingw-w64-x86_64-libogg mingw-w64-x86_64-libvorbis mingw-w64-x86_64-qt-creator

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.

=== 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 Phaethon==

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>

The binaries can then be found in the src subdirectory.

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
|}

===CMake ===

Type

<nowiki>cmake . && make</nowiki>

The binaries can then be found in the bin subdirectory.

Please read [http://www.cmake.org/runningcmake/ Running CMake] on the CMake website for in-depth information on invoking CMake.

==Unit tests==

On both build systems,

<nowiki>make check</nowiki>

compiles and runs our unit tests.