Difference between revisions of "Installing (OpenXcom)"

From UFOpaedia
Jump to navigation Jump to search
(Fixed path to support folder)
 
(21 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
'''OpenXcom requires a vanilla version of the original [[X-COM]] resources.''' This includes:
+
'''OpenXcom requires a vanilla version of the original [[X-COM]] resources.''' This can be any one of:
  
−
* DOS Version 1.4: You can check if you have the correct version if it contains a "SOUND\GM.CAT" file.
+
* DOS Version 1.4 (you can check if you have the correct version if it contains a "SOUND\GM.CAT" file)
−
* Windows Version / Collector's Edition.
+
* Windows Version / Collector's Edition
−
* Steam Version: You can find the game folder in "Steam\steamapps\common\xcom ufo defense\XCOM".
+
* Steam Version (you can find the game folder in "Steam\steamapps\common\xcom ufo defense\XCOM")
 +
* Gog Version
  
−
'''Do not''' use modded versions (eg. [[XcomUtil]]) as they may cause bugs and crashes.
+
Make sure your copy has the [http://openxcom.org/index.php/downloads-extras/ latest patch]. '''Do not''' use modded versions (eg. [[XcomUtil]]) as they may cause bugs and crashes.
  
−
Just copy the game subfolders (GEODATA, GEOGRAPH, MAPS, ROUTES, SOUND, TERRAIN, UFOGRAPH, UFOINTRO, UNITS) to OpenXcom's Data folder (usually the "data" subfolder).
+
== OXC Versions ==
 +
First, you should decide what exactly you want to install.
 +
* "Nightlies". Development versions - less polished, much more recent, not really nightly, but actually update every few months: [https://openxcom.org/git-builds/ released builds], [https://github.com/OpenXcom/OpenXcom repository].
 +
* OpenXcom Extended, aka OXCE. Cutting edge, extra-modding-friendly development version: [https://openxcom.org/forum/index.php/topic,5258.0.html released builds], [https://github.com/MeridianOXC/OpenXcom repository].
 +
* And there's also available the OpenXcom 1.0 release but it has been discontinued a long time ago - use the nightlies or OXCE instead.
  
−
== Windows ==
+
== Instructions ==
  
−
The installer will automatically detect Steam installations and take care of the resource copying for you, just follow the instructions.
+
In the instructions below, we refer to three different folders a lot: the "data" folder, the "user" folder, and the "config" folder.  See [https://github.com/SupSuper/OpenXcom#directory-locations here] for directory definitions and where they are located on your operating system.
  
−
If installing manually, copy the resources to the '''data''' subfolder.
+
=== All platforms ===
  
−
== Mac OS X ==
+
Copy the original resources (specifically the GEODATA, GEOGRAPH, MAPS, ROUTES, SOUND, TERRAIN, UFOGRAPH, UFOINTRO, and UNITS subfolders) to OpenXcom's [https://github.com/SupSuper/OpenXcom#directory-locations Data folder] for version 1.0 or to the UFO folder in the [https://github.com/SupSuper/OpenXcom#directory-locations User folder] for the nightly. If using the nightly, you can alternately/additionally copy in Terror From the Deep files to the TFTD folder in your User folder to prepare for when the TFTD OpenXcom ruleset is released.  '''Do not''' just drag/copy your whole X-COM folder into the Data folder, it won't work.
  
−
Copy the resources to the application's '''data''' resource (right click the application > Show Package Contents > Contents > Resources > data).
+
For version 1.0 it should end up like this:
  
−
== Unix-like ==
+
* data
 +
** '''GEODATA'''
 +
** '''GEOGRAPH'''
 +
** Language
 +
** '''MAPS'''
 +
** Resources
 +
** '''ROUTES'''
 +
** Ruleset
 +
** Shaders
 +
** SoldierName
 +
** '''SOUND'''
 +
** '''TERRAIN'''
 +
** '''UFOGRAPH'''
 +
** '''UFOINTRO'''
 +
** '''UNITS'''
  
−
OpenXcom requires the following libraries:
+
and for the nightly it should look like this:
−
 
 
−
* [http://www.libsdl.org/ SDL] (libsdl1.2)
 
−
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
 
−
* [http://www.ferzkopp.net/joomla/content/view/19/14/ SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
 
−
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
 
−
* [http://timidity.sourceforge.net/ TiMidity++] (timidity), if you need MIDI playback
 
−
* [http://code.google.com/p/yaml-cpp/ yaml-cpp] (libyaml-cpp0.3), version 0.3.0 or older
 
  
−
Check your distribution's package manager or the library website on how to install them.
+
* '''UFO'''
 +
** '''GEODATA'''
 +
** '''GEOGRAPH'''
 +
** '''MAPS'''
 +
** '''ROUTES'''
 +
** '''SOUND'''
 +
** '''TERRAIN'''
 +
** '''UFOGRAPH'''
 +
** '''UFOINTRO'''
 +
** '''UNITS'''
  
−
If installing through a package manager, you should copy the resources to '''/usr/share/openxcom/data''', otherwise the '''data''' subfolder is preferred.
+
If you do this incorrectly, you'll get an error about "X not found".  For more specific instructions, check your platform below.
  
−
== Data Folder ==  
+
==== Video tutorial ====
  
−
In most cases the OpenXcom data is in the '''data''' subfolder, but it will also look in one of the following paths.  
+
A video tutorial that covers the installation of milestone version 1.0 [http://www.youtube.com/watch?v=rNneKAwvjoU is available here] (courtesy of [http://www.youtube.com/channel/UCHymw9FSZqharCpMW-WiiHg Ivan Dogovich]). Though recorded for the Windows platform, check it out if you have doubts about a particular step during the installation.
  
−
You can also specify your own path by passing the command-line argument "-data <data path>". The X-COM and OpenXcom data can be in different folders.
+
This video: "[http://www.youtube.com/watch?v=L1WUpX9n7gY OpenXCOM Nightly Install Tutorial]" explains installing the '''Nightly''' (both with the installer and manually) and installing both simple and total conversion '''mods'''.
  
−
* <game directory>\data
+
=== Windows ===
  
−
=== Windows ===
+
The installer will automatically detect Steam installations, patch the game and copy the original data for you, just follow the instructions.
−
* C:\Documents and Settings\<user>\My Documents\OpenXcom\data
 
−
* C:\Users\<user>\Documents\OpenXcom\data
 
  
 
=== Mac OS X ===
 
=== Mac OS X ===
−
* <application resources>\data (Mac OS X)
+
 
−
* ~/Library/Application Support/OpenXcom/data (Mac OS X)
+
Copy the resources to the application's '''data''' resource (right click the application > Show Package Contents > Contents > Resources > data) for version 1.0 or the UFO and/or TFTD resources for the nightly.
  
 
=== Unix-like ===
 
=== Unix-like ===
−
* $XDG_DATA_HOME/openxcom/data (Linux)
 
−
* $XDG_DATA_DIRS/openxcom/data (Linux)
 
  
−
== User Folder ==
+
OpenXcom requires the following libraries:
−
OpenXcom automatically creates a User folder with all the screenshots, savegames and options in one of the following paths.
 
  
−
You can also specify your own path by passing the command-line argument "-user <user path>".
+
* [http://www.libsdl.org/ SDL] (libsdl1.2)
 +
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
 +
* [http://www.ferzkopp.net/joomla/content/view/19/14/ SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
 +
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
 +
* [http://code.google.com/p/yaml-cpp/ yaml-cpp] (libyaml-cpp), version 0.5.1 or later (please note that 0.5.2 has issues, use 0.5.3)
  
−
* <game directory>\user\
+
Check your distribution's package manager or the library website on how to install them.
  
−
=== Windows ===
+
Copy game resources to the appropriate [https://github.com/SupSuper/OpenXcom#linux folder locations].
−
* C:\Documents and Settings\<user>\My Documents\OpenXcom
 
−
* C:\Users\<user>\Documents\OpenXcom
 
  
−
=== Mac OS X ===
+
=== Portable ===
−
* ~/Library/Application Support/OpenXcom
 
  
−
=== Unix-like ===
+
To make a portable version of OpenXcom, just put all the files in the game folder, with a '''data''' (1.0) or '''UFO''' (nightly) subfolder for the resources and a '''user''' subfolder for your saves and settings (you may need to delete your old User Folder so the game doesn't use it instead).
−
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
 
−
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)
 
  
 
== Log file ==
 
== Log file ==
  
−
In case you experience any problems or errors during the initial game loading/startup, these will be shown and logged in ''openxcom.log'' in the User Folder. Make sure you installed everything correctly as instructed, and if you still experience problems, check the [http://openxcom.org/forum/ forums].
+
In case you experience any problems or errors during the initial game loading/startup, these will be shown and logged in ''openxcom.log'' in the [https://github.com/SupSuper/OpenXcom#directory-locations User Folder]. Make sure you installed everything correctly as instructed, and if you still experience problems, check the [http://openxcom.org/forum/ forums].
−
 
 
−
== Portable Installations ==
 
  
−
To make a portable version of OpenXcom, just put all the files in the same folder, with a '''data''' subfolder for the resources and a '''user''' subfolder for your saves and settings.
 
  
 
[[Category:OpenXcom]]
 
[[Category:OpenXcom]]

Latest revision as of 16:59, 17 July 2023

OpenXcom requires a vanilla version of the original X-COM resources. This can be any one of:

  • DOS Version 1.4 (you can check if you have the correct version if it contains a "SOUND\GM.CAT" file)
  • Windows Version / Collector's Edition
  • Steam Version (you can find the game folder in "Steam\steamapps\common\xcom ufo defense\XCOM")
  • Gog Version

Make sure your copy has the latest patch. Do not use modded versions (eg. XcomUtil) as they may cause bugs and crashes.

OXC Versions

First, you should decide what exactly you want to install.

  • "Nightlies". Development versions - less polished, much more recent, not really nightly, but actually update every few months: released builds, repository.
  • OpenXcom Extended, aka OXCE. Cutting edge, extra-modding-friendly development version: released builds, repository.
  • And there's also available the OpenXcom 1.0 release but it has been discontinued a long time ago - use the nightlies or OXCE instead.

Instructions

In the instructions below, we refer to three different folders a lot: the "data" folder, the "user" folder, and the "config" folder. See here for directory definitions and where they are located on your operating system.

All platforms

Copy the original resources (specifically the GEODATA, GEOGRAPH, MAPS, ROUTES, SOUND, TERRAIN, UFOGRAPH, UFOINTRO, and UNITS subfolders) to OpenXcom's Data folder for version 1.0 or to the UFO folder in the User folder for the nightly. If using the nightly, you can alternately/additionally copy in Terror From the Deep files to the TFTD folder in your User folder to prepare for when the TFTD OpenXcom ruleset is released. Do not just drag/copy your whole X-COM folder into the Data folder, it won't work.

For version 1.0 it should end up like this:

  • data
    • GEODATA
    • GEOGRAPH
    • Language
    • MAPS
    • Resources
    • ROUTES
    • Ruleset
    • Shaders
    • SoldierName
    • SOUND
    • TERRAIN
    • UFOGRAPH
    • UFOINTRO
    • UNITS

and for the nightly it should look like this:

  • UFO
    • GEODATA
    • GEOGRAPH
    • MAPS
    • ROUTES
    • SOUND
    • TERRAIN
    • UFOGRAPH
    • UFOINTRO
    • UNITS

If you do this incorrectly, you'll get an error about "X not found". For more specific instructions, check your platform below.

Video tutorial

A video tutorial that covers the installation of milestone version 1.0 is available here (courtesy of Ivan Dogovich). Though recorded for the Windows platform, check it out if you have doubts about a particular step during the installation.

This video: "OpenXCOM Nightly Install Tutorial" explains installing the Nightly (both with the installer and manually) and installing both simple and total conversion mods.

Windows

The installer will automatically detect Steam installations, patch the game and copy the original data for you, just follow the instructions.

Mac OS X

Copy the resources to the application's data resource (right click the application > Show Package Contents > Contents > Resources > data) for version 1.0 or the UFO and/or TFTD resources for the nightly.

Unix-like

OpenXcom requires the following 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 (libyaml-cpp), version 0.5.1 or later (please note that 0.5.2 has issues, use 0.5.3)

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

Copy game resources to the appropriate folder locations.

Portable

To make a portable version of OpenXcom, just put all the files in the game folder, with a data (1.0) or UFO (nightly) subfolder for the resources and a user subfolder for your saves and settings (you may need to delete your old User Folder so the game doesn't use it instead).

Log file

In case you experience any problems or errors during the initial game loading/startup, these will be shown and logged in openxcom.log in the User Folder. Make sure you installed everything correctly as instructed, and if you still experience problems, check the forums.

Retrieved from "https://www.ufopaedia.org/index.php?title=Installing_(OpenXcom)&oldid=114728"