Compiling (OpenXcom)

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