Compiling (OpenXcom): Difference between revisions

Latest revision as of 15:00, 10 March 2026

The OpenXcom codebase is hosted on Github, and you can grab the latest source with any Git client from: https://github.com/OpenXcom/OpenXcom.git

If you're a Github user you might wanna use a fork instead so you can have your own remote repository (you can't push to the official OpenXcom repository without permission) and easily send in pull requests.

OpenXcom is a cross-platform game so it's possible to compile it on a variety of systems and project files for all the popular IDEs are included. There's also a Doxygen documentation available.

Don't forget to copy the X-Com resources to your bin folder as shown in Installing.

Dependencies

OpenXcom requires the following libraries to compile:

SDL (libsdl1.2)
SDL_mixer (libsdl-mixer1.2)
SDL_image (libsdl-image1.2)
SDL_gfx (libsdl-gfx1.2), version 2.0.22 or later
yaml-cpp, (libyaml-cpp), version 0.5.1 (0.5.2 does not work, use latest git HEAD if you want newer version)

All operating systems

Compiling with CMake

Windows

Mac OS X

Compiling with Xcode

Linux/BSD

Installing Dependencies

On Debian and Debian-derived distributions, such as Ubuntu, all build dependencies can be installed with:

apt-get install --no-install-recommends \
    build-essential libboost-dev libsdl1.2-dev libsdl-mixer1.2-dev \
    libsdl-image1.2-dev libsdl-gfx1.2-dev libyaml-cpp-dev xmlto

The --no-install-recommends prevents xmlto from pulling along a gigabyte of unnecessary LaTeX packages.

Build Instructions

Android

Compiling for Android

OpenXcom Extended (OXCE)

See Compiling and cross-compiling OXCE

Covers:

Windows / VS2107
Linux / CMake
MacOS / CMake
Linux / MXE cross-compile for Windows
Android / Gradle
iOS / XCode

@@ Line 1: / Line 1: @@
-The OpenXcom codebase is hosted on [https://github.com/SupSuper/OpenXcom Github], and you can grab the latest source with any Git client from: <code>https://github.com/SupSuper/OpenXcom.git</code>
+The OpenXcom codebase is hosted on [https://github.com/OpenXcom/OpenXcom Github], and you can grab the latest source with any Git client from: <code>https://github.com/OpenXcom/OpenXcom.git</code>
 If you're a Github user you might wanna [http://help.github.com/forking use a fork] instead so you can have your own remote repository (you can't push to the official OpenXcom repository without permission) and easily send in pull requests.
@@ Line 15: / Line 15: @@
 * [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
 * [http://cms.ferzkopp.net/index.php/software/13-sdl-gfx SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
-* [http://code.google.com/p/yaml-cpp/ yaml-cpp], (libyaml-cpp), version 0.5 or later
+* [https://github.com/jbeder/yaml-cpp yaml-cpp], (libyaml-cpp), version 0.5.1 (0.5.2 does ''not'' work, use latest git HEAD if you want newer version)
-* [http://www.boost.org/ Boost], (boost)
+<!--* [http://www.boost.org/ Boost], (boost)-->
+== All operating systems ==
+* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
 == Windows ==
@@ Line 26: / Line 30: @@
 * [[Compiling with Xcode (OpenXcom)|Compiling with Xcode]]
-* [[Compiling with brew (OpenXcom)|Compiling with brew]]
 == Linux/BSD ==
+=== Installing Dependencies ===
+On Debian and Debian-derived distributions, such as Ubuntu, all build dependencies can be installed with:
+<pre>
+apt-get install --no-install-recommends \
+    build-essential libboost-dev libsdl1.2-dev libsdl-mixer1.2-dev \
+    libsdl-image1.2-dev libsdl-gfx1.2-dev libyaml-cpp-dev xmlto
+</pre>
+The <code>--no-install-recommends</code> prevents <code>xmlto</code> from pulling along a gigabyte of unnecessary LaTeX packages.
+=== Build Instructions ===
 * [[Compiling with Make (OpenXcom)|Compiling with Make]]
-* [[Compiling with Autotools (OpenXcom)|Compiling with Autotools]]
+* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
-== Misc. ==
+== Android ==
-* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
 * [[Android port (OpenXcom)|Compiling for Android]]
+== OpenXcom Extended (OXCE) ==
+See [https://openxcom.org/forum/index.php/topic,7048.0.html Compiling and cross-compiling OXCE]
+Covers:
+* Windows / VS2107
+* Linux / CMake
+* MacOS / CMake
+* Linux / MXE cross-compile for Windows
+* Android / Gradle
+* iOS / XCode
 [[Category:OpenXcom]]