Installing (OpenApoc): Difference between revisions
Updated Installation Instructions |
Major rewrite: updated installation steps for current releases; added GOG and Steam instructions; added troubleshooting |
||
| Line 1: | Line 1: | ||
'''Installing (OpenApoc)''' covers how to download, install, and run [https://github.com/OpenApoc/OpenApoc OpenApoc] on Windows, Linux, and macOS. OpenApoc is an open-source reimplementation of [[Apocalypse|X-COM: Apocalypse]] and requires the original game files to play. | |||
''' | '''Note:''' OpenApoc is currently in '''alpha''' state. Expect bugs, crashes, and incomplete features. Please report issues on the [https://github.com/OpenApoc/OpenApoc/issues bug tracker]. | ||
== System Requirements == | |||
( | * '''Video card''': OpenGL 2.0 compatible | ||
* '''Original game files''': X-COM: Apocalypse (from [https://store.steampowered.com/app/7660/XCOM_Apocalypse/ Steam], [https://www.gog.com/game/xcom_apocalypse GOG], or the original retail CD) | |||
* '''Windows only''': Latest [https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist Visual C++ Redistributable] | |||
=== Supported Platforms === | |||
* | * Windows (x64) | ||
* | * Linux | ||
* | * macOS (including Apple Silicon) | ||
== Downloading OpenApoc == | |||
=== GitHub Releases (Recommended) === | |||
The primary download location for OpenApoc is the '''[https://github.com/OpenApoc/OpenApoc/releases GitHub Releases]''' page. This provides the latest official Windows builds. | |||
# Visit [https://github.com/OpenApoc/OpenApoc/releases https://github.com/OpenApoc/OpenApoc/releases] | |||
# Download the appropriate installer or zip package | |||
# Run the installer and follow the prompts | |||
'''Note:''' Linux and macOS users must compile from source. See '''[[Compiling (OpenApoc)]]''' for instructions. | |||
=== | === AppVeyor CI Builds (Experimental) === | ||
# | For users who want the very latest (and potentially unstable) development builds, experimental Windows x64 builds are available from AppVeyor: | ||
# Visit [https://ci.appveyor.com/project/OpenApoc/openapoc/history https://ci.appveyor.com/project/OpenApoc/openapoc/history] | |||
# Look for a build with a '''green''' bar indicating a successful build (use "Show More" to list additional builds if needed) | |||
# Click on the green build entry | |||
# Click '''ARTIFACTS''' | |||
# Download the file ending in <code>.exe</code> that does '''not''' contain "debug" in the filename | |||
# Run the downloaded installer | |||
'''Warning:''' AppVeyor CI builds are experimental and may contain untested changes. Only Windows x64 builds are available from AppVeyor. For stable releases, use GitHub Releases instead. | |||
== Setting Up Original Game Files == | |||
OpenApoc requires the original X-COM: Apocalypse game data to run. The game files must include the '''music tracks'''; pirated or incomplete disc images that are missing music will cause problems such as crashes and map issues. | |||
=== Steam === | |||
# Locate your Steam installation of X-COM: Apocalypse | |||
#* The default path is typically: <code>C:\Program Files (x86)\Steam\steamapps\common\X-COM Apocalypse</code> | |||
# Find the <code>cd.iso</code> file in the Steam installation directory | |||
# Copy <code>cd.iso</code> into the OpenApoc <code>data</code> folder | |||
'''Note:''' On Linux, the Steam version of X-COM: Apocalypse will only install if '''Steam Play''' (Proton) is enabled. | |||
=== GOG === | |||
The GOG version provides the game data as <code>.cue</code> and <code>.bin</code> files. These require a specific setup: | |||
# Locate the GOG installation directory for X-COM: Apocalypse | |||
# Find the <code>XCOM.cue</code> and <code>XCOM.BIN</code> files | |||
# '''Rename''' <code>XCOM.cue</code> to <code>cd.iso</code> | |||
# Place the renamed <code>cd.iso</code> file into the OpenApoc <code>data</code> folder | |||
# Place <code>XCOM.BIN</code> into the OpenApoc <code>data</code> folder '''without renaming it''' | |||
Both files (<code>cd.iso</code> and <code>XCOM.BIN</code>) must be present in the <code>data</code> folder for the GOG version to work correctly. | |||
=== Original Retail CD === | |||
# Create an ISO disc image from your original X-COM: Apocalypse CD-ROM | |||
#* You can use tools such as [https://www.imgburn.com/ ImgBurn] (Windows) or <code>dd</code> (Linux/macOS) to create the image | |||
# Rename the resulting image file to <code>cd.iso</code> | |||
# Place <code>cd.iso</code> into the OpenApoc <code>data</code> folder | |||
=== Alternative: Specify Location During Installation === | |||
If you use the Windows installer, you may specify the location of <code>cd.iso</code> during the installation process. In that case, you do not need to manually copy the file into the <code>data</code> folder. | |||
== Running OpenApoc == | |||
=== Windows === | |||
After installation, run OpenApoc from the Start Menu shortcut or from the installation directory. Ensure that: | |||
* The <code>data</code> folder (containing <code>cd.iso</code>) is present in the OpenApoc installation directory (unless you specified a different location during install) | |||
* The latest [https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist Visual C++ Redistributable] is installed | |||
=== Linux === | |||
Linux does not have prebuilt packages; you must compile from source (see '''[[Compiling (OpenApoc)]]'''). After building, run the executable from the repository root so that it can find the <code>data</code> folder: | |||
./build/bin/OpenApoc | |||
=== macOS === | |||
macOS does not have prebuilt packages; you must compile from source (see '''[[Compiling (OpenApoc)]]'''). After building, run the application from the repository root: | |||
open ./build/bin/OpenApoc.app | |||
== Portable Installation == | |||
The Windows installer offers a '''portable install''' option. When selected, all save games and configuration settings are stored within the installation directory rather than in your user profile. This is useful if you want to: | |||
* Run OpenApoc from a USB drive or external storage | |||
* Keep multiple independent installations with separate settings | |||
* Easily back up or move your entire OpenApoc setup including saves | |||
To use portable mode, select the "portable install" option when running the installer. | |||
== Post-Installation Configuration == | |||
OpenApoc stores its settings in a file named <code>OpenApoc_settings.conf</code>. For portable installations, this file is located in the installation directory. For standard installations, it is located in your user profile directory. | |||
You can create or edit this file to configure common settings. Below are some useful options. | |||
=== Changing Language to English === | |||
If OpenApoc displays blank buttons or garbled text because your system language is not English, you can force English by adding the following to <code>OpenApoc_settings.conf</code>: | |||
<pre> | |||
[Framework] | |||
Language=en_GB.UTF-8 | |||
</pre> | |||
Restart OpenApoc after saving the file. | |||
=== Fullscreen Mode === | |||
To run OpenApoc in fullscreen at a specific resolution, add the following to <code>OpenApoc_settings.conf</code>: | |||
<pre> | |||
[Framework.Screen] | |||
Width=1920 | Width=1920 | ||
Height=1080 | Height=1080 | ||
Fullscreen= | Fullscreen=1 | ||
</pre> | |||
Adjust the <code>Width</code> and <code>Height</code> values to match your monitor's resolution. | |||
=== Skipping the Intro Movie === | |||
To skip the intro movie on startup, add the following to <code>OpenApoc_settings.conf</code>: | |||
<pre> | |||
[Game] | |||
SkipIntro=1 | |||
</pre> | |||
== Updating OpenApoc == | |||
When updating to a newer version of OpenApoc, it is recommended to install to a '''new folder''' rather than overwriting the existing installation. In-place updates may cause issues. After verifying that the new version works correctly, you can delete the old installation folder. | |||
Your save games and settings will be preserved if you are using a standard (non-portable) installation, since they are stored in your user profile directory. | |||
== Troubleshooting == | |||
=== Blank Buttons in the Interface === | |||
This is a known issue that can occur when your system's native language is not English. OpenApoc has translations in multiple languages, but not all fonts are available yet. To fix this: | |||
* Set the language to English using the <code>OpenApoc_settings.conf</code> file as described in the [[#Changing Language to English|Post-Installation Configuration]] section above | |||
* Check the [https://github.com/OpenApoc/OpenApoc/issues bug tracker] for the latest status of this issue | |||
=== Crashes or Map Problems === | |||
If you experience crashes at startup or broken maps during gameplay: | |||
* Verify that your <code>cd.iso</code> is a complete copy of the original game including all music tracks | |||
* Incomplete or pirated disc images that are missing music are known to cause these issues | |||
* Re-acquire the game files from a legitimate source (Steam, GOG, or original CD) | |||
=== GOG Version Not Working === | |||
If the GOG version does not load correctly: | |||
* Ensure you have '''both''' <code>cd.iso</code> (the renamed <code>XCOM.cue</code>) and <code>XCOM.BIN</code> in the <code>data</code> folder | |||
* Ensure <code>XCOM.BIN</code> has '''not''' been renamed | |||
=== Missing Visual C++ Runtime (Windows) === | |||
If OpenApoc fails to start on Windows with errors about missing DLLs: | |||
* Download and install the latest [https://docs.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist Visual C++ Redistributable] from Microsoft | |||
=== Getting Help === | |||
If you encounter issues not covered here: | |||
* Search the [https://github.com/OpenApoc/OpenApoc/issues bug tracker] for known issues | |||
* Join the [https://discord.gg/f8Rayre OpenApoc Discord] server, which is the most active community hub for support and discussion | |||
== See Also == | |||
* [[Compiling (OpenApoc)]] - Building OpenApoc from source code | |||
* [[Controls (OpenApoc)]] - Keyboard and mouse controls | |||
* [[Coding Style (OpenApoc)]] - Development coding standards | |||
* [[Differences to X-COM (OpenApoc)]] - How OpenApoc differs from the original game | |||
* [[Credits (OpenApoc)]] - Project contributors | |||
* [https://github.com/OpenApoc/OpenApoc OpenApoc on GitHub] - Source code repository | |||
[[Category:OpenApoc]] | [[Category:OpenApoc]] | ||
Latest revision as of 23:32, 1 March 2026
Installing (OpenApoc) covers how to download, install, and run OpenApoc on Windows, Linux, and macOS. OpenApoc is an open-source reimplementation of X-COM: Apocalypse and requires the original game files to play.
Note: OpenApoc is currently in alpha state. Expect bugs, crashes, and incomplete features. Please report issues on the bug tracker.
System Requirements
- Video card: OpenGL 2.0 compatible
- Original game files: X-COM: Apocalypse (from Steam, GOG, or the original retail CD)
- Windows only: Latest Visual C++ Redistributable
Supported Platforms
- Windows (x64)
- Linux
- macOS (including Apple Silicon)
Downloading OpenApoc
GitHub Releases (Recommended)
The primary download location for OpenApoc is the GitHub Releases page. This provides the latest official Windows builds.
- Visit https://github.com/OpenApoc/OpenApoc/releases
- Download the appropriate installer or zip package
- Run the installer and follow the prompts
Note: Linux and macOS users must compile from source. See Compiling (OpenApoc) for instructions.
AppVeyor CI Builds (Experimental)
For users who want the very latest (and potentially unstable) development builds, experimental Windows x64 builds are available from AppVeyor:
- Visit https://ci.appveyor.com/project/OpenApoc/openapoc/history
- Look for a build with a green bar indicating a successful build (use "Show More" to list additional builds if needed)
- Click on the green build entry
- Click ARTIFACTS
- Download the file ending in
.exethat does not contain "debug" in the filename - Run the downloaded installer
Warning: AppVeyor CI builds are experimental and may contain untested changes. Only Windows x64 builds are available from AppVeyor. For stable releases, use GitHub Releases instead.
Setting Up Original Game Files
OpenApoc requires the original X-COM: Apocalypse game data to run. The game files must include the music tracks; pirated or incomplete disc images that are missing music will cause problems such as crashes and map issues.
Steam
- Locate your Steam installation of X-COM: Apocalypse
- The default path is typically:
C:\Program Files (x86)\Steam\steamapps\common\X-COM Apocalypse
- The default path is typically:
- Find the
cd.isofile in the Steam installation directory - Copy
cd.isointo the OpenApocdatafolder
Note: On Linux, the Steam version of X-COM: Apocalypse will only install if Steam Play (Proton) is enabled.
GOG
The GOG version provides the game data as .cue and .bin files. These require a specific setup:
- Locate the GOG installation directory for X-COM: Apocalypse
- Find the
XCOM.cueandXCOM.BINfiles - Rename
XCOM.cuetocd.iso - Place the renamed
cd.isofile into the OpenApocdatafolder - Place
XCOM.BINinto the OpenApocdatafolder without renaming it
Both files (cd.iso and XCOM.BIN) must be present in the data folder for the GOG version to work correctly.
Original Retail CD
- Create an ISO disc image from your original X-COM: Apocalypse CD-ROM
- You can use tools such as ImgBurn (Windows) or
dd(Linux/macOS) to create the image
- You can use tools such as ImgBurn (Windows) or
- Rename the resulting image file to
cd.iso - Place
cd.isointo the OpenApocdatafolder
Alternative: Specify Location During Installation
If you use the Windows installer, you may specify the location of cd.iso during the installation process. In that case, you do not need to manually copy the file into the data folder.
Running OpenApoc
Windows
After installation, run OpenApoc from the Start Menu shortcut or from the installation directory. Ensure that:
- The
datafolder (containingcd.iso) is present in the OpenApoc installation directory (unless you specified a different location during install) - The latest Visual C++ Redistributable is installed
Linux
Linux does not have prebuilt packages; you must compile from source (see Compiling (OpenApoc)). After building, run the executable from the repository root so that it can find the data folder:
./build/bin/OpenApoc
macOS
macOS does not have prebuilt packages; you must compile from source (see Compiling (OpenApoc)). After building, run the application from the repository root:
open ./build/bin/OpenApoc.app
Portable Installation
The Windows installer offers a portable install option. When selected, all save games and configuration settings are stored within the installation directory rather than in your user profile. This is useful if you want to:
- Run OpenApoc from a USB drive or external storage
- Keep multiple independent installations with separate settings
- Easily back up or move your entire OpenApoc setup including saves
To use portable mode, select the "portable install" option when running the installer.
Post-Installation Configuration
OpenApoc stores its settings in a file named OpenApoc_settings.conf. For portable installations, this file is located in the installation directory. For standard installations, it is located in your user profile directory.
You can create or edit this file to configure common settings. Below are some useful options.
Changing Language to English
If OpenApoc displays blank buttons or garbled text because your system language is not English, you can force English by adding the following to OpenApoc_settings.conf:
[Framework] Language=en_GB.UTF-8
Restart OpenApoc after saving the file.
Fullscreen Mode
To run OpenApoc in fullscreen at a specific resolution, add the following to OpenApoc_settings.conf:
[Framework.Screen] Width=1920 Height=1080 Fullscreen=1
Adjust the Width and Height values to match your monitor's resolution.
Skipping the Intro Movie
To skip the intro movie on startup, add the following to OpenApoc_settings.conf:
[Game] SkipIntro=1
Updating OpenApoc
When updating to a newer version of OpenApoc, it is recommended to install to a new folder rather than overwriting the existing installation. In-place updates may cause issues. After verifying that the new version works correctly, you can delete the old installation folder.
Your save games and settings will be preserved if you are using a standard (non-portable) installation, since they are stored in your user profile directory.
Troubleshooting
Blank Buttons in the Interface
This is a known issue that can occur when your system's native language is not English. OpenApoc has translations in multiple languages, but not all fonts are available yet. To fix this:
- Set the language to English using the
OpenApoc_settings.conffile as described in the Post-Installation Configuration section above - Check the bug tracker for the latest status of this issue
Crashes or Map Problems
If you experience crashes at startup or broken maps during gameplay:
- Verify that your
cd.isois a complete copy of the original game including all music tracks - Incomplete or pirated disc images that are missing music are known to cause these issues
- Re-acquire the game files from a legitimate source (Steam, GOG, or original CD)
GOG Version Not Working
If the GOG version does not load correctly:
- Ensure you have both
cd.iso(the renamedXCOM.cue) andXCOM.BINin thedatafolder - Ensure
XCOM.BINhas not been renamed
Missing Visual C++ Runtime (Windows)
If OpenApoc fails to start on Windows with errors about missing DLLs:
- Download and install the latest Visual C++ Redistributable from Microsoft
Getting Help
If you encounter issues not covered here:
- Search the bug tracker for known issues
- Join the OpenApoc Discord server, which is the most active community hub for support and discussion
See Also
- Compiling (OpenApoc) - Building OpenApoc from source code
- Controls (OpenApoc) - Keyboard and mouse controls
- Coding Style (OpenApoc) - Development coding standards
- Differences to X-COM (OpenApoc) - How OpenApoc differs from the original game
- Credits (OpenApoc) - Project contributors
- OpenApoc on GitHub - Source code repository