OpenXcom 1.0

OpenXcom is an open-source clone of the popular UFO: Enemy Unknown (X-Com: UFO Defense in USA) videogame by Microprose, licensed under the GPL and written in C++ / SDL.

See more info at the website and the wiki.

Uses modified code from SDL_gfx (LGPL) with permission from author.

Installation

OpenXcom requires a vanilla copy of the original X-Com resources. If you have the Steam version, you can find the X-Com game folder in "Steam\steamapps\common\xcom ufo defense\XCOM". Do not use modded versions (eg. XcomUtil) as they may cause bugs and crashes.

When installing manually, copy the X-Com subfolders (GEODATA, GEOGRAPH, MAPS, ROUTES, SOUND, TERRAIN, UFOGRAPH, UFOINTRO, UNITS) to OpenXcom's Data folder: \data\

The resources can be in a different folder as the OpenXcom data. You can also specify your own path by passing the command-line argument "-data " when running OpenXcom.

Windows

OpenXcom will also check the following folders:

• C:\Documents and Settings\\My Documents\OpenXcom\data (Windows 2000/XP)
• C:\Users\\Documents\OpenXcom\data (Windows Vista/7)

It's recommended you copy the resources to the "data" subfolder. The installer will automatically detect a Steam installation and copy the resources as necessary.

Mac OS X

OpenXcom will also check the following folders:

• \data
• ~/Library/Application Support/OpenXcom/data

It's recommended you copy the resources to the application's "data" resource (right click the application > Show Package Contents > Contents > Resources > data).

Linux

OpenXcom requires the following libraries:

• SDL (libsdl1.2)
• SDL_mixer (libsdl-mixer1.2)
• TiMidity++ (timidity), if you use MIDI
• SDL_gfx (libsdl-gfx1.2), version 2.0.22 or later
• SDL_image (libsdl-image1.2)
• yaml-cpp, version 0.5 or later

Check your distribution's package manager or the library website on how to install them.

According to the XDG standard, OpenXcom will also check the following folders:

• $XDG_DATA_HOME/openxcom/data
• $XDG_DATA_DIRS/openxcom/data

Or if those variables aren't available:

• ~/.local/share/openxcom/data
• /usr/share/openxcom/data
• /usr/local/share/openxcom/data

Choose whichever you prefer.

Configuration

OpenXcom has a variety of game settings and extras that can be customized, both in-game and out-game. These options are global and affect any old or new savegame.

For more details please check the wiki.

User Folder

OpenXcom creates a User folder with all the user screenshots, savegames and options in one of the following paths:

• \user\
• C:\Documents and Settings\\My Documents\OpenXcom (Windows 2000/XP)
• C:\Users\\Documents\OpenXcom (Windows Vista/7)
• ~/Library/Application Support/OpenXcom (Mac OS X)
• $XDG_DATA_HOME/openxcom (Linux)
• $XDG_CONFIG_HOME/openxcom (Linux)

You can also specify your own path by passing the command-line argument "-user " when running OpenXcom.

Development

OpenXcom requires the following developer libraries:

• SDL (libsdl1.2)
• SDL_mixer (libsdl-mixer1.2)
• SDL_gfx (libsdl-gfx1.2), version 2.0.22 or later
• SDL_image (libsdl-image1.2)
• yaml-cpp, version 0.5 or later

The source code includes files for the following tools:

• Microsoft Visual C++ 2010 or newer.
• Xcode.
• Makefile.
• CMake.
• Autotools.

It's also been tested on a variety of other tools on Windows/Mac/Linux. More detailed compiling instructions and pre-compiled dependencies are available at the wiki.