Installation FAQ (OpenXcom) - Revision history

Hobbes: Undo revision 126397 by Hobbes (talk)

2026-03-10T14:52:16Z

Undo revision 126397 by Hobbes (talk)

Hobbes: Removed protection from "Installation FAQ (OpenXcom)"

2026-03-10T14:46:25Z

Removed protection from "Installation FAQ (OpenXcom)"

← Older revision		Revision as of 14:46, 10 March 2026
(No difference)

Hobbes: Protected "Installation FAQ (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2026-03-10T13:50:43Z

Protected "Installation FAQ (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 13:50, 10 March 2026
(No difference)

Hobbes: Redirected page to OpenXcom

2026-03-10T13:50:36Z

Redirected page to OpenXcom

Show changes

Warboy1982: /* How do I install mods? */

2017-03-17T00:08:56Z

How do I install mods?

← Older revision		Revision as of 00:08, 17 March 2017
Line 100:		Line 100:
	== How do I install mods? ==		== How do I install mods? ==

	Make sure you have the required OpenXcom version. Mods will either be formatted for v1.0, the latest ~~nightlie~~ or have a minimum nightly build. You don't need to track down the specific one, anything later will usually work as well.		Make sure you have the required OpenXcom version. Mods will either be formatted for v1.0, the latest nightly or have a minimum nightly build. You don't need to track down the specific one, anything later will usually work as well.

	When in doubt, <u>always check the mod installation instructions</u> carefully.		When in doubt, <u>always check the mod installation instructions</u> carefully.

Warboy1982: /* Nightlies (eventually to be used for v2.0) */

2017-03-17T00:04:13Z

Nightlies (eventually to be used for v2.0)

← Older revision		Revision as of 00:04, 17 March 2017
Line 90:		Line 90:
	*** MAPS		*** MAPS
	*** ROUTES		*** ROUTES
	*** Shaders
	*** SOUND		*** SOUND
	*** TERRAIN		*** TERRAIN

IvanDogovich: Added links to video tutorials.

2016-09-25T15:50:45Z

Added links to video tutorials.

← Older revision		Revision as of 15:50, 25 September 2016
Line 165:		Line 165:

	Backup any content you wanna keep (eg. saves), delete your OpenXcom folder and your User folder, and then reinstall.		Backup any content you wanna keep (eg. saves), delete your OpenXcom folder and your User folder, and then reinstall.

			== Is there a video tutorial that might help me walk through this? ==

			There is a video here: "[http://www.youtube.com/watch?v=L1WUpX9n7gY OpenXCOM Nightly Install Tutorial]" that explains installing the '''Nightly''' (both with the installer and manually) and installing both simple and total conversion '''mods'''.

			For help installing and configuring the 1.0 Milestone version see [http://www.youtube.com/watch?v=rNneKAwvjoU this video].

	[[Category:OpenXcom]]		[[Category:OpenXcom]]

Frumple at 02:02, 12 November 2015

2015-11-12T02:02:00Z

← Older revision		Revision as of 02:02, 12 November 2015
Line 1:		Line 1:
	~~Brief answers for brief questions.~~

	'''For the sake of clarity, the current milestone is ~~classified as~~ <u>v1.0</u>, ~~while all~~ [[NIGHTLIES]] after May 1, 2015 follow a different structure <u>See Below</u>.'''		'''For the sake of clarity, the current milestone (stable) release is <b>v1.0</b>. Nightly builds <u>offer features not available in <b>1.0</b></u> and will eventually become the <b>v2.0</b> milestone release. Though mentioned in this document, the <b>2.0</b> version doesn't exist yet!'''

			'''All [[NIGHTLIES]] after May 1, 2015 follow a different folder structure! <u>See Below</u>.'''

	== What are milestones and nightlies? ==		== What are milestones and nightlies? ==
Line 7:		Line 8:
	Milestones are key "versions" of the game, packaged for all platforms with the appropriate installers. You can rest assured that everything that applies to a specific milestone version is never changing and is the same across all its builds and platforms.		Milestones are key "versions" of the game, packaged for all platforms with the appropriate installers. You can rest assured that everything that applies to a specific milestone version is never changing and is the same across all its builds and platforms.

	Nightlies are automatically made from the latest code, so they have no "version". They contain the latest changes as well as the latest bugs. There's no harm in using them, but they change frequently, so don't use them if you like stability. They need to be manually installed.		Nightlies, or "nightly builds" are automatically made from the latest code, so they have no "version". They contain the latest changes as well as the latest bugs. There's no harm in using them, but they change frequently, so don't use them if you like stability. They need to be manually installed.

	For example, v2.0 ~~contains TFTD, but it hasn't made it to a milestone yet, so you need to use a nightly to try it~~.		For example, the latest nightly builds offer limited support for TFTD as well as other features, while the 1.0 stable release does not.

	== What are the Data and User folders? ==		== What are the Data and User folders? ==
Line 15:		Line 16:
	Assuming you installed the game in a ''OpenXcom'' folder:		Assuming you installed the game in a ''OpenXcom'' folder:

	The Data folder is where all the original and new game data is kept. In v1.0 it's your ''OpenXcom\data'' folder. ~~In v2.0~~ it's the ''OpenXcom'' folder itself.		The Data folder is where all the original and new game data is kept:
			In v1.0 it's your ''OpenXcom\data'' folder.
			When using nightlies, it's the ''OpenXcom'' folder itself. Allways check the readme included with the download, because features in nightly builds may change quicker than this page can be updated.

	The User folder is where all your options, screenshots and saves are kept. ~~In v2.0~~ it also ~~contains~~ your mods (in v1.0 they were in the Data folder instead). The default User folder on Windows is in ''C:\Users\<user>\Documents\OpenXcom''.		The User folder is where all your options, screenshots and saves are kept.
			For nightlies, it's also where your mods should be placed (in v1.0 they were in the Data folder instead).
			The default User folder on Windows is in ''C:\Users\<user>\Documents\OpenXcom''.

	For advanced users, you can also have multiple Data folders, as well as your Data folder inside your User folder. For all possible folder locations see here: https://github.com/SupSuper/OpenXcom#directory-locations		For advanced users, you can also have multiple Data folders, as well as your Data folder inside your User folder. For all possible folder locations see here: https://github.com/SupSuper/OpenXcom#directory-locations

	== How do I manually install OpenXcom? ==		== How do I manually install OpenXcom? ==
	~~== How do I install a nightly? ==~~

	Just extract the ZIP to your install location and copy the original X-COM resources to the appropriate folders:		Just extract the ZIP to your install location and copy the original X-COM resources to the appropriate folders:
Line 48:		Line 52:
	*** UNITS		*** UNITS

	=== ~~NIGHTLIES~~ ===		=== Nightlies (eventually to be used for v2.0)===

			Copy your <b>X-COM: UFO Defense</b> data to the ''UFO'' subfolder.
			You should apply the [http://openxcom.org/download/extras/universal-patch.zip universal patch] afterwards.


	~~Copy your X-COM: UFO Defense data~~ to ~~the ''UFO'' subfolder. You should apply the [http~~:~~//openxcom.org/download/extras/universal-patch.zip universal patch] afterwards.~~		Terror from the Deep is <u>not required</u>, but if you want to include it:

	~~(and~~/~~or)~~		Copy the <b>X-COM: Terror from the Deep</b> data to the ''TFTD'' subfolder. No extra patches are required.

	~~Copy the X-COM: Terror from the Deep data to the TFTD subfolder. No extra patches are required.~~

	Your installation structure should look like this if you have both games:		Your installation structure should look like this if you have both games:
Line 94:		Line 101:
	== How do I install mods? ==		== How do I install mods? ==

	Make sure you have the required OpenXcom version. Mods will either be formatted for v1.0 or ~~NIGHTLIES. In addition, some mods may require~~ a minimum nightly ~~version~~. You don't need to track down the specific ~~nightly version~~, anything later will usually work as well.		Make sure you have the required OpenXcom version. Mods will either be formatted for v1.0, the latest nightlie or have a minimum nightly build. You don't need to track down the specific one, anything later will usually work as well.

	When in doubt, always check the mod installation instructions carefully.		When in doubt, <u>always check the mod installation instructions</u> carefully.

	=== v1.0 ===		=== v1.0 ===
Line 102:		Line 109:
	Extract the mod to your ''data'' subfolder.		Extract the mod to your ''data'' subfolder.

	=== ~~NIGHTLIES~~ ===		=== Nightlies (eventually to be used for v2.0) ===

	Extract the mod folder to your User mods folder (eg. ''Documents\OpenXcom\mods''). This folder is automatically created after running the game once. Each mod should have its own subfolder, eg:		Extract the mod folder to your User mods folder (eg. ''Documents\OpenXcom\mods''). This folder is automatically created after running the game once. Each mod should have its own subfolder, eg:
Line 111:		Line 118:
	** Mod3		** Mod3

	Mods ~~compatible with '''[[NIGHTLIES]]'''~~ should already come packed in a folder. v1.0 mods ~~need to be packed into a folder~~ yourself, and any *.rul files moved into a ''Ruleset'' subfolder inside the mod's folder, eg:		Mods made for the latest nightlies should already come packed in a folder. You will need to pack v1.0 mods for use with nightlies yourself, and any *.rul files should be moved into a ''Ruleset'' subfolder inside the mod's folder, eg:

	* mods		* mods
Line 125:		Line 132:
	== How do I update OpenXcom? ==		== How do I update OpenXcom? ==

	It's recommended you just delete the old install folder (backup anything you wanna keep) before installing the new version ~~(specially when upgrading from v1.0 to v2.0)~~, since by default your User folder is separate.		If installing a new version, or upgrading from v1.0 to a nightly build or v2.0, it's recommended you just delete the old install folder (backup anything you wanna keep) before installing the new version, since by default your User folder is separate.

			If upgrading nightlies, you can also just install the new version on top of the old one.

	~~However if the major version is the same (eg~~. ~~upgrading nightlies), you can also just install the new version on top of~~ the ~~old one~~.		Nightly saves and mods are not compatible with 1.0 unless otherwise stated. Always check the mod readme and installation instructions.

	~~Any~~ v1.0 saves and mods are fully compatible with nightlies.		v1.0 saves and mods are fully compatible with nightlies, though mods will have to be repacked manually.

	== How do I update mods? ==		== How do I update mods? ==
Line 137:		Line 146:
	== Can I make a portable installation? ==		== Can I make a portable installation? ==

	Yes, just create a ''OpenXcom\user'' folder and this will become that installation's User folder. Copy any content from your old User folder if you ~~wanna~~ reuse it.		Yes, just create a ''OpenXcom\user'' folder and this will become that installation's User folder. Copy any content from your old User folder if you want to reuse it.

	== Can I have multiple installations/versions? ==		== Can I have multiple installations/versions? ==
Line 143:		Line 152:
	Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.		Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.

	v1.0 and ~~NIGHTLIES~~ installs cannot share the same User folder.		v1.0 and nightly installs cannot share the same User folder.

	== How do I know I installed a nightly correctly? ==		== How do I know I installed a nightly correctly? ==

Xracer: /* How do I switch between UFO and TFTD? */

2015-11-12T01:47:19Z

How do I switch between UFO and TFTD?

← Older revision		Revision as of 01:47, 12 November 2015
Line 121:		Line 121:
	== How do I switch between UFO and TFTD? ==		== How do I switch between UFO and TFTD? ==

	Go into the Options > Mods screen from the Main Menu. You can't access this screen from the Geoscape/Battlescape. However, any enabled mods will automatically apply to any savegames you load.		Go into the Options > Mods screen from the Main Menu, then under the heading "[[Game Type]]" select the desired game. You can't access this screen from the Geoscape/Battlescape. However, any enabled mods will automatically apply to any savegames you load.

	== How do I update OpenXcom? ==		== How do I update OpenXcom? ==

Xracer: /* Can I have multiple installations/versions? */

2015-11-12T01:34:16Z

Can I have multiple installations/versions?

← Older revision		Revision as of 01:34, 12 November 2015
Line 143:		Line 143:
	Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.		Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.

	v1.0 and ~~v2.0~~ installs cannot share the same User folder.		v1.0 and NIGHTLIES installs cannot share the same User folder.

	== How do I know I installed a nightly correctly? ==		== How do I know I installed a nightly correctly? ==