Compiling (OpenApoc) - Revision history

Deldonut1: Added reference to build documentation

2026-03-01T21:21:45Z

Added reference to build documentation

← Older revision		Revision as of 21:21, 1 March 2026
Line 280:		Line 280:
	* [[Coding Style (OpenApoc)]] — C++ code style guidelines		* [[Coding Style (OpenApoc)]] — C++ code style guidelines
	* [[Differences to X-COM (OpenApoc)]] — How OpenApoc differs from the original game		* [[Differences to X-COM (OpenApoc)]] — How OpenApoc differs from the original game
			* [https://github.com/ayrtondenner/OpenApoc-wiki/blob/master/development/building.md OpenApoc Wiki: Building] — Extended build documentation
	* [https://github.com/OpenApoc/OpenApoc OpenApoc on GitHub] — Source code repository		* [https://github.com/OpenApoc/OpenApoc OpenApoc on GitHub] — Source code repository
	* [https://discord.gg/d6DAHEb OpenApoc Discord] — Community discussion and support		* [https://discord.gg/d6DAHEb OpenApoc Discord] — Community discussion and support

	[[Category:OpenApoc]]		[[Category:OpenApoc]]

Deldonut1: Major rewrite: updated to C++17/CMake 3.30; corrected dependency list; added macOS and troubleshooting sections

2026-03-01T21:14:53Z

Major rewrite: updated to C++17/CMake 3.30; corrected dependency list; added macOS and troubleshooting sections

Show changes

Jvlomax: Add missing qt5 development package to Linux instructions

2020-06-22T19:44:35Z

Add missing qt5 development package to Linux instructions

← Older revision		Revision as of 19:44, 22 June 2020
Line 34:		Line 34:
	(Tested on Ubuntu 16.04)		(Tested on Ubuntu 16.04)

	# Install the following packages: <pre>sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</pre>		# Install the following packages: <pre>sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev qtdeclarative5-dev</pre>
	# Checkout OpenApoc from GitHub.		# Checkout OpenApoc from GitHub.
	# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder). <pre>git submodule update --init --recursive</pre>		# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder). <pre>git submodule update --init --recursive</pre>

SupSuper: Update for Cmake

2019-03-11T23:17:45Z

Update for Cmake

← Older revision		Revision as of 23:17, 11 March 2019
Line 12:		Line 12:
	* [http://libsmacker.sourceforge.net/ libsmacker] - Decoder for .smk video files.		* [http://libsmacker.sourceforge.net/ libsmacker] - Decoder for .smk video files.
	* [http://lodev.org/lodepng/ lodepng] - Reading/writing PNG image files.		* [http://lodev.org/lodepng/ lodepng] - Reading/writing PNG image files.
			* [https://www.lua.org/ Lua] - Scripting language.
	* [https://github.com/richgel999/miniz miniz] - Zlib-comptible compression library.		* [https://github.com/richgel999/miniz miniz] - Zlib-comptible compression library.
	* [https://icculus.org/physfs/ physfs] - Library for reading data from .iso files or directory trees (Note: We use a patched version, available on [https://github.com/JonnyH/physfs-hg-import/tree/fix-iso) - required to read the .iso files we use GitHub].		* [https://icculus.org/physfs/ physfs] - Library for reading data from .iso files or directory trees (Note: We use a patched version, available on [https://github.com/JonnyH/physfs-hg-import/tree/fix-iso) - required to read the .iso files we use GitHub].
Line 20:		Line 21:

	# Checkout OpenApoc from GitHub.		# Checkout OpenApoc from GitHub.
	# If you are using the GitHub client for Windows, the submodules should already be setup at first checkout. If not using the github client, or if the submodules have been updated, run the following commands in the 'git shell' from the root of the OpenApoc repository. This should reset the submodule checkouts to the latest versions (NOTE: This will overwrite any changes to code in the dependencies/ directory).		# If you are using the GitHub client for Windows, the submodules should already be setup at first checkout. If not using the github client, or if the submodules have been updated, run the following commands in the 'git shell' from the root of the OpenApoc repository. This should reset the submodule checkouts to the latest versions (NOTE: This will overwrite any changes to code in the dependencies/ directory). <pre>git submodule update --init --recursive</pre>
			# All the other dependencies (Boost, SDL2) need to be supplied separately. Install [https://github.com/Microsoft/vcpkg Vcpkg] and run the following command: <pre>vcpkg install sdl2 boost-locale boost-system boost-program-options boost-filesystem boost-uuid boost-crc</pre>
	<pre>git submodule init
	~~git submodule update~~ -f</pre>

	# All the other dependencies (Boost, SDL2) ~~are provided automatically by nuget packages, and Visual Studio should automatically download~~ and install ~~these at the first build.~~
	# Copy the original XCom:Apocalypse .iso file into the "data/" directory. This could also be a directory containing all the extracted files from the CD, and it should be named the same (IE the directory should be data/cd.iso/). This is used during the build to extract some data tables.		# Copy the original XCom:Apocalypse .iso file into the "data/" directory. This could also be a directory containing all the extracted files from the CD, and it should be named the same (IE the directory should be data/cd.iso/). This is used during the build to extract some data tables.
	# Open ~~openapoc~~.~~sln in~~ Visual Studio.		# Open the Git directory in Visual Studio (if you don't have an Open Folder option, generate a project from CMake).
	# Build (Release/Debug x86/x64 should all work).		# Visual Studio should automatically detect and configure CMake appropriately. To add your Vcpkg dependencies, edit your CMake Settings file and add: <pre>"variables": [ { "name": "CMAKE_TOOLCHAIN_FILE", "value": "<path to vcpkg>\\scripts\\buildsystems\\vcpkg.cmake" } ]</pre>
			# If you get errors, clear your cache from the CMake menu and generate again.
			# Build (Release/Debug x86/x64 should all work). Release is recommended as Debug is very slow.
	# When running from the Visual Studio UI, the working directory is set to the root of the project, so the data folder should already be in the right place. If you want to run outside of Visual Studio, you need to copy the whole 'data' folder (including the cd.iso file) into the folder openapoc.exe resides in.		# When running from the Visual Studio UI, the working directory is set to the root of the project, so the data folder should already be in the right place. If you want to run outside of Visual Studio, you need to copy the whole 'data' folder (including the cd.iso file) into the folder openapoc.exe resides in.

Line 35:		Line 34:
	(Tested on Ubuntu 16.04)		(Tested on Ubuntu 16.04)

	# Install the following packages:		# Install the following packages: <pre>sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</pre>

	<pre>sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</pre>

	# Checkout OpenApoc from GitHub.		# Checkout OpenApoc from GitHub.
	# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder).		# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder). <pre>git submodule update --init --recursive</pre>
			# Copy the cd.iso file to the 'data' directory under the repository root (Note - despite dosbox having good linux support, the steam version of X-Com Apocalypse will only install if Steam Play is enabled). <pre>cp /path/to/cd.iso data/</pre>
	<pre>git submodule init		# Create a subdirectory ('build' in this example) in the OpenApoc checkout directory, and from that use cmake to configure OpenApoc. <pre>cd /path/to/OpenApoc mkdir build cd build cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..</pre>
	~~git submodule update~~</pre>

	# Copy the cd.iso file to the 'data' directory under the repository root (Note - despite dosbox having good linux support, the steam version of X-Com Apocalypse ~~refuses to install in steam for linux - you may need to snatch the cd.iso file off a windows steam~~ install).

	<pre>cp /path/to/cd.iso data/</pre>

	# Create a subdirectory ('build' in this example) in the OpenApoc checkout directory, and from that use cmake to configure OpenApoc.

	<pre>cd /path/to/OpenApoc
	mkdir build
	cd build
	cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..</pre>

	# This cmake command will fail if we're missing a dependency, or your system is for some other reason unable to build - if you have any issues please contact us (see above for links).		# This cmake command will fail if we're missing a dependency, or your system is for some other reason unable to build - if you have any issues please contact us (see above for links).
	# Build the project with the following command.		# Build the project with the following command. <pre>make -j4</pre>
			# This should create a directory 'bin' under the build directory, with the 'OpenApoc' executable file. OpenApoc by default expects the data folder to be in the current working directory, so running the executable from the root of the git checkout should work. <pre>./build/bin/OpenApoc</pre>
	<pre>make -j4</pre>

	# This should create a directory 'bin' under the build directory, with the 'OpenApoc' executable file. OpenApoc by default expects the data folder to be in the current working directory, so running the executable from the root of the git checkout should work.

	<pre>./build/bin/OpenApoc</pre>

	[[Category:OpenApoc]]		[[Category:OpenApoc]]

SupSuper: Fix code blocks

2019-03-09T19:05:03Z

Fix code blocks

← Older revision		Revision as of 19:05, 9 March 2019
Line 22:		Line 22:
	# If you are using the GitHub client for Windows, the submodules should already be setup at first checkout. If not using the github client, or if the submodules have been updated, run the following commands in the 'git shell' from the root of the OpenApoc repository. This should reset the submodule checkouts to the latest versions (NOTE: This will overwrite any changes to code in the dependencies/ directory).		# If you are using the GitHub client for Windows, the submodules should already be setup at first checkout. If not using the github client, or if the submodules have been updated, run the following commands in the 'git shell' from the root of the OpenApoc repository. This should reset the submodule checkouts to the latest versions (NOTE: This will overwrite any changes to code in the dependencies/ directory).

	<~~nowiki~~>~~cmd~~		<pre>git submodule init
	git submodule init		git submodule update -f</pre>
	git submodule update -f</~~nowiki~~>

	# All the other dependencies (Boost, SDL2) are provided automatically by nuget packages, and Visual Studio should automatically download and install these at the first build.		# All the other dependencies (Boost, SDL2) are provided automatically by nuget packages, and Visual Studio should automatically download and install these at the first build.
Line 38:		Line 37:
	# Install the following packages:		# Install the following packages:

	<~~nowiki~~>sh		<pre>sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</pre>
	sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</~~nowiki~~>

	# Checkout OpenApoc from GitHub.		# Checkout OpenApoc from GitHub.
	# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder).		# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder).

	<~~nowiki~~>sh		<pre>git submodule init
	git submodule init		git submodule update</pre>
	git submodule update</~~nowiki~~>

	# Copy the cd.iso file to the 'data' directory under the repository root (Note - despite dosbox having good linux support, the steam version of X-Com Apocalypse refuses to install in steam for linux - you may need to snatch the cd.iso file off a windows steam install).		# Copy the cd.iso file to the 'data' directory under the repository root (Note - despite dosbox having good linux support, the steam version of X-Com Apocalypse refuses to install in steam for linux - you may need to snatch the cd.iso file off a windows steam install).

	<~~nowiki~~>sh		<pre>cp /path/to/cd.iso data/</pre>
	cp /path/to/cd.iso data/</~~nowiki~~>

	# Create a subdirectory ('build' in this example) in the OpenApoc checkout directory, and from that use cmake to configure OpenApoc.		# Create a subdirectory ('build' in this example) in the OpenApoc checkout directory, and from that use cmake to configure OpenApoc.

	<~~nowiki~~>sh		<pre>cd /path/to/OpenApoc
	cd /path/to/OpenApoc
	mkdir build		mkdir build
	cd build		cd build
	cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..</~~nowiki~~>		cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..</pre>

	# This cmake command will fail if we're missing a dependency, or your system is for some other reason unable to build - if you have any issues please contact us (see above for links).		# This cmake command will fail if we're missing a dependency, or your system is for some other reason unable to build - if you have any issues please contact us (see above for links).
	# Build the project with the following command.		# Build the project with the following command.

	<~~nowiki~~>sh		<pre>make -j4</pre>
	make -j4</~~nowiki~~>

	# This should create a directory 'bin' under the build directory, with the 'OpenApoc' executable file. OpenApoc by default expects the data folder to be in the current working directory, so running the executable from the root of the git checkout should work.		# This should create a directory 'bin' under the build directory, with the 'OpenApoc' executable file. OpenApoc by default expects the data folder to be in the current working directory, so running the executable from the root of the git checkout should work.

	<~~nowiki~~>sh		<pre>./build/bin/OpenApoc</pre>
	./build/bin/OpenApoc</~~nowiki~~>

	[[Category:OpenApoc]]		[[Category:OpenApoc]]

SupSuper at 23:36, 13 March 2018

2018-03-13T23:36:04Z

← Older revision		Revision as of 23:36, 13 March 2018
Line 71:		Line 71:
	<nowiki>sh		<nowiki>sh
	./build/bin/OpenApoc</nowiki>		./build/bin/OpenApoc</nowiki>

			[[Category:OpenApoc]]

SupSuper: Created page with "== Building == OpenApocalypse is built leveraging a number of libraries - to provide needed functionality (and save us the time of implementing it ourselves badly) * [http:/..."

2018-03-13T23:33:12Z

Created page with "== Building == OpenApocalypse is built leveraging a number of libraries - to provide needed functionality (and save us the time of implementing it ourselves badly) * [http:/..."

New page

== Building ==

OpenApocalypse is built leveraging a number of libraries - to provide needed functionality (and save us the time of implementing it ourselves badly)

* [http://www.libsdl.org SDL2]
* [http://boost.org Boost] - specifially the 'locale' library, used for localisation, 'program-options' for settings management, and 'filesystem'.
* [http://www.nongnu.org/libunwind/download.html Libunwind] - debug backtracing on linux - not needed on windows.

The following libraries are also used, but are shipped as submodules in the repository and directly included in the build, so you don't need to install these dependencies to build or use openapoc.

* [http://glm.g-truc.net GLM] - Math library.
* [http://libsmacker.sourceforge.net/ libsmacker] - Decoder for .smk video files.
* [http://lodev.org/lodepng/ lodepng] - Reading/writing PNG image files.
* [https://github.com/richgel999/miniz miniz] - Zlib-comptible compression library.
* [https://icculus.org/physfs/ physfs] - Library for reading data from .iso files or directory trees (Note: We use a patched version, available on [https://github.com/JonnyH/physfs-hg-import/tree/fix-iso) - required to read the .iso files we use GitHub].
* [http://http://pugixml.org/ pugixml] - XML library used for reading/writing the game data files.
* [https://github.com/c42f/tinyformat tinyformat] - A c++ typesafe string formatting library.

=== Windows ===

# Checkout OpenApoc from GitHub.
# If you are using the GitHub client for Windows, the submodules should already be setup at first checkout. If not using the github client, or if the submodules have been updated, run the following commands in the 'git shell' from the root of the OpenApoc repository. This should reset the submodule checkouts to the latest versions (NOTE: This will overwrite any changes to code in the dependencies/ directory).

<nowiki>cmd
git submodule init
git submodule update -f</nowiki>

# All the other dependencies (Boost, SDL2) are provided automatically by nuget packages, and Visual Studio should automatically download and install these at the first build.
# Copy the original XCom:Apocalypse .iso file into the "data/" directory. This could also be a directory containing all the extracted files from the CD, and it should be named the same (IE the directory should be data/cd.iso/). This is used during the build to extract some data tables.
# Open openapoc.sln in Visual Studio.
# Build (Release/Debug x86/x64 should all work).
# When running from the Visual Studio UI, the working directory is set to the root of the project, so the data folder should already be in the right place. If you want to run outside of Visual Studio, you need to copy the whole 'data' folder (including the cd.iso file) into the folder openapoc.exe resides in.

=== Linux ===

(Tested on Ubuntu 16.04)

# Install the following packages:

<nowiki>sh
sudo apt-get install libsdl2-dev cmake build-essential git libunwind8-dev libboost-locale-dev libboost-filesystem-dev libboost-system-dev libboost-program-options-dev</nowiki>

# Checkout OpenApoc from GitHub.
# Fetch the dependencies from git with the following terminal command (run from the just-created OpenApoc folder).

<nowiki>sh
git submodule init
git submodule update</nowiki>

# Copy the cd.iso file to the 'data' directory under the repository root (Note - despite dosbox having good linux support, the steam version of X-Com Apocalypse refuses to install in steam for linux - you may need to snatch the cd.iso file off a windows steam install).

<nowiki>sh
cp /path/to/cd.iso data/</nowiki>

# Create a subdirectory ('build' in this example) in the OpenApoc checkout directory, and from that use cmake to configure OpenApoc.

<nowiki>sh
cd /path/to/OpenApoc
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..</nowiki>

# This cmake command will fail if we're missing a dependency, or your system is for some other reason unable to build - if you have any issues please contact us (see above for links).
# Build the project with the following command.

<nowiki>sh
make -j4</nowiki>

# This should create a directory 'bin' under the build directory, with the 'OpenApoc' executable file. OpenApoc by default expects the data folder to be in the current working directory, so running the executable from the root of the git checkout should work.

<nowiki>sh
./build/bin/OpenApoc</nowiki>