UFOpaedia - User contributions [en]

User:Kkmic

2019-03-20T07:27:59Z

Kkmic: Created page with "Huh... nothing here at the moment, sorry about that. I'll fill it up when I'll have the time."

Huh... nothing here at the moment, sorry about that. I'll fill it up when I'll have the time.

Info (XCOM2)

2015-11-23T13:32:06Z

Kkmic: /* Aliens/Enemies */ added missing brackets

[[File:XCOM2_SCREEN.PNG|450px|center]]
This page is to collect all the information related to Firaxis' upcoming XCOM 2 game, released through official channels and confirmed sources. '''XCOM 2 will be released on February 5, 2016'''. On September 10, 2015, the game was released for pre-order on steam.21 22

When adding new info please make sure to properly attribute its source(s). If there are conflicting pieces of information from different sources, list both and add them the <nowiki>{{Verify}}</nowiki> template. Any discussion/speculation about the game should be kept away from this page, use instead the [[Talk:XCOM2]] page.

==Storyline==
[[File:Advent_Solder_and_Statue.png|right|300px|The Alien Overlords]]
* The new game takes place 20 years after Earth's surrender to the aliens during the invasion. According to Jake Solomon, XCOM lost the initial alien invasion and as Earth surrendered, XCOM went underground to continue the fighting3.
* According to XCOM 2' storyline, XCOM never made it out of conventional weapons before the surrender. To Firaxis, the first game has ended with the same result of the majority of games played on Impossible Ironman, with a loss for the player. According to official stats, only 1.1% of players have earned the achievement for winning on Impossible and 1.7% for completing Ironman. 10
* The aliens established a world government called 'Advent Administration' staffed with human collaborators and their propaganda claims that the aliens had came initially in peace but by engaging the aliens in combat XCOM has caused countless casualties. They also created a holiday called 'Unification Day' to mark the date of their take over of Earth. 12
* The alien overlords have built megacities where war, poverty, crime and disease are supposedly eradicated, but which only serve as a cover for more sinister plans for humankind. Those cities have been built to attract the human population into them by offering gene therapy4.
** The megacities are a nod to [[Apocalypse|XCOM: Apocalypse]]4.
* The rest of humanity lives on the wilderness, where XCOM operates and there will also be missions there. Variety of combat environments.
* XCOM HQ is now a captured Alien Supply Ship that has been converted as a mobile command center to waging a guerrilla style war against the aliens. There have been hints by the developers that base management has been expanded, although no details have been released so far.
* Of all the characters in Enemy Unknown, at least [[Bradford (EU2012)|Bradford]] reappears on XCOM 2 still in his role as 'Central'. 10 According to the developers Bradford has been on the run until XCOM was reinstated, and until then he was a broken man due to the Council's betrayal that led to the defeat of XCOM during the invasion.
** Dr. Shen has passed away during the 20 years since XCOM lost the war, although he did manage to successfully teach his daughter everything he knew, allowing her to take up his position in the orginisation.20

==Engine==
* Wide mod support: you can create maps, new races, story lines and campaigns and share them via Steam Workshop.
* Game will be PC exclusive.
* XCOM 2 will run on a heavy modified version of the Unreal Engine 3.5 6.

==Soldiers==
[[File:03_x2_screens_overview_thm.png|right|300px|XCOM Squad]]
* The squad at the beginning of the game is not an elite force, but the player is in charge of a 'rag tag, freedom fighters, guerrilla fighters. They look like irregular troops.
* Soldiers appear to have 'Character Skills' (check Tactical picture)
* Customization now also applies to left/right arms, shoulders, etc., to reflect the rag tag nature of XCOM. Characters can also earn unique characterization features. Possible to change the gender/nationality of all human units.
* Squad sizes remain at 4-6 units.
* Carrying ability - when evacuating it is possible for soldiers to carry back to base the bodies of their injured or dead comrades4.
* All classes are capable of hacking, however only the Specialist can perform some hacks. Hacking includes devices, terminals, robotic aliens and possibly other targets.9.
* Customized soldiers can be saved to a player's pool of possible soldiers, allowing them to appear in a different campaign.24
* Pre-ordering the game grants access to the Resistance Warrior Pack, which features new customization options for your soldiers as well as a "Survivor of the Old War".21 22
===Classes===
[[File:04_x2_screens_overview_thm.png|right|300px|Sharpshooter]]
* There are 5 classes - Ranger, Sharpshooter, Grenadier, Specialist (those are evolved versions of the original 4 classes)
** 5th class is still undisclosed.
 
====Sharpshooter====
* New version of [[Sniper (EU2012)|Sniper]], can specialize in Pistol skills in alternative to the sniper rifle.
* Can wield both a sniper rifle and a pistol effectively, depending on skill tree choices17.
* Death From Above ability - grants an extra action when an enemy at a lower elevation is killed. (Sniper skill)17
* Fan Fire ability - allows three shots against a single target. (Pistol skill)17.
====Ranger====
[[File:07_x2_screens_news_thm.png|right|300px|Ranger]]
* New version of [[Assault (EU2012)|Assault]] class, carries sword, can engage on melee combat.
* Rangers carry either a Shotgun or Assault Rifle as primary weapons and a machete sword8.
* They are either damage dealing assaults or scouts that can move quickly and silently and even climb walls8.
* While advancing, they can be followed and buffed/protected by the Gremlin drone carried by the Specialist8.
* Reaper ability - every kill with a melee weapon allows for a further attack8.
* Phantom ability - when the squad is revealed, this soldier stays concealed18.
* Shadowstrike ability - bonus aim and 25 bonus critical chance when attacking enemies that can't see the Ranger18.
* Charge ability - may activate standard melee attack for free after Dashing in one turn18.
 
====Specialist====
[[File:08_x2_screens_news_thm.png|right|300px|Specialist and Gremlin drone]]
* Carries a 'Gremlin' drone that can be used as a secondary weapon, for stunning aliens or buff allies, or for hacking. AKA [[Support (EU2012)|Support]] class.
* Specialist is either support (healing, support buffs, boosting stats) or offensive (hacking and controlling enemies)9.
* Gremlin can carry a stun area effect weapon, heal, scout or even be assigned to protect a Ranger4.
** Can be upgraded to carry the stun area effect weapon or to hack a terminal 9.
* Gremlin doesn't move on its own - the Specialist needs to spend its action move for a turn to guide it.
* Specialists can get the Intrusion Protocol ability at later ranks, which allows it to hack and control robotic enemies.9
* Specialist class can improve its hacking skills faster than others9.
* Intrusion Protocol ability - The Gremlin hacks a robotic enemy and disables or takes over it12.
* Aid Protocol ability - The Gremlin grants a friendly target a bonus to Defense until the start of the next player turn18.
* Hacker ability - attempt to breach security on a network access point with the Gremlin18.
 
====Grenadier====
* The evolution of the [[Heavy (EU2012)|Heavy]] from Enemy Unknown.25[[File:Grenadier (XCOM2).jpg|300px|right]]
** The two ability trees for the Grenadier are called ''Demo expert'' and ''Heavy Gunner''.25
* Wield a Grenade Launcher and a Cannon.25
* Can be trained to focus on demoltion with the Grenade Launcher, or on making the most of the cannon.25
* New ability, ''Salvo'', allows the Grenadier to use a grenade or heavy weapon without ending his turn.25
* ''Shredder'' ability, disintegrates enemy armor25
* New ability, ''Rupture'', a "critical damage attack" that ensures the affected unit takes increased damage from all future attacks.25

==Combat System==
[[File:11_x2_screens_news_thm.png|right|300px|Readying for the ambush]]
* At the start of mission the player will have to move its units without being detected to their objectives. A lot of different elements can break concealment, not just enemies but civilians as well. Scanners can also break concealment4.
** Every XCOM unit starts the mission in concealment.8.
* XCOM now always has the first shot (aliens don't scatter for cover when activated) due to more emphasis on stealth and soldier placement before the shooting starts.
* Aliens will react differently when XCOM reveals its presence: some may still scatter or be completely surprised.4.
* New concealment system that uses waypoints to move and set up soldiers.
* Loot system - timers to recover items carried by dead aliens or even your own fallen soldiers (similar to Meld on EW). Inventory plays a bigger role since XCOM is also living off loot and scavenging.
* Weapon upgrades - variety of those4.
** Autoloaders - Grants free reload17.
** Expanded Magazines - Increased ammo capacity17.
** Can be salvaged from the battlefield and needs to be researched before use17.
* Secondary mission objectives that can be completed instead of the primary one.
* Call for EVAC can be done anywhere on the map on most mission types, as long as there is space for the Skyranger to land. There's still a danger of getting stopped by enemies when trying to reach the area designated for evacuation4.
* [[Meld (EU2012)|Meld]] will not be a part of the game and XCOM will not be able to create [[MEC Trooper (EU2012)|MEC Troopers]], although Advent will use them 13.
==Maps==
[[File:XCOM2terrains.png|right|300px|Different building versions]]
[[File:XCOM2_Wilderness_Types.png|right|300px|Different terrain versions]]

* Procedure generated maps. Large set of tiles (buildings, etc.) which are combined together to create maps. AI also made more procedural to better use the new map system. Terrain will be more dynamic and destructible, including exploding barrels and acid holes. Even floors and ceilings are destructable4.
* Free Aim (being able to target any feature, including terrain) will still be limited to weapons such grenades and rockets.7
* According to Lead Producer Garth DeAngelis, each map is a 'quilt' with holes where buildings are plugged, and the space between the buildings can be occupied with elements to display a variety of environments. 5.
* The space can be occupied by a variety of elements, and there are about 20 'diorama' sets that can be used when designing maps.
 
==Aliens/Enemies==
[[File:01_x2_screens_news_thm.png|right|300px|Sectoid]]
[[File:Viper Twitter.png|right|300px|Viper ]]
[[File:09_x2_screens_overview_thm.png|right|300px|Advent Soldiers]]
[[File:Xcom2 shieldbearer hero.jpg|right|300px|Advent Shieldbearer]]
[[File:XCOM2_stunlancer_hero.jpg|right|300px|Advent Stun Lancer]]
* The aliens have evolved significantly over 20 years and are much stronger; XCOM soldiers will not be able to take on aliens on their own early on.4
* Both new and old aliens are present.
* There are yet undisclosed mechanical aliens.9
* Aliens are able to call for reinforcements at any time.12
* '''Advent Troopers''' - human soldiers which act as city security on behalf of the aliens. They carry magnetic weaponry.4 23
** Speak a language unlike any human ones, and are nicknamed "Jabbers" by XCOM soldiers because of it.19
** Genetically modified to the point of inhuman, with no hair, flattened ears, and large, silvery eyes far apart with no orbs or pupils.19
* '''Advent Captains''' - clad in red armor with cape, stronger variants of Troopers.23
** Can AoE buff standard Troopers with "Command Aura" ability.23
** Can mark an XCOM soldier for death, forcing any Troopers in the area to focus fire on that soldier23
** Can summon reinforcements from Advent VTOL dropships.
* '''Shieldbearers''' - big, heavy troopers that can provide a Shield Bonus to other nearby enemy units on the battlefield.19 28
* '''Stun Lancers''' - aggressive soldiers who will try to get close to XCOM soldiers without regards for their own safety, can disable soldiers with a stun attack.27
* '''Advent MECs''' - similar to [[MEC_Trooper_(EU2012)|MEC Troopers]] and can do AoE damage with micro-missiles.12
* '''Advent Turrets''' - stationary, truck-mounted gauss turrets which can be hacked by XCOM soldiers.12
* '''Sectoids''' - Have now modified themselves using human DNA, making them bigger and possessing more psionic powers.
** Still carries the wrist-mounted plasma blaster.11
** ''Mind Spin'' or '' Psi Spin'' {{Verify}} is an ability with numerous possible effects, including disorientation, confusion, and mind control.
** ''Psi Reanimate'' can raise dead humans and aliens as "psi zombies" for the Sectoid to control.11
* '''Vipers''' - inspired by the [[Snakeman|Snakemen]] from the original [[X-COM|1994 Enemy Unkown]].
** True forms of the [[Thin Man (EU2012)|Thin Men]].4
** ''Tongue Pull'' can rip your soldiers from cover.11
** ''Bind'' locks soldiers in place and deals damage.11
** ''Poison Spit'' is retained from their Thin Men forms.11
* '''"Dark Collaborators"''' - humanlike individuals which may be assassination objectives.12
* '''Muton Berserkers''' - Evolved to be deadlier than before.12
* ''' Mutons''' - Evolved with Human DNA to be smarter and deadlier.15
** Gets to use ''Suppression'' right off the bat.15
** Still has ''Alien Grenades'', and will use them against groups of soldiers that don't watch their spacing.15
** Has equipped a bayonet on the front of their Plasma Rifles for use in melee.15
** Has an ability called ''Counterattack'' where they can dodge a Ranger's melee attack, and counter with a melee attack from their bayonets.15
* '''Chryssalids''' - Evolved to be deadlier than before.
** All melee attacks cause poison. 16
** XCOM soldiers and civilians killed by poison become cocoons.16
** If a cocoon is not destroyed during the gestation period, three new Chryssalids emerge.16
** Can burrow underground, but cannot move while burrowed.16
* '''Ethereals''' - Appear in various art around Advent cities. There's also a reference to 'Elders' on Advent's propaganda.12
* '''The Faceless''' - an alien race that can mimic the forms of other people.24[[File:Faceless (XCOM2).jpg|right|300px]]
** Undetectable before they transform from their civilian form.26
** "Central advises dispatching this unit from afar, Commander" - they presumably have a short-ranged or melee attack.26
* '''Archons''' - modified [[Floater (EU2012)|Floaters]] which looks like angels.
** ''Blazing Pinions'' - AoE attack like ''Cluster Bomb'' of [[Sectopod (EU2012)|Sectopod]].
** Wounded Archon will enter a frenzied state enabling them to melee attack nearby XCOM soldiers.

 

==Modding==
* Firaxis plans to release an Unreal Development Kit for XCOM 2 and the editor used to add content, either in November or later.7
* There will be Steam Workshop integration to facilitate distribution of mods 7.
* It will be possible to "literally make an Enemy Unknown map.”7
==Media==
<gallery mode="packed" widths=150px heights=100px caption="XCOM 2 Official Site">
File:01_x2_screens_media_thm.png|Tactical - Ranger class (notice sword icon)
File:02_x2_screens_overview_thm.png| Avenger - mobile XCOM base
File:06_x2_screens_overview_thm.png| Inside Avenger
File:Bradford (XCOM2).png|Officer Bradford "Central"
File:05_x2_screens_media_thm.png| New transport (updated [[Skyranger (EU2012)|Skyranger]]?)
File:03_x2_screens_overview_thm.png| XCOM squad
File:05_x2_screens_news_thm.png| XCOM squad concealed
File:07_x2_screens_overview_thm.png| XCOM soldier
File:11_x2_screens_news_thm.png|XCOM soldiers
File:07_x2_screens_news_thm.png| Ranger class
File:03_x2_screens_news_thm.png| Specialist class
File:08_x2_screens_news_thm.png| XCOM Specialist and Gremlin drone
File:04_x2_screens_overview_thm.png| Sharpshooter
File:01_x2_screens_news_thm.png| Sectoid (with human DNA)
File:02_x2_screens_media_thm.png| Sectoid (with human DNA)
File:05_x2_screens_overview_thm.png| Viper (snakewoman)
File:3_-_pBnHCEU.png|Viper
File:4_-_TwaGnRd.png|Evolved Berserker
File:2889649-xcom 2 e3 screenshot berserker .png|Evolved Berserker
File:Xc2 chryssalid.jpeg|Evolved Chryssalid
File:02_x2_screens_news_thm.png| Advent Administration
File:Advent_Solder_and_Statue.png|Advent Soldier
File:09_x2_screens_overview_thm.png| Advent Soldiers
File:04_x2_screens_media_thm.png| Advent Captain
File:1_-_zDCHlRx.png|Advent Soldiers and Captain
File:2_-_bcZ9mze.png|Advent MECs
File:2889658-xcom_2_e3_screenshot_advent-mec.png|Advent MEC
File:Muton1.jpg|Muton (with human DNA)
File:Muton2.jpg|Muton (with human DNA)
</gallery>

<gallery mode="packed" widths=150px heights=100px caption="Concepts">
File:XCOM2_ADVENT_CheckPoint.png|
File:XCOM2_ADVENT-Propaganda_Center_Atrium.png|
File:XCOM2_City_Center.png|
File:XCOM2_NewWorldOrderMood.png|
File:XCOM2_Sectoid.png|Sectoid
File:XCOM2_Viper.png|Viper
File:XCOM2_Soldiers_MedArmorGuerilla.png|Soldier
File:Bradford_Concept_(XCOM2).png|Bradford
File:Xcom2adventenemiesjpg-c7eddd_1670w.png|Advent units
</gallery>

<gallery mode="packed" widths=150px heights=100px caption="Terrains">
File:08_x2_screens_overview_thm.png|
File:06_x2_screens_news_thm.png|
File:Xcom-2-city-center-duskjpg-505ab9_1670w.png|Advent City Center (dusk)
File:Xcom-2-city-center-rainjpg-64b429_1670w.png|Advent City Center (rain)
File:XCOM2CityCentre.png|Advent City Center (fast food)
File:XCOM2_Wilderness_Types.png|Wilderness types
</gallery>

<gallery mode="packed" widths=150px heights=100px caption="Twitter, Initial Trailer and Gameplay Footage Captures">
File:XCOM2_1.png|A version of EXALT's logo?
File:XCOM2_2.png|Advent soldier with Ethereal image behind it
File:XCOM2_3.png|XCOM Squad at extraction
File:Thin Men Advent.png|Thin Man or Evolved Human (notice eye glasses and neck spots)
File:2889645-xcom_2__e3_screenshot_concealment.png|Concealment system
</gallery>

==Sources==
* 1 - Official XCOM 2 site [http://xcom.com/]
* 2 - IGN's 'XCOM 2 Reveal Trailer' [https://www.youtube.com/watch?v=2E_-2wIJIzQ&feature=youtu.be]
* 3 - IGN's 'XCOM 2: Welcoming our new alien overlords' video and article/interview with Jake Solomon [http://www.ign.com/articles/2015/06/02/xcom-2-welcoming-our-new-alien-overlords].
* 4 - IGN's 'XCOM 2 Reveal Trailer Rewind Theater' with Jake Solomon and Garth DeAngelis [http://www.ign.com/videos/2015/06/03/xcom-2-reveal-trailer-rewind-theater]
* 5 - IGN's 'XCOM 2’s Procedurally Generated Maps' [http://www.ign.com/articles/2015/06/04/xcom-2s-procedurally-generated-maps-ign-first].
* 6 - IGN's 'Why XCOM 2 had to be PC exclusive' [http://www.ign.com/articles/2015/06/05/why-xcom-2-had-to-be-pc-exclusive].
* 7 - IGN's 'XCOM 2's Exciting Modding Potential' article [http://www.ign.com/articles/2015/06/08/xcom-2s-exciting-modding-potential-ign-first].
[[Category: XCOM 2]]
* 8 - IGN's 'Meet The XCOM 2 Ranger' article and video [http://www.ign.com/articles/2015/06/09/meet-the-xcom-2-ranger-ign-first]
* 9 - IGN's 'Meet The XCOM 2 Specialist' article and video [http://www.ign.com/articles/2015/06/10/meet-the-xcom-2-specialist-ign-first]
* 10 - XCOM 2'S Bleak Future: Why Impossible Mode Is Canon - IGN First' article and video interview [http://www.ign.com/articles/2015/06/11/xcom-2s-bleak-future-why-impossible-iron-man-mode-is-canon-ign-first].
* 11 - IGN's 'Meet the XCOM2 Sectoid and Viper' [http://www.ign.com/articles/2015/06/12/meet-the-xcom-2-sectoid-and-viper-ign-first?watch]
[[Category: XCOM 2]]
* 12 - IGN's First XCOM 2 Gameplay Footage [https://www.youtube.com/watch?v=AzAKyj-KK-E&t=2m22s]
* 13 - IGN's "E3 2015: No Meld, MEC Troopers in XCOM 2" [http://ap.ign.com/e3-2015/90382/news/e3-2015-no-meld-mech-troopers-in-xcom-2]
* 14 - IGN's 'Meet the XCOM2 Muton' article [http://www.ign.com/articles/2015/07/23/xcom-2s-new-and-improved-muton-unveiled]
* 15 - Official XCOM2 Blog Post on XCOM2 Muton [http://xcom.com/news/the-muton-returns-in-xcom-2]
* 16 - XCOM 2 Exclusive Class Reveal: The Chryssalid [http://www.gamespot.com/articles/xcom-2-exclusive-class-reveal-the-chryssalid/1100-6429038]
* 17 - XCOM 2 Exclusive Class Reveal: The Sharpshooter [http://www.gamespot.com/articles/xcom-2-exclusive-class-reveal-the-sharpshooter/1100-6429035]
* 18 - Official XCOM 2 “Welcome to the Avenger” Gameplay [https://www.youtube.com/watch?v=uJ-rTdoiJZU]
* 19 - XCOM 2: Resurrection preview [http://www.amazon.com/XCOM-2-Resurrection-Greg-Keyes/dp/1608877124]
* 20 - MEET THE PERSONNEL OF THE AVENGER IN XCOM 2 [http://xcom.com/news/en-meet-the-personnel-of-the-avenger-in-xcom-2]
* 21 - XCOM: ENEMY UNKNOWN IS FREE-TO-PLAY ON STEAM THIS WEEKEND [http://xcom.com/news/xcom-enemy-unknown-is-free-to-play-on-steam-this-weekend]
* 22 - XCOM 2 on steam - [http://store.steampowered.com/app/268500/]
* 23 - IGN's 'Meet The XCOM 2 Advent Soldiers' article and video [http://au.ign.com/articles/2015/06/23/meet-the-xcom-2-advent-soldiers-ign-first]
* 24 - Firaxis Mega Panel at PAX Prime – Rising Tide and XCOM 2 [https://www.youtube.com/watch?v=1ep2OEsN07w]
* 25 - XCOM 2’S GRENADIER TURNS DEMOLITION INTO AN ARTFORM [http://xcom.com/news/en-xcom-2s-grenadier-turns-demolition-into-an-artform]
* 26 - XCOM 2’S FACELESS HIDES AMONG US [http://xcom.com/news/en-xcom-2s-faceless-hides-among-us]
* 27 - XCOM 2’S ADVENT STUN LANCER WILL DO ANYTHING TO GET NEAR [https://xcom.com/news/en-xcom-2s-advent-stun-lancer-will-do-anything-to-get-near]
* 28 - THE ADVENT SHIELDBEARER STANDS ITS GROUND IN XCOM 2 [https://xcom.com/news/the-advent-shieldbearer-stands-its-ground-in-xcom-2]

Compiling with Autotools (OpenXcom)

2015-11-03T12:06:07Z

Kkmic: Removed dependencies and source update intructions

== Required packages ==
In order to compile OpenXcom you need to install additional [[Compiling (OpenXcom)#Dependencies|dependencies]].

Check the library websites if you can't find them with your distribution's package manager.

'''Don't forget to copy the X-Com resources to your ''bin'' folder as shown in [[Installing (OpenXcom)|Installing]].'''

== Commands ==

<pre>
git clone https://github.com/SupSuper/OpenXcom.git
cd OpenXcom
./autogen.sh (optional)
./configure
make
</pre>

After last command and, hopefully, success compilation openxcom binary will be placed in bin folder. Enter to that directory and launch it:

<pre>
cd bin
./openxcom
</pre>

Now you done. Enjoy your invasion!

[[Category:OpenXcom]]

Compiling (OpenXcom)

2015-11-03T12:02:22Z

Kkmic: Added Linux dependencies packages - taken from the Compiling with Autotools page

The OpenXcom codebase is hosted on [https://github.com/SupSuper/OpenXcom Github], and you can grab the latest source with any Git client from: <code>https://github.com/SupSuper/OpenXcom.git</code>

If you're a Github user you might wanna [http://help.github.com/forking 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 [http://openxcom.org/docs/html/ Doxygen documentation] available.

'''Don't forget to copy the X-Com resources to your ''bin'' folder as shown in [[Installing (OpenXcom)|Installing]].'''

== Dependencies ==

OpenXcom requires the following libraries to compile:

* [http://www.libsdl.org/ SDL] (libsdl1.2)
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
* [http://cms.ferzkopp.net/index.php/software/13-sdl-gfx SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
* [https://github.com/jbeder/yaml-cpp 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 (OpenXcom)|Compiling with CMake]]

== Windows ==

* [[Compiling with Microsoft Visual C++ (OpenXcom)|Compiling with Microsoft Visual C++]]
* [[Compiling with MinGW (OpenXcom)|Compiling with MinGW]]

== Mac OS X ==

* [[Compiling with Xcode (OpenXcom)|Compiling with Xcode]]
* [[Compiling with brew (OpenXcom)|Compiling with brew]]

== Linux/BSD ==
=== Installing Dependencies ===

On Debian and Debian-derived distributions, such as Ubuntu, all build dependencies can be installed with:

<pre>
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
</pre>

The <code>--no-install-recommends</code> prevents <code>xmlto</code> from pulling along a gigabyte of unnecessary LaTeX packages.

=== Build Instructions ===
* [[Compiling with Make (OpenXcom)|Compiling with Make]]
* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
* [[Compiling with Autotools (OpenXcom)|Compiling with Autotools]]

== Other ==

* [[Android port (OpenXcom)|Compiling for Android]]

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2015-04-10T06:41:32Z

Kkmic: /* Music */ changed link to wiki internal

A reference of all the customizable values of everything in a [[Rulesets (OpenXcom)|ruleset]], according to the latest nightly. This page should be updated as new versions become available in order to explain the changes from [[Ruleset Reference (OpenXcom)|version 1.0]].

Some guidelines:
* If a value is omitted from the ruleset, the default is used. You cannot omit ''required'' values.
* Text strings (eg. names) are represented by string IDs from the [[Translations (OpenXcom)|language files]]
* Numerical IDs (used for sprites, sounds, etc.) start at 0, not 1.
* Boolean (yes/no) values are represented by true/false.
* World coordinates are represented in degrees (see [[WORLD.DAT]]).
* Money amounts (prices, costs, etc.) are represented in dollars.
* All paths are '''case sensitive'''! If your ruleset uses external files, make sure that they named properly as described in ruleset.

Items are ordered as they come in the ruleset. To override this, you can specify a ''listOrder''. You can find the default listOrders in [[Ruleset List Order (OpenXcom)|Ruleset List Order]].

=== Globe ===

Defines the drawing of landmasses and borders on the globe.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''data'''
| Path name of file which contains polygon and texture information. (For example WORLD.DAT).
| -
|-
| '''polygons'''
| List of polygons drawn on the globe surface. A triangle consist of seven values: the first number defines the texture, followed by three pairs of (x,y) globe coordinates. Only polygons with 3 or 4 vertices are reliable shown on the globe = 7 or 9 values per entry.
| -
|-
| '''polylines'''
| List of border lines. Each list entry consist of a list of (x,y) globe coordinates.
| -
|}

=== Countries ===

Defines one of the [[Country Funding (EU)|funding nations]], listed in ''"countries:"''. They're used for activity graphs and player scoring.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the country name.
| ''required''
|-
| '''fundingBase'''
| Country's base funding, in thousands. The starting funding can be anywhere between 1x and 2x the base funding.
| 0
|-
| '''fundingCap'''
| Country's funding cap, in thousands. Once a country reaches this maximum, it will no longer increase its funding.
| 0
|-
| '''labelLon'''
'''labelLat'''
| Longitude and latitude coordinates of the country's label on the globe. This label is only shown when the globe is zoomed in and "detail" is turned on.
| 0.0
0.0
|-
| '''areas'''
| List of "rectangles" on the globe defined as [''lon1'' ''lat1'' ''lon2'' ''lat2'']. Any activity within these areas counts towards the country's graph activity and affects their opinion of the player.
| -
|}

=== Regions ===

Defines one of the [[Geoscape (EU)#World Regions/Countries|world regions]], listed in ''"regions:"''. They're used for base placement, activity graphs and mission spawning.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the region name.
| ''required''
|-
| '''cost'''
| Amount of money spent building an X-COM base in this region (first base is free).
| 0
|-
| '''areas'''
| List of "rectangles" on the globe defined as ''[lon1, lat1, lon2, lat2]''. Any activity within these areas counts towards the region's graph activity.
| -
|-
| '''cities'''
| List of cities belonging to this region. They will be displayed on the globe and used for terror site missions. Each city is defined by their '''lon''' and '''lat''' coordinates and a '''name''' string ID. Cities can also have a '''zoom''' setting (default value is 3) which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''regionWeight'''
| Weight of this region when selecting regions for alien missions.
| 0
|-
| '''missionWeights'''
| Weighted list of the different mission types for this region (eg. ''STR_ALIEN_RESEARCH: 14'').
| -
|-
| '''missionZones'''
| List of "rectangles" (''[lon1, lat1, lon2, lat2]'') defining the mission zones for this region. Mission zones are waypoints for UFO trajectories.
| -
|-
| '''missionRegion'''
| Spawn mission in this region instead (used for regions without land).
| -
|}

=== Base Facilities ===

Defines one of the [[Base Facilities (EU)|facilities]] that can be built in an X-COM base, listed in ''"facilities:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the facility name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this facility. If none are specified, this facility is unlocked from the start.
| -
|-
| '''spriteShape'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's outer shape in the Basescape and UFOpaedia.
| -1
|-
| '''spriteFacility'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's contents in the Basescape and UFOpaedia. Drawn on top of '''spriteShape'''.
| -1
|-
| '''lift'''
| Is this facility an [[Access Lift]]? All base facilities must be connected to the lift.
| false
|-
| '''hyper'''
| Is this facility a [[Hyperwave Decoder]]? Displays extra information for detected UFOs. Only valid for radar facilities. If "true", the radar detection chance will be set to 100% regardless of '''radarChance''' value.
| false
|-
| '''mind'''
| Is this facility a [[Mind Shield]]? Reduces the chance of UFOs finding your base. Does not stack.
| false
|-
| '''grav'''
| Is this facility a [[Grav Shield]]? Doubles the power of your base defenses. Does not stack.
| false
|-
| '''size'''
| Size of the facility, in grid units. Every facility is square, so a size of 1 means 1x1, 2 means 2x2, etc. Bigger facilities are made up of multiple sprites, for example a 2x2 facility will use 4 sprites for '''spriteShape''' and 4 sprites for '''spriteFacility''' (top-left, top-right, bottom-left, bottom-right).
| 1
|-
| '''buildCost'''
| Amount of money spent to build this facility in the base.
| 0
|-
| '''buildTime'''
| Amount of days it takes for this facility to be built.
| 0
|-
| '''monthlyCost'''
| Amount of money spent monthly for the maintenance of this facility.
| 0
|-
| '''storage'''
| Amount of storage space (for items) this facility provides. See [[Base Stores]].
| 0
|-
| '''personnel'''
| Amount of personnel (soldiers, scientsts, engineers) these quarters can contain.
| 0
|-
| '''aliens'''
| Amount of live aliens this facility can contain. Only checked if the ''alienContainmentLimitEnforced'' option is enabled.
| 0
|-
| '''crafts'''
| Amount of X-COM craft this facility can contain.
| 0
|-
| '''labs'''
| Amount of lab space this facility provides for research projects.
| 0
|-
| '''workshops'''
| Amount of workshop space this facility provides for manufacture projects.
| 0
|-
| '''psiLabs'''
| Amount of soldier space this facility provides for psionic training.
| 0
|-
| '''radarRange'''
| Maximum radar detection range of this facility, in nautical miles.
| 0
|-
| '''radarChance'''
| Chance (0-100%) of this radar detecting a UFO that enters its range.
| 0
|-
| '''defense'''
| Offensive power provided by this base defense against attacking UFOs.
| 0
|-
| '''hitRatio'''
| Chance (0-100) of the base defense hitting an attacking UFO.
| 0
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense hits a target.
| -1
|-
| '''mapName'''
| [[MAPS|Map]] associated to this facility in Battlescape base defenses.
| -
|-
|}

=== Crafts ===

Defines one of the [[Craft|X-COM crafts]] that go on interception missions, listed in ''"crafts:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the craft name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this craft. If none are specified, this craft is unlocked from the start.
| -
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw this craft in the Basescape and from [[INTICON.PCK]] used to draw the damage indicator in dogfights.
modders: the corresponding extrasprite file id for BASEBITS.PCK is sprite+33 INTICON.PCK contains a minimized icon id=sprite the file id for the dogfight image is sprite+11
| -1
|-
| '''fuelMax'''
| Maximum amount of fuel this craft can carry. Crafts use up fuel based on their speed while travelling.
| 0
|-
| '''damageMax'''
| Maximum amount of damage this craft can take. If this amount is exceeded, the craft is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles. Crafts travel at max speed when flying and half speed when patrolling.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''weapons'''
| Amount of craft weapons this craft can equip. The UI can only display a max of 2 weapons.
| 0
|-
| '''soldiers'''
| Amount of soldiers this craft can carry.
| 0
|-
| '''maxItems'''
| Amount of items this craft can carry.
| 80
|-
| '''vehicles'''
| Amount of vehicles this craft can carry.
| 0
|-
| '''costBuy'''
| Amount of money spent for purchasing this craft. If set to 0, the craft will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costRent'''
| Amount of money spent monthly for renting this craft. If set to 0, the craft is not on rental and won't count towards base maintenance.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this craft.
| 0
|-
| '''refuelItem'''
| Item required for refuelling this craft. If no item is specified, the craft uses human fuel.
| 0
|-
| '''repairRate'''
| Amount of damage restored every hour while [[Repairs|Repairing]] in base.
| 1
|-
| '''refuelRate'''
| Amount of fuel restored every 30 mins while [[Refueling]] in base. If specified, a '''refuelItem''' is spent each time.
| 1
|-
| '''radarRange'''
| Detection range of the craft's radar in nautical miles. Every craft radar has a 100% detection chance.
| 600
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this craft to a base.
| 0
|-
| '''score'''
| [[Score]] lost when this craft is destroyed.
| 0
|-
| '''spacecraft'''
| Can this craft go to [[Cydonia]]?
| false
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this craft in Battlescape missions.
| -
|-
| '''deployment'''
| Custom positions for the unit deployment in the craft, listed as: ''[x, y, z, facing]''
If not specified, units are placed on empty spots from top-left to bottom-right facing top-right.
| -
|}

=== Craft Weapons ===

Defines one of the [[Craft Armaments|weapons]] equipped by X-COM craft for shooting down UFOs, listed in ''"craftWeapons:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the weapon name.
| ''required''
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the weapon in the Basescape and from [[INTICON.PCK]] used to draw the weapon in dogfights.
modders: the corresponding extrasprites file id for INTICON.PCK is sprite+5 and sprite+48 for BASEBITS.PCK
| -1
|-
| '''sound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when this weapon fires.
| -1
|-
| '''damage'''
| Amount of damage this weapon does to enemy UFOs.
| 0
|-
| '''range'''
| Maximum range of this weapon in dogfights (in meters).
| 0
|-
| '''accuracy'''
| Chance (0-100%) of each shot hitting the enemy UFO.
| 0
|-
| '''reloadCautious'''
| Time this weapon takes to fire between each shot in ''Cautious Mode''.
| 0
|-
| '''reloadStandard'''
| Time this weapon takes to fire between each shot in ''Standard Mode''.
| 0
|-
| '''reloadAggressive'''
| Time this weapon takes to fire between each shot in ''Aggressive Mode''.
| 0
|-
| '''ammoMax'''
| Maximum amount of ammo this weapon can carry.
| 0
|-
| '''rearmRate'''
| Amount of ammo restored every 30 mins while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize'''. If the '''clipSize''' of the specified ammo is 0, no '''clip'''s are spent.
| 1
|-
| '''projectileType'''
| Type of the weapon projectile, used for the projectile sprite in dogfights:
* 0 - [[Stingray]]
* 1 - [[Avalanche]]
* 2 - [[Cannon]]
* 3 - [[Fusion Ball]]
* 4 - [[Laser Cannon]]
* 5 - [[Plasma Beam]]
| 2
|-
| '''projectileSpeed'''
| Speed of the weapon projectile in dogfights.
| 0
|-
| '''launcher'''
| String ID of the [[#Items|item]] required to equip this weapon.
| -
|-
| '''clip'''
| String ID of the [[#Items|item]] required to rearm this weapon.
| -
|}

=== Items ===

Defines the Geoscape and Battlescape properties of an [[Equipment (EU)|item]] that can be stored in X-COM bases, listed in ''"items:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the internal item name.
| ''required''
|-
| '''name'''
| String ID of the displayed item name, for cases where it's different from the internal name. If omitted, '''type''' is used.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this item. If none are specified, this item is unlocked from the start. Soldiers can only use unlocked items in the Battlescape.
| -
|-
| '''size'''
| Space occupied by this item in [[Base Stores]]. Can be a decimal value.
| 0.0
|-
| '''costBuy'''
| Amount of money spent for purchasing this item. If set to 0, this item will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this item.
| 0
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this item to a base.
| 24
|-
| '''weight'''
| [[Item_Weight|Weight]] occupied by this item in a soldier's inventory.
| 999
|-
| '''bigSprite'''
| Sprite ID from [[BIGOBS.PCK]] used to draw this item in a soldier's inventory and UFOpaedia.
| -1
|-
| '''floorSprite'''
| Sprite ID from [[FLOOROB.PCK]] used to draw this item on the floor of a Battlescape tile.
| -1
|-
| '''handSprite'''
| Sprite ID from [[HANDOB.PCK]] used to draw this item on a soldier's hand in the Battlescape.
modders: each handobject needs 8 images (8 directions) define the extrasprites accordingly
| 120
|-
| '''bulletSprite'''
| Sprite ID from ''BulletSprites.png'' used to draw this weapon's projectile on the Battlescape:
* 0 - [[Rocket Launcher]]
* 1 - [[Pistol]]
* 2 - [[Rifle]]
* 3 - [[Auto Cannon]]
* 4 - [[Heavy Cannon]]
* 5 - [[Laser Pistol]]
* 6 - [[Laser Rifle]]
* 7 - [[Heavy Laser]]
* 8 - [[Plasma Rifle|Plasma]]
* 9 - [[Small Launcher]]
* 10 - [[Blaster Launcher]]
for modders: the bulletsprite needs to be put into the extraSprites type "Projectiles" the bulletsprite can contain up to 35 3x3 images. The corresponding file id is 35*[bulletSprite]
| -1
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target.
| -1
|-
| '''hitAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "hit explosion".
'''NOTE''': Do not define this value for melee/psi weapons, they use [[HIT.PCK]] and therefore meleeAnimation instead.
'''NOTE''': Explosive style weapons (Damage type: smoke, incendiary, stun, & High Explosive) use [[X1.PCK]] and should always be set to 0.
| 0
|-
| '''power'''
| Average damage of the weapon, in most cases it will be +-50% this value.
| 0
|-
| '''strengthApplied'''
| Add the attacking unit's strength to this weapon's damage.
| false
|-
| '''compatibleAmmo'''
| List of string IDs of the ammo items that can be loaded on this weapon. If none are specified, the weapon doesn't need ammo.
| -
|-
| '''damageType'''
| What type of [[damage]] does this weapon do:
* 0 - None
* 1 - Armor Piercing
* 2 - Incendiary
* 3 - High Explosive
* 4 - Laser
* 5 - Plasma
* 6 - Stun
* 7 - Melee
* 8 - Acid
* 9 - Smoke
'''NOTE:''' A damage type other than 0-9 will do nothing.
| 0
|-
| '''tuAuto'''
'''accuracyAuto'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Auto Shot. If 0, the weapon does not have an Auto Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Auto Shot.
| 0
0
|-
| '''tuSnap'''
'''accuracySnap'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire a Snap Shot. If 0, the weapon does not have a Snap Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing a Snap Shot.
| 0
0
|-
| '''tuAimed'''
'''accuracyAimed'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Aimed Shot. If 0, the weapon does not have an Aimed Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Aimed Shot.
| 0
0
|-
|-
| '''tuMelee'''
'''accuracyMelee'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to do a melee attack (Hit). If 0, the weapon does not have a melee attack.
The base accuracy (0-100%) applied to a soldier's [[Melee Accuracy]] when doing a melee attack.
| 0
0
|-
| '''clipSize'''
| The amount of ammo stored in each weapon clip. If -1 is specified, this weapon has infinite ammo.
| 0
|-
| '''battleType'''
| Defines the weapon's behavior in the Battlescape:
* 0 - None (Geoscape-only item)
* 1 - [[Weapons|Firearm]]
* 2 - Ammo
* 3 - Melee
* 4 - [[Grenade]]
* 5 - [[Proximity Grenade]]
* 6 - [[Medi-Kit (EU)|Medi-Kit]]
* 7 - [[Motion Scanner]]
* 8 - [[Mind Probe]]
* 9 - [[Psi-Amp]]
* 10 - [[Electro-flare]]
* 11 - Corpse
| 0
|-
| '''twoHanded'''
| Is this weapon two-handed? If true, incurs an accuracy penalty if used with both hands occupied. Note that the handsprite of a twoHanded item is also drawn at a slightly different position than a one handed item.
| false
|-
| '''waypoint'''
| Does this weapon use waypoints? (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system.
| false
|-
| '''fixedWeapon'''
| Is this weapon fixed? (it's part of a unit, eg. tanks and terrorist units)
| false
|-
| '''invWidth'''
| Item width in a soldier's inventory (in grid units).
| 1
|-
| '''invHeight'''
| Item height in a soldier's inventory (in grid units).
| 1
|-
| '''painKiller'''
| Amount of painkillers contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''heal'''
| Amount of heal's contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stimulant'''
| Amount of stimulants contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''woundRecovery'''
| Amount of [[Fatal Wounds]] treated by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''healthRecovery'''
| Amount of [[Health]] recovered by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stunRecovery'''
| Amount of [[Stun]] removed by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''energyRecovery'''
| Amount of [[Energy]] recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''tuUse'''
| Amount of [[Time Units]] required to use this item (for non-offensive items). It's a flat rate if '''flatRate''' is true, otherwise it's a percentage (0-100%).
| 0
|-
| '''recoveryPoints'''
| [[Score]] gained for recovering this alien artifact.
| 0
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''turretType'''
| Sprite ID from [[TANKS.PCK]] of the turret to assign to this tank:
* 0 - [[Tank/Cannon]]
* 1 - [[Tank/Rocket Launcher]]
* 2 - [[Tank/Laser Cannon]]
* 3 - [[Hovertank/Plasma]]
* 4 - [[Hovertank/Launcher]]
| -1
|-
| '''liveAlien'''
| Does this item represent a live alien? (counts towards [[Alien Containment]])
| false
|-
| '''blastRadius'''
| Size of the projectile explosions. 0 for no explosion. -1 to automatically calculate based on weapon power and damage type (actual '''blastRadius''' currently is capped due [[Explosions#Playing_With_Fire|Explosion calculations]]).
| -1
|-
| '''flatRate'''
| If true, then TU costs for this weapon are a flat rate (instead of a percentage of unit TUs).
| false
|-
| '''arcingShot'''
| Does this weapon fire in an arc?
| false
|-
| '''attraction'''
| Represents how likely an alien is to pick up this item. Values below 5 will be ignored (by design).
| 0
|-
| '''maxRange'''
| Maximum range at which this weapon can operate.
| 200
|-
| '''aimRange'''
| Maximum effective range with this weapon before which range-based dropoff occurs.
| 200
|-
| '''snapRange'''
| Maximum effective range with snap shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 15
|-
| '''autoRange'''
| Maximum effective range with auto shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 7
|-
| '''minRange'''
| Range-based dropoff will work in reverse for ranges below this.
| 0
|-
| '''dropoff'''
| The value by which the accuracy lowers for each tile after (or before) the thresholds above.
| 2
|-
| '''bulletSpeed'''
| How much faster (or slower, if you use a negative number) is a projectile fired from this weapon compared to the average.
| 0
|-
| '''autoShots'''
| How many auto shots does this weapon fire.
| 3
|-
| '''shotgunPellets'''
| Number of projectiles fired per unit of ammunition. (note: due to engine limitations it is currently impossible to draw multiple projectiles in flight.)
| 0
|-
| '''zombieUnit'''
| String ID of the unit used for zombification (eg. [[Chrysallid]]s turn units into [[Zombie]]s).
| none
|-
| '''meleeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon attacks a target with melee.
| 39
|-
| '''meleeHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon HITS a target with melee.
| -1
|-
| '''meleeAnimation'''
| Sprite ID from HIT.PCK played when this weapon attacks a target with melee.
| 0
|-
| '''meleePower'''
| Damage this weapon will do when using melee. This only applies to Firearms, and is only available as stun damage. For normal melee weapons, use regular power and damage types.
| 0
|-
| '''LOSRequired'''
| Does this item require line of sight? (only applies to mind probes and psi-amps)
| false
|-
| '''skillApplied'''
| Is melee skill applied to the accuracy of an attack made with this object?
| true
|-
|}

=== UFOs ===

Defines one of the [[UFOs]] that invade Earth, listed in ''"ufos:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the UFO name.
| ''required''
|-
| '''size'''
| String ID of the UFO size.
| STR_VERY_SMALL
|-
| '''sprite'''
| Sprite ID from [[INTERWIN.DAT]] used to draw this UFO in the dogfight view and UFOpaedia.
don't try to add more images if you don't want to punch yourself in the face - use modsprite
| -1
|-
| '''modSprite'''
| Filename used to draw this UFO in the dogfight view and UFOpaedia.
| -
|-
| '''damageMax'''
| Maximum amount of damage this UFO can take. If the UFO takes 50% damage, it crash lands. If it takes 100% damage, it is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''power'''
| Damage power of this UFO's weapon in dogfights.
| 0
|-
| '''range'''
| Maximum range of this UFO's weapon in dogfights (in meters).
| 0
|-
| '''score'''
| [[Score]] gained when this UFO is destroyed, or half this score if it crash lands.
| 0
|-
| '''reload'''
| Time the UFO's weapon takes to fire between each shot.
| 0
|-
| '''breakOffTime'''
| Minimum amount of time for the UFO to be able to break off of a dogfight.
| 0
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this UFO in Battlescape missions.
| ''required''
|-
|}

=== Inventory Sections ===

Defines one of the sections of the [[Inventory TU Table|Battlescape inventory]] (eg. Backpack), listed in ''"invs:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the inventory name.
| ''required''
|-
| '''x'''
'''y'''
| Pixel coordinates of this section on the inventory screen.
| 0
0
|-
| '''type'''
| Type of this section:
* 0 = Slot section, can contain as many items as will fit on the slots.
* 1 = Hand section, can only contain one item regardless of size.
* 2 = Ground section, can contain infinite items.
| 0
|-
| '''slots'''
| List of the grid slots (''[x, y]'') that this section is composed of. For example, to make a 2x2 section, you would have ''[0, 0] [0, 1] [1, 0] [1, 1]''.
| -
|-
| '''costs'''
| List of [[Time Units]] costs to move an item from this section to another one (eg. ''STR_BACKPACK: 16'' means it will cost 16 TUs to move an item from this section to the Backpack).
| -
|-
|}

=== Terrains ===

Defines one of the [[TERRAIN|terrains]] used to generate a Battlescape map, listed in "terrains:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the terrain name.
| ''required''
|-
| '''textures'''
| List of [[TEXTURE.DAT|Geoscape textures]] that correspond to this terrain.
| -
|-
| '''hemisphere'''
| Geoscape hemisphere associated with this terrain:
* -1 - Northern hemisphere.
* 0 - Both hemispheres.
* 1 - Southern hemisphere.
| 0
|-
| '''mapDataSets'''
| List of filenames (each with matching [[MCD]]/[[Image Formats#PCK|PCK/TAB]] files) that contain the tiles of this terrain.
| -
|-
| '''mapBlocks'''
| List of map blocks (see below) that are used for generating a map.
| -
|-
| '''civilianTypes'''
| List of units to use as civilians for this mission.
| [MALE_CIVILIAN, FEMALE_CIVILIAN]
|-
|}

==== Map Blocks ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| Filename of the [[MAPS|map]].
| ''required''
|-
| '''width'''
| Width of this map block in Battlescape grid units.
| 0
|-
| '''length'''
| Length of this map block in Battlescape grid units.
| 0
|-
| '''height'''
| Height of this map block in Battlescape grid units.
| 1
|-
| '''groups'''
| List (or single number) of groups this mapblock belongs to (used in mapscripts)
default usage:
* 0 - Default
* 1 - Landing Zone (for placing X-COM / alien craft) (used in addcraft/ufo command)
* 2 - E-W Road (for city maps) (used in addline command)
* 3 - N-S Road (for city maps) (used in addline command)
* 4 - Road Crossing (for city maps) (used in addline command)
| 0
|-
|'''revealedFloors'''
| Map block floor to be revealed from the very beginning; use a list "[0, 1, ..]" to reveal multiple floors
|-
| '''items'''
| An array of items to add to this mapblock, an the positions to place them at.
| -1
|}

* '''hemisphere''' only applies to UFO missions, not Terror ones.
*'''width/length''' defines the size of the map
** be aware that the mapview "width"-label is the openxcom ruleset length parameter
** be aware that the mapview "length"-label is the openxcom ruleset width parameter

==== Guidelines/Tips ====
* All maps with an XCOM/Alien craft require at least one map block assigned to Group 1. This map block can only contain ground tiles (no walls or objects), otherwise the game will crash or the walls/objects will be removed.
* All Terror terrains (listed under STR_TERROR_MISSION) require the Groups of '''Types''' 2, 3 and 4 (for a total of 3 maps, which are required to place roads).

=== Map Scripts ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| name of the script
| ''required''
|-
| '''commands'''
| List of MapCommands
| -
|}

==== Map Command ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Currently these commands are implemented:
* addBlock
* addLine
* addCraft
* addUFO
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
depending on the command type some of the following parameters are needed
| ''required''
|-
| '''label'''
| A numeric label that can be used for conditional execution of commands.
Each label should be unique within the command list (0=default no need for uniqueness).
| 0
|-
| '''conditionals'''
| Defines the conditions that allows the execution of this command.
eg. [1, -4] means it will be executed if command with label 1 was a success and command with label 4 failed.
commands that are not yet executed are always in failed state.
| 0
|-
| '''executionChances'''
| the chance that this command will be executed (or fails)
| 100
|-
| '''executions'''
| this command will be executed multiple times with a value > 1
| 1
|-
| '''groups'''
| Defines the what mapblock are used within this command. Can be list of goups or a single number.
| 0
|-
| '''blocks'''
| Alternative to groups. Here we define a list of mapblocks that are used within this command.
| 0
|-
| '''rects'''
| A list of possible ranges where (random) placement/checks/removal can happen in a map.
Is a list of a list of four integers.
| ?
|-
| '''size'''
| size of mapblocks that can be placed/checked/removed within rects. Also used for resize command type.
| ?
|-
| '''freqs'''
| For a list of mapblocks (defined by blocks?) we can define distribution frequency here.
| 1
|-
| '''maxUses'''
| For a list of mapblocks (defined by blocks?) we can define the maximal amount a mapblock can be used here.
| -1
|-
| '''direction'''
| used for addLine command type. Values are both, horizontal or vertical. Typically defines the road type distribution.
| -1
|-
| '''tunnelData'''
| Parameter for digTunnel command type. Contains level (default: 0) and a list of MCD replacement rules (MCDReplacements)
| 0
|}

==== Guidelines/Tips ====
* The Mapscript is still somewhat in development

=== Armor ===

Defines a Battlescape unit's [[armor]] as well as visual representation (so every unit has an armor), listed in ''"armors:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the armor name.
| ''required''
|-
| '''spriteSheet'''
| Sprite sheet from [[UNITS]] used to draw a unit wearing this armor.
| -
|-
| '''spriteInv'''
| Sprite used for the [[Inventory Backgrounds]] of a unit wearing this armor.
| -
|-
| '''spriteFaceGroup'''
| Pixel color group in [[PALETTES.DAT#Color Indexes|palette]] that will be replace in unit graphic by new color, range form 1-15 (its skip first group). Used by face recoloring based on nationality.
| ''example:'' 6
|-
| '''spriteFaceColor'''
| New colors index for face pixels. 8 values ordered by:
* Male Blond
* Female Blond
* Male Brown
* Female Brown
* Male Asian
* Female Asian
* Male African
* Female African
Other units use random position form table.
Value 0 mean original value.
| ''example:''
- 96
- 96
- 96
- 96
- 160
- 160
- 163
- 163
|-
| '''spriteHairGroup'''
| Pixel color group in [[PALETTES.DAT#Color Indexes|palette]] that will be replace in unit graphic by new color, range form 1-15 (its skip first group). Used by hair recoloring based on nationality.
| ''example:'' 9
|-
| '''spriteHairColor'''
| New colors index for hair pixels. 8 values ordered by:
* Male Blond
* Female Blond
* Male Brown
* Female Brown
* Male Asian
* Female Asian
* Male African
* Female African
Other units use random position form table.
Value 0 mean original value.
| ''example:''
- 144
- 144
- 164
- 164
- 245
- 245
- 166
- 166
|-
| '''spriteUtileGroup'''
| Pixel color group in [[PALETTES.DAT#Color Indexes|palette]] that will be replace in unit graphic by new color, range form 1-15 (its skip first group).
| -
|-
| '''spriteUtileColor'''
| New colors index for pixels. 8 values ordered by:
* Male Blond
* Female Blond
* Male Brown
* Female Brown
* Male Asian
* Female Asian
* Male African
* Female African
Other units use random position form table.
Value 0 mean original value.
| -
|-
| '''spriteRankGroup'''
| Pixel color group in [[PALETTES.DAT#Color Indexes|palette]] that will be replace in unit graphic by new color, range form 1-15 (its skip first group).
| -
|-
| '''spriteRankColor'''
| New colors index for pixels. For solders 6 values ordered by:
* STR_ROOKIE
* STR_SQUADDIE
* STR_SERGEANT
* STR_CAPTAIN
* STR_COLONEL
* STR_COMMANDER
For aliens 7 values ordered by (alien unit rank property):
* STR_LIVE_SOLDIER
* STR_LIVE_ENGINEER
* STR_LIVE_MEDIC
* STR_LIVE_NAVIGATOR
* STR_LIVE_LEADER
* STR_LIVE_COMMANDER
* STR_LIVE_TERRORIST
Civilians uses random position form 8 element table.
Value 0 mean original value.
| -
|-
| '''corpseBattle'''
| List of string IDs of the corpse [[#Items|items]] generated when a unit wearing this armor is killed (one per unit tile) on the Battlescape.
| -
|-
| '''corpseGeo'''
| String ID of the corpse [[#Items|item]] associated with this unit on the Geoscape.
| -
|-
| '''storeItem'''
| String ID of the [[#Items|item]] that represents this armor in [[Base Stores]] for equipping.
| -
|-
| '''weight'''
| Physical weight of the armor when worn
| 6
|-
| '''stats'''
| like soldier stats (see below) but these are treated as stat bonuses for wearing the specific armor.
| -
|-
| '''frontArmor'''
| Protection provided on the front of the unit.
| 0
|-
| '''sideArmor'''
| Protection provided on the sides of the unit.
| 0
|-
| '''rearArmor'''
| Protection provided on the rear of the unit.
| 0
|-
| '''underArmor'''
| Protection provided under the unit (eg. from explosions).
| 0
|-
| '''drawingRoutine'''
| Drawing routine used to put together the body parts in the unit's '''spriteSheet''':
* 0 = [[Soldier]], [[Sectoid]]
* 1 = [[Floater]]
* 2 = [[HWP]]
* 3 = [[Cyberdisk]]
* 4 = [[Civilian]], [[Ethereal]]
* 5 = [[Sectopod]], [[Reaper]]
* 6 = [[Snakeman]]
* 7 = [[Chryssalid]]
* 8 = [[Silacoid]]
* 9 = [[Celatid]]
* 10 = [[Muton]]
* 11 = [[Submersible Weapons Systems]]
* 12 = [[Hallucinoid]]
* 13 = [[Aquanauts]]
* 14 = [[Calcinite]], [[Deep One]], [[Gillman]], [[Lobster Man]], [[Tasoth]]
* 15 = [[Aquatoid]]
* 16 = [[Bio-Drone]]
* 17 = TFTD Civilians type A and [[Zombie_(TFTD)]]
* 18 = TFTD Civilians type B
* 19 = [[Tentaculat]]
* 20 = [[Triscene]]
* 21 = [[Xarquid]]
| 0
|-
| '''movementType'''
| Type of movement provided by this armor:
* 0 = Walking
* 1 = Flying
* 2 = Sliding (no walking animation)
it also defines the body of an tank (32-images) in your spriteSheet or the change in sprites while flying using a flying armour see: [[TANKS.PCK]], [[XCOM_2.PCK]]
| 0
|-
| '''damageModifier'''
| List of decimal damage modifiers (1.0 = 100%) this armor applies to each damage type (see [[#Items|Items section]]) received. Modifiers must be specified for all damage types, in this order:
* None
* Armor Piercing
* Incendiary
* High Explosive
* Laser
* Plasma
* Stun
* Melee
* Acid
* Smoke
|
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0
|-
| '''size'''
| Size of the unit wearing this armor, in Battlescape grid units. Every unit is square, so a size of 2 means 2x2.
| 1
|-
| '''loftempsSet'''
| List of [[LOFTEMPS]] IDs (one per unit tile, so a 1x1 unit has 1, a 2x2 unit has 4, etc.) used to represent a unit wearing this armor in 3D space.
| -
|-
| '''loftemps'''
| loftemps is a deprecated option that only works for 1x1 sized units.
| -
|-
| '''forcedTorso'''
| soldier sprites have female and male torsos. some armours reuse these sprites for flying/non flying torso without difference between genders. This can be controlled by the parameter: 0 = use genderrelated torso, 1 = use male torso, 2 = use female torso
| 0

|}

=== Player Units (Soldiers) ===

Defines a [[soldier]] recruited by X-COM, listed in ''"soldiers:"''. Currently only one soldier unit type (''XCOM'') is supported.

Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier name.
| ''required''
|-
| '''minStats'''
| Minimum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the initial stat (not generated).
| -
|-
| '''maxStats'''
| Maximum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the minimum value for the first month of psi training (actual value is 100%-150%).
| -
|-
| '''statCaps'''
| Maximum stats this soldier can gain through [[Experience]]. '''NOTE:''' A stat will still go over the limit once, and then will no longer increase (see [[Experience#Regarding Caps|Regarding Caps]]).
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this soldier uses by default.
| -
|-
| '''standHeight'''
| Height of this soldier when standing.
| 0
|-
| '''kneelHeight'''
| Height of this soldier when kneeling.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''femaleFrequency'''
| The probability that a female soldier is hired.
| 50
|}

=== AI Units (Aliens/Civilians) ===

Defines an [[Alien Life Forms|alien]] (enemy) or [[civilian]] (neutral) unit, listed in ''"units:"''. Every different alien rank is a different unit, since they have completely different stats. Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the unit name.
| ''required''
|-
| '''race'''
| String ID of the unit race (for alien units).
| -
|-
| '''rank'''
| String ID of the unit rank (for alien units).
| -
|-
| '''stats'''
| Battlescape stats of this unit.
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this unit uses by default.
| -
|-
| '''standHeight'''
| Height of this unit when standing.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''value'''
| [[Score]] this unit is worth.
| 0
|-
| '''deathSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit dies.
| -1
|-
| '''aggroSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit aggros.
| -1
|-
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit moves.
| -1
|-
| '''intelligence'''
| Intelligence of this unit's AI. The higher the value, the longer this unit remembers player troops between turns.
| 0
|-
| '''aggression'''
| Aggression of this unit's AI. The higher the value, the more ruthless the unit, the more likely to make a frontal assault. Less aggressive units tend to set up ambushes.
Vanilla values are:
* 0 = mostly passive
* 1 = balanced
* 2 = mostly aggresive
| 0
|-
| '''energyRecovery'''
| Energy recovered by the unit each turn (needs verification)
| 40 (?)
|-
| '''specab'''
| Special ability of this unit:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]] (Requires '''power''' and '''blastRadius''' properties to be set on the corpse)
* 2 = [[Silacoid|Burns Floor]]
* 3 = [[Bio-Drone|Burns Floor and explodes on Death]]
| 0
|-
| '''spawnUnit'''
| String ID of the unit used to respawn on death (eg. [[Zombie]]s respawn as [[Chrysallid]]s).
| -
|-
| '''livingWeapon'''
| Is this unit a living weapon? (only attacks with a '''fixedWeapon''')
| false
|-
| '''female'''
| Is this unit a female? (used for TFTD civilian types)
| false
|-
|}

=== Alien Races ===

Defines a [[Alien Life Forms|race]] used in [[Alien Missions]], listed in ''"alienRaces:"''. Heavily tied with deployment data.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the alien race name.
| ''required''
|-
| '''members'''
| Alien crew associated with this alien race (eg. race units + terrorist units), defined by a list of unit string IDs. Order here will define rank in terms of deployment. generally speaking the order is:
* 0 - Commander
* 1 - Leader
* 2 - Engineer
* 3 - Medic
* 4 - Navigator
* 5 - Soldier
* 6 - Terrorist 1
* 7 - Terrorist 2
but of course, not all races have all ranks, so the "fill in" rank would be listed multiple times (see ethereals).
| -
|-
| '''retaliation'''
| retaliation enables/disables the race for retaliation missions.
| ''True''
|-
|}

=== Alien Deployments ===

Defines a Battlescape deployment data used in [[Alien Missions]] (such as alien and map configurations), listed in ''"alienDeployments:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the deployment name.
| ''required''
|-
| '''width'''
| Width of the Battlescape map in grid units.
| 0
|-
| '''length'''
| Length of the Battlescape map in grid units.
| 0
|-
| '''height'''
| Vertical height of the Battlescape map in grid units.
| 0
|-
| '''terrains'''
| list of string IDs of the [[#Terrains|terrain]] to choose from to generate this map. This is not used for UFO sites where the terrain comes from the Geoscape.
| -
|-
| '''shade'''
| Shade of the map (0-15, where 0 is full daytime and 15 is full nighttime). This is not used for UFO sites where the shade comes from the Geoscape.
| 0
|-
| '''nextStage'''
| String ID of the next deployment stage to use after this one, for multi-stage missions.
| -
|-
| '''race'''
| Sets the race to use in the next stage.
| ""
|-
| '''script'''
| Reference to a mapScript.
| ""
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|}

Notes:
* '''terrains''' can also be used with UFOs, with the game using instead the listed terrain rather than the location of the UFO on Geoscape.
==== Deployment Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''alienRank'''
| [[Alien Rank|Rank]] associated with this deployment data, as defined by the order of the race in question (see above)
| ''required''
|-
| '''lowQty'''
| Minimum quantity of aliens to spawn on beginner/experienced.
| 0
|-
| '''highQty'''
| Minimum quantity of aliens to spawn on superhuman. (minimum quantity for veteran/genius is the median of this and the previous value)
| 0
|-
| '''dQty'''
| Delta in Quantity. ie: random number of aliens to spawn on top of the minimum (all difficulties).
| 0
|-
| '''extraQty'''
| functionally identical to dQty, spawns a random number of additional aliens.
| 0
|-
| '''percentageOutsideUfo'''
| Percentage (0-100%) of aliens to spawn outside in UFO sites.
| 0
|-
| '''itemSets'''
| Three lists (one for each alien technology level) of [[#Items|items]] (string IDs) for the aliens to equip.
| ''required''
|-
|}

=== Research ===

Defines a [[Research|research topic]] that X-COM scientists can investigate, listed in ''"research:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the research project's name (or item, if a '''lookup''' is defined).
| ''required''
|-
| '''lookup'''
| String ID of the research project's display name and UFOPaedia article reference.
| -
|-
| '''cost'''
| Number of man-days (on average, the final time will be 50-150% this value) required to complete this project.
| 0
|-
| '''points'''
| [[Score]] earned for completing this project.
| 0
|-
| '''needItem'''
| Does this project require an [[#Items|item]] of the same name?
| false
|-
| '''dependencies'''
| List of research projects that can unlock access to this one. If the full list is researched, or if one of the projects on the list "unlocks" this one, it becomes available.
| -
|-
| '''unlocks'''
| List of research projects unlocked, regardless of other dependencies, but not requirements, by completing this project (for example, any live alien unlocks "alien origins").
| -
|-
| '''requires'''
| List of research projects unilaterally required before this project can be unlocked (for example, "the martian solution" will not even be considered for unlocking until AFTER "alien origins" is completed).
| -
|-
| '''getOneFree'''
| List of "bonus" research projects that may be granted when completing this project (for example, alien medics will give you information on other alien races). Used in Alien Navigators (gives random alien Mission), Medics (random alien interrogation or autopsy) or Engineers (gives UFO type).
| -
|-
|}

=== Manufacture ===

Defines a [[Manufacture|manufacture project]] that X-COM engineers can produce, listed in ''"manufacture:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the manufacturing project's name (and the item it produces).
| ''required''
|-
| '''category'''
| String ID of the manufacturing project's category.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this project. If none are specified, this project is unlocked from the start.
| -
|-
| '''space'''
| Amount of [[Workshop]] space required to begin this project.
| 0
|-
| '''time'''
| Number of man hours (on average) required per item.
| 0
|-
| '''cost'''
| Monetary deduction per item manufactured.
| 0
|-
| '''requiredItems'''
| List of [[#Items|items]] required and consumed per item manufactured.
| -
|-
| '''producedItems'''
| List of [[#Items|items]] produced per each item consumed. If not specified, defaults to 1 item with the same string ID as the manufacture.
| 1
|-
|}

=== UFOpaedia Article ===

Defines an article in the in-game [[UFOpaedia]], listed in ''"ufopaedia:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the article name. This must match the ID of the object associated with this article, if applicable.
| ''required''
|-
| '''title'''
| String ID of the article title. If omitted, the '''id''' is used.
| -
|-
| '''type_id'''
| Type of this article:
* 0 = Unknown
* 1 = [[Craft]]
* 2 = [[Craft Armaments]]
* 3 = [[HWP]]
* 4 = [[Equipment (EU)|Equipment]]
* 5 = [[Armour]]
* 6 = [[Base Facilities]]
* 7 = Text & Image (eg. [[Alien Life Forms]], [[UFO Components]])
* 8 = Text (eg. [[Alien Research]])
* 9 = [[UFO]]
* 10 = [[TFTD]]
* 11 = TFTD [[Subs]]
* 12 = TFTD [[Sub_Armaments]]
* 13 = TFTD [[Submersible_Weapons_Systems]]
* 14 = TFTD [[Equipment_(TFTD)]]
* 15 = TFTD Armour
* 16 = TFTD [[Base_Facilities_(TFTD)]]
* 17 = TFTD [[Alien_Subs]]
| 0
|-
| '''section'''
| String ID of the UFOpaedia section this article belongs in.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this article. If none are specified, this article is unlocked from the start.
| -
|-
| '''image_id'''
| Filename of the [[UP001.SPK-UP042.SPK|background image]] displayed on this article, if applicable.
| -
|-
| '''text'''
| String ID of the description displayed on this article.
| -
|-
| '''text_width'''
| Maximum width of the text displayed, only applicable to ''Text & Image'' articles.
| 150
|-
| '''rect_stats'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the stats text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''rect_text'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the description text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''weapon'''
| String ID of the weapon, only applicable to ''HWP'' articles.
| -
|}

=== UFO Trajectories ===

Defines a trajectory carried out by an UFO during an [[#Alien Missions|alien mission]], listed in ''"ufoTrajectories:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the trajectory name.
| ''required''
|-
| '''groundTimer'''
| Amount of seconds for the UFO to spend on Ground waypoints.
| 0
|-
| '''waypoints'''
| List of waypoints for the UFO to traverse, defined as ''[zone, altitude, speed]''. 
'''zone''': Globe zone where the waypoint is located. 
'''altitude''': UFO altitude after reaching this waypoint:
* 0 - Ground
* 1 - Very Low
* 2 - Low
* 3 - High
* 4 - Very High
'''speed''': UFO speed after reaching this waypoint, as a percentage (0-100%) of its maximum speed.
| -
|}

=== Alien Missions ===

Defines an [[Alien Missions|alien mission]] carried out by UFOs on the Geoscape, listed in ''"alienMissions:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the mission type.
| ''required''
|-
| '''points'''
| [[Score]] allocated to aliens for successfully completing this mission.
| 0
|-
| '''raceWeights'''
| List of alien races likely to carry out this mission, and the % chance of them being allocated to this mission, listed by "number of months after game beginning".
| ''required''
|-
| '''waves'''
| List of UFO waves to spawn as this mission progresses, as described below.
| ''required''
|}

==== Waves ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''ufo'''
| String ID of the [[#UFOs|UFO]] to spawn.
| ''required''
|-
| '''count'''
| Number of UFOs to spawn.
| 0
|-
| '''trajectory'''
| String ID of the [[#UFO Trajectories|trajectory]] for this UFO to use when entering Earth's atmosphere.
| ''required''
|-
| '''timer'''
| How long after the previous wave should this wave arrive? (in seconds)
| 0
|-
|}

=== Alien Item Levels ===

This is a list of item level probabilities, with a number between 0 and 2 representing an item level from plasma pistols to heavy plasmas, as defined in the deployments, expressing a 10% probability for that item level being used.

0 = first set (plasma pistol/clip)
1 = second set (plasma rifle/clip)
2 = third set (heavy plasma/clip)

For example:
[ 2, 0, 0, 0, 0, 0, 0, 1, 1, 1 ]
would represent a 60% chance for pistols, 30% rifles, and 10% heavy weapons. 
Note that the order does not matter, but the length DOES. each line MUST have 10 digits.

The above can be confusing. There are 10 fields; each number represents 10%. 
There are six instances of '0'. 6x10% = 60% chance of plasma pistol 
There are three instances of '1'. 3x10% = 30% chance of plasma rifle 
There is only one instance of '2'. 1x10% = 10% chance of heavy plasma 

Each line represents a month after the beginning of the game, and there is no limit to the number defined. 
OpenXCom will use the most recently available item level in the event the game goes on forever.

=== Extra Sprites ===

Adds or replaces sprites in an existing [[Image Formats|X-COM image file]], listed in ''"extraSprites:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original/new image to modify.
| ''required''
|-
| '''width'''
'''height'''
| Size of the sprite(s) in pixels.
| 0
0
|-
| '''singleImage'''
| Is the image file just a single sprite (true) or a spritesheet (false)?
| false
|-
| '''subX'''
'''subY'''
| Size of the subdivision in pixels. If a subdivision is specified, then the image file is divided into chunks to form the sprites (eg. spritesheets).
| 0
0
|-
| '''files'''
| List of the new sprites to add/replace, listed as ''spriteID: filename''.
| -
|}

Example:
- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/Bunny00.png
1: Resources/Bunny/Bunny01.bmp
2: Resources/Bunny/Bunny02.gif

=== Extra Sounds ===

Adds or replaces sounds in an existing [[SOUND|X-COM sound file]], listed in ''"extraSounds:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ID of the original sound file to modify:
* BATTLE.CAT - Battlescape sounds, corresponds to ''SOUND1.CAT'' or ''SAMPLE2.CAT'' (55 sounds).
* INTRO.CAT - Intro sounds, corresponds to ''INTRO.CAT'' or ''SAMPLE3.CAT'', probably best not to mess with these.
* GEO.CAT - Geoscape sounds, corresponds to ''SOUND2.CAT'' or ''SAMPLE.CAT'' (14 sounds).
| ''required''
|-
| '''files'''
| List of the new sounds to add/replace, listed as ''soundID: filename''.
| -
|}

Example:
- type: BATTLE.CAT
files:
55: Resources/Sounds/sample.wav

=== Music ===

Custom music options can be defined in the Music.rul file. More details [[Audio Options (OpenXcom)#Custom Music|here]].

=== Extra Strings ===

Adds or replaces text strings in an existing [[Translations (OpenXcom)|OpenXcom language file]], listed in ''"extraStrings:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original language file to modify, sans extension.
| ''required''
|-
| '''strings'''
| List of the new strings to add/replace, listed as ''stringID: text''.
| -
|}

Example:
- type: en-US
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: en-GB
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: de
strings:
STR_SNIPER_RIFLE: Scharfschützengewehr
STR_SNIPER_RIFLE_CLIP: Scharfschützengewehrmunition
- type: ru
strings:
STR_SNIPER_RIFLE: Снайперская винтовка
STR_SNIPER_RIFLE_CLIP: Магазин к снайп. винтовке

=== Interfaces ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ''?''
| -
|-
| '''elements'''
| ''?''
| -
|-
| '''id'''
| ''?''
| -
|-
| '''color'''
| ''?''
| -
|}

=== StatStrings ===

[[Statstrings]] are used for automatically renaming soldiers. They are case sensitive and they are processed in the order in which they are specified.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''string'''
| String to add to name.
| ''required''
|-
| '''psiStrength''' 
'''psiSkill''' 
'''bravery''' 
'''strength''' 
'''firing''' 
'''reactions''' 
'''stamina''' 
'''tu''' 
'''health''' 
'''throwing'''
| One or more stat ranges are ANDed together for success. Each range has a minVal and maxVal. Use YAML standard tilde (~) to indicate null. ((~) = 0 as minvalue; (~) =255 as maxvalue)
| -
|}

Example:
statStrings:
- string: "x"
psiStrength: [~, 30]
- string: "P"
psiStrength: [80, ~]
- string: "p"
psiStrength: [60, 79]
- string: "K"
psiSkill: [60, ~]
- string: "k"
psiSkill: [30, 59]
- string: "b"
bravery: [60, ~]
- string: "c"
bravery: [~, 10]
- string: "w"
strength: [~, 25]
- string: "Snpr"
firing: [60, ~]
reactions: [60, ~]
- string: "M"
firing: [70, ~]
- string: "m"
firing: [60, 69]
- string: "Sct"
reactions: [50, ~]
tu: [60, ~]
- string: "R"
reactions: [60, ~]
- string: "r"
reactions: [50, 59]

==References==
<references />

[[Category:OpenXcom]]

Ruleset Reference (OpenXcom)

2015-02-06T12:00:07Z

Kkmic: /* AI Units (Aliens/Civilians) */ Added specab 1 requirements

A reference of all the customizable values of everything in a [[Rulesets (OpenXcom)|ruleset]] for the current stable version (1.0) of OpenXcom. For the current nightly versions (with the advanced features currently in development) check [[Ruleset Reference Nightly (OpenXcom)|Ruleset Reference Nightly]].

Some guidelines:
* If a value is omitted from the ruleset, the default is used. You cannot omit ''required'' values.
* Text strings (eg. names) are represented by string IDs from the [[Translations (OpenXcom)|language files]]
* Numerical IDs (used for sprites, sounds, etc.) start at 0, not 1.
* Boolean (yes/no) values are represented by true/false.
* World coordinates are represented in degrees (see [[WORLD.DAT]]).
* Money amounts (prices, costs, etc.) are represented in dollars.
* All paths are '''case sensitive'''! If your ruleset uses external files, make sure that they named properly as described in ruleset.

Items are ordered as they come in the ruleset. To override this, you can specify a ''listOrder''. You can find the default listOrders in [[Ruleset List Order (OpenXcom)|Ruleset List Order]].

=== Countries ===

Defines one of the [[Country Funding (EU)|funding nations]], listed in ''"countries:"''. They're used for activity graphs and player scoring.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the country name.
| ''required''
|-
| '''fundingBase'''
| Country's base funding, in thousands. The starting funding can be anywhere between 1x and 2x the base funding.
| 0
|-
| '''fundingCap'''
| Country's funding cap, in thousands. Once a country reaches this maximum, it will no longer increase its funding.
| 0
|-
| '''labelLon'''
'''labelLat'''
| Longitude and latitude coordinates of the country's label on the globe. This label is only shown when the globe is zoomed in and "detail" is turned on.
| 0.0
0.0
|-
| '''areas'''
| List of "rectangles" on the globe defined as [''lon1'' ''lat1'' ''lon2'' ''lat2'']. Any activity within these areas counts towards the country's graph activity and affects their opinion of the player.
| -
|}

=== Regions ===

Defines one of the [[Geoscape (EU)#World Regions/Countries|world regions]], listed in ''"regions:"''. They're used for base placement, activity graphs and mission spawning.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the region name.
| ''required''
|-
| '''cost'''
| Amount of money spent building an X-COM base in this region (first base is free).
| 0
|-
| '''areas'''
| List of "rectangles" on the globe defined as ''[lon1, lat1, lon2, lat2]''. Any activity within these areas counts towards the region's graph activity.
| -
|-
| '''cities'''
| List of cities belonging to this region. They will be displayed on the globe and used for terror site missions. Each city is defined by their '''lon''' and '''lat''' coordinates and a '''name''' string ID.
| -
|-
| '''regionWeight'''
| Weight of this region when selecting regions for alien missions.
| 0
|-
| '''missionWeights'''
| Weighted list of the different mission types for this region (eg. ''STR_ALIEN_RESEARCH: 14'').
| -
|-
| '''missionZones'''
| List of "rectangles" (''[lon1, lat1, lon2, lat2]'') defining the mission zones for this region. Mission zones are waypoints for UFO trajectories.
| -
|-
| '''missionRegion'''
| Spawn mission in this region instead (used for regions without land).
| -
|}

=== Base Facilities ===

Defines one of the [[Base Facilities (EU)|facilities]] that can be built in an X-COM base, listed in ''"facilities:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the facility name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this facility. If none are specified, this facility is unlocked from the start.
| -
|-
| '''spriteShape'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's outer shape in the Basescape and UFOpaedia.
| -1
|-
| '''spriteFacility'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's contents in the Basescape and UFOpaedia. Drawn on top of '''spriteShape'''.
| -1
|-
| '''lift'''
| Is this facility an [[Access Lift]]? All base facilities must be connected to the lift.
| false
|-
| '''hyper'''
| Is this facility a [[Hyperwave Decoder]]? Displays extra information for detected UFOs. Only valid for radar facilities.
| false
|-
| '''mind'''
| Is this facility a [[Mind Shield]]? Reduces the chance of UFOs finding your base. Does not stack.
| false
|-
| '''grav'''
| Is this facility a [[Grav Shield]]? Doubles the power of your base defenses. Does not stack.
| false
|-
| '''size'''
| Size of the facility, in grid units. Every facility is square, so a size of 1 means 1x1, 2 means 2x2, etc. Bigger facilities are made up of multiple sprites, for example a 2x2 facility will use 4 sprites for '''spriteShape''' and 4 sprites for '''spriteFacility''' (top-left, top-right, bottom-left, bottom-right).
| 1
|-
| '''buildCost'''
| Amount of money spent to build this facility in the base.
| 0
|-
| '''buildTime'''
| Amount of days it takes for this facility to be built.
| 0
|-
| '''monthlyCost'''
| Amount of money spent monthly for the maintenance of this facility.
| 0
|-
| '''storage'''
| Amount of storage space (for items) this facility provides. See [[Base Stores]].
| 0
|-
| '''personnel'''
| Amount of personnel (soldiers, scientsts, engineers) these quarters can contain.
| 0
|-
| '''aliens'''
| Amount of live aliens this facility can contain. Only checked if the ''alienContainmentLimitEnforced'' option is enabled.
| 0
|-
| '''crafts'''
| Amount of X-COM craft this facility can contain.
| 0
|-
| '''labs'''
| Amount of lab space this facility provides for research projects.
| 0
|-
| '''workshops'''
| Amount of workshop space this facility provides for manufacture projects.
| 0
|-
| '''psiLabs'''
| Amount of soldier space this facility provides for psionic training.
| 0
|-
| '''radarRange'''
| Maximum radar detection range of this facility, in nautical miles.
| 0
|-
| '''radarChance'''
| Chance (0-100%) of this radar detecting a UFO that enters its range.
| 0
|-
| '''defense'''
| Offensive power provided by this base defense against attacking UFOs.
| 0
|-
| '''hitRatio'''
| Chance (0-100) of the base defense hitting an attacking UFO.
| 0
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense hits a target.
| -1
|-
| '''mapName'''
| [[MAPS|Map]] associated to this facility in Battlescape base defenses.
| -
|-
|}

=== Crafts ===

Defines one of the [[Craft|X-COM crafts]] that go on interception missions, listed in ''"crafts:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the craft name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this craft. If none are specified, this craft is unlocked from the start.
| -
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw this craft in the Basescape and from [[INTICON.PCK]] used to draw the damage indicator in dogfights.
modders: the corresponding extrasprite file id for BASEBITS.PCK is sprite+33 INTICON.PCK contains a minimized icon id=sprite the file id for the dogfight image is sprite+11
| -1
|-
| '''fuelMax'''
| Maximum amount of fuel this craft can carry. Crafts use up fuel based on their speed while travelling.
| 0
|-
| '''damageMax'''
| Maximum amount of damage this craft can take. If this amount is exceeded, the craft is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles. Crafts travel at max speed when flying and half speed when patrolling.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''weapons'''
| Amount of craft weapons this craft can equip. The UI can only display a max of 2 weapons.
| 0
|-
| '''soldiers'''
| Amount of soldiers this craft can carry.
| 0
|-
| '''maxItems'''
| Amount of items this craft can carry.
| 80
|-
| '''vehicles'''
| Amount of vehicles this craft can carry.
| 0
|-
| '''costBuy'''
| Amount of money spent for purchasing this craft. If set to 0, the craft will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costRent'''
| Amount of money spent monthly for renting this craft. If set to 0, the craft is not on rental and won't count towards base maintenance.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this craft.
| 0
|-
| '''refuelItem'''
| Item required for refuelling this craft. If no item is specified, the craft uses human fuel.
| 0
|-
| '''repairRate'''
| Amount of damage restored every hour while [[Repairs|Repairing]] in base.
| 1
|-
| '''refuelRate'''
| Amount of fuel restored every 30 mins while [[Refueling]] in base. If specified, a '''refuelItem''' is spent each time.
| 1
|-
| '''radarRange'''
| Detection range of the craft's radar in nautical miles. Every craft radar has a 100% detection chance.
| 600
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this craft to a base.
| 0
|-
| '''score'''
| [[Score]] lost when this craft is destroyed.
| 0
|-
| '''spacecraft'''
| Can this craft go to [[Cydonia]]?
| false
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this craft in Battlescape missions.
| -
|-
| '''deployment'''
| Custom positions for the unit deployment in the craft, listed as: ''[x, y, z, facing]''
If not specified, units are placed on empty spots from top-left to bottom-right facing top-right.
| -
|}

=== Craft Weapons ===

Defines one of the [[Craft Armaments|weapons]] equipped by X-COM craft for shooting down UFOs, listed in ''"craftWeapons:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the weapon name.
| ''required''
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the weapon in the Basescape and from [[INTICON.PCK]] used to draw the weapon in dogfights.
modders: the corresponding extrasprites file id for INTICON.PCK is sprite+5 and sprite+48 for BASEBITS.PCK
| -1
|-
| '''sound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when this weapon fires.
| -1
|-
| '''damage'''
| Amount of damage this weapon does to enemy UFOs.
| 0
|-
| '''range'''
| Maximum range of this weapon in dogfights (in meters).
| 0
|-
| '''accuracy'''
| Chance (0-100%) of each shot hitting the enemy UFO.
| 0
|-
| '''reloadCautious'''
| Time this weapon takes to fire between each shot in ''Cautious Mode''.
| 0
|-
| '''reloadStandard'''
| Time this weapon takes to fire between each shot in ''Standard Mode''.
| 0
|-
| '''reloadAggressive'''
| Time this weapon takes to fire between each shot in ''Aggressive Mode''.
| 0
|-
| '''ammoMax'''
| Maximum amount of ammo this weapon can carry.
| 0
|-
| '''rearmRate'''
| Amount of ammo restored every 30 mins while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize'''. If the '''clipSize''' of the specified ammo is 0, no '''clip'''s are spent.
| 1
|-
| '''projectileType'''
| Type of the weapon projectile, used for the projectile sprite in dogfights:
* 0 - [[Stingray]]
* 1 - [[Avalanche]]
* 2 - [[Cannon]]
* 3 - [[Fusion Ball]]
* 4 - [[Laser Cannon]]
* 5 - [[Plasma Beam]]
| 2
|-
| '''projectileSpeed'''
| Speed of the weapon projectile in dogfights.
| 0
|-
| '''launcher'''
| String ID of the [[#Items|item]] required to equip this weapon.
| -
|-
| '''clip'''
| String ID of the [[#Items|item]] required to rearm this weapon.
| -
|}

=== Items ===

Defines the Geoscape and Battlescape properties of an [[Equipment (EU)|item]] that can be stored in X-COM bases, listed in ''"items:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the internal item name.
| ''required''
|-
| '''name'''
| String ID of the displayed item name, for cases where it's different from the internal name. If omitted, '''type''' is used.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this item. If none are specified, this item is unlocked from the start. Soldiers can only use unlocked items in the Battlescape.
| -
|-
| '''size'''
| Space occupied by this item in [[Base Stores]]. Can be a decimal value.
| 0.0
|-
| '''costBuy'''
| Amount of money spent for purchasing this item. If set to 0, this item will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this item.
| 0
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this item to a base.
| 24
|-
| '''weight'''
| [[Item_Weight|Weight]] occupied by this item in a soldier's inventory.
| 999
|-
| '''bigSprite'''
| Sprite ID from [[BIGOBS.PCK]] used to draw this item in a soldier's inventory and UFOpaedia.
| -1
|-
| '''floorSprite'''
| Sprite ID from [[FLOOROB.PCK]] used to draw this item on the floor of a Battlescape tile.
| -1
|-
| '''handSprite'''
| Sprite ID from [[HANDOB.PCK]] used to draw this item on a soldier's hand in the Battlescape.
modders: each handobject needs 8 images (8 directions) define the extrasprites accordingly
| 120
|-
| '''bulletSprite'''
| Sprite ID from ''BulletSprites.png'' used to draw this weapon's projectile on the Battlescape:
* 0 - [[Rocket Launcher]]
* 1 - [[Pistol]]
* 2 - [[Rifle]]
* 3 - [[Auto Cannon]]
* 4 - [[Heavy Cannon]]
* 5 - [[Laser Pistol]]
* 6 - [[Laser Rifle]]
* 7 - [[Heavy Laser]]
* 8 - [[Plasma Rifle|Plasma]]
* 9 - [[Small Launcher]]
* 10 - [[Blaster Launcher]]
for modders: the bulletsprite needs to be put into the extraSprites type "Projectiles" the bulletsprite can contain up to 35 3x3 images. The corresponding file id is 35*[bulletSprite]
| -1
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target.
| -1
|-
| '''hitAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "hit explosion".
'''NOTE''': Do not define this value for melee/psi weapons, they use [[HIT.PCK]] and therefore meleeAnimation instead.
| 0
|-
| '''power'''
| Average damage of the weapon, in most cases it will be +-50% this value.
| 0
|-
| '''strengthApplied'''
| Add the attacking unit's strength to this weapon's damage.
| false
|-
| '''compatibleAmmo'''
| List of string IDs of the ammo items that can be loaded on this weapon. If none are specified, the weapon doesn't need ammo.
| -
|-
| '''damageType'''
| What type of [[damage]] does this weapon do:
* 0 - None
* 1 - Armor Piercing
* 2 - Incendiary
* 3 - High Explosive
* 4 - Laser
* 5 - Plasma
* 6 - Stun
* 7 - Melee
* 8 - Acid
* 9 - Smoke
'''NOTE:''' A damage type other than 0-9 will do nothing.
| 0
|-
| '''tuAuto'''
'''accuracyAuto'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Auto Shot. If 0, the weapon does not have an Auto Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Auto Shot.
| 0
0
|-
| '''tuSnap'''
'''accuracySnap'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire a Snap Shot. If 0, the weapon does not have a Snap Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing a Snap Shot.
| 0
0
|-
| '''tuAimed'''
'''accuracyAimed'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Aimed Shot. If 0, the weapon does not have an Aimed Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Aimed Shot.
| 0
0
|-
|-
| '''tuMelee'''
'''accuracyMelee'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to do a melee attack (Hit). If 0, the weapon does not have a melee attack.
The base accuracy (0-100%) applied to a soldier's [[Melee Accuracy]] when doing a melee attack.
| 0
0
|-
| '''clipSize'''
| The amount of ammo stored in each weapon clip. If -1 is specified, this weapon has infinite ammo.
| 0
|-
| '''battleType'''
| Defines the weapon's behavior in the Battlescape:
* 0 - None (Geoscape-only item)
* 1 - [[Weapons|Firearm]]
* 2 - Ammo
* 3 - Melee
* 4 - [[Grenade]]
* 5 - [[Proximity Grenade]]
* 6 - [[Medi-Kit (EU)|Medi-Kit]]
* 7 - [[Motion Scanner]]
* 8 - [[Mind Probe]]
* 9 - [[Psi-Amp]]
* 10 - [[Electro-flare]]
* 11 - Corpse
| 0
|-
| '''twoHanded'''
| Is this weapon two-handed? If true, incurs an accuracy penalty if used with both hands occupied. Note that the handsprite of a twoHanded item is also drawn at a slightly different position than a one handed item.
| false
|-
| '''waypoint'''
| Does this weapon use waypoints? (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system.
| false
|-
| '''fixedWeapon'''
| Is this weapon fixed? (it's part of a unit, eg. tanks and terrorist units)
| false
|-
| '''invWidth'''
| Item width in a soldier's inventory (in grid units).
| 1
|-
| '''invHeight'''
| Item height in a soldier's inventory (in grid units).
| 1
|-
| '''painKiller'''
| Amount of painkillers contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''heal'''
| Amount of heal's contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stimulant'''
| Amount of stimulants contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''woundRecovery'''
| Amount of [[Fatal Wounds]] treated by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''healthRecovery'''
| Amount of [[Health]] recovered by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stunRecovery'''
| Amount of [[Stun]] removed by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''energyRecovery'''
| Amount of [[Energy]] recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''tuUse'''
| Amount of [[Time Units]] required to use this item (for non-offensive items). It's a flat rate if '''flatRate''' is true, otherwise it's a percentage (0-100%).
| 0
|-
| '''recoveryPoints'''
| [[Score]] gained for recovering this alien artifact.
| 0
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''turretType'''
| Sprite ID from [[TANKS.PCK]] of the turret to assign to this tank:
* 0 - [[Tank/Cannon]]
* 1 - [[Tank/Rocket Launcher]]
* 2 - [[Tank/Laser Cannon]]
* 3 - [[Hovertank/Plasma]]
* 4 - [[Hovertank/Launcher]]
| -1
|-
| '''liveAlien'''
| Does this item represent a live alien? (counts towards [[Alien Containment]])
| false
|-
| '''blastRadius'''
| Size of the projectile explosions. 0 for no explosion. -1 to automatically calculate based on weapon power and damage type (actual '''blastRadius''' currently is capped due [[Explosions#Playing_With_Fire|Explosion calculations]]).
| -1
|-
| '''flatRate'''
| If true, then TU costs for this weapon are a flat rate (instead of a percentage of unit TUs).
| false
|-
| '''arcingShot'''
| Does this weapon fire in an arc?
| false
|-
| '''attraction'''
| Represents how likely an alien is to pick up this item. Values below 5 will be ignored (by design).
| 0
|-
| '''maxRange'''
| Maximum range at which this weapon can operate.
| 200
|-
| '''aimRange'''
| Maximum effective range with this weapon before which range-based dropoff occurs.
| 200
|-
| '''snapRange'''
| Maximum effective range with snap shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 15
|-
| '''autoRange'''
| Maximum effective range with auto shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 7
|-
| '''minRange'''
| Range-based dropoff will work in reverse for ranges below this.
| 0
|-
| '''dropoff'''
| The value by which the accuracy lowers for each tile after (or before) the thresholds above.
| 2
|-
| '''bulletSpeed'''
| How much faster (or slower, if you use a negative number) is a projectile fired from this weapon compared to the average.
| 0
|-
| '''autoShots'''
| How many auto shots does this weapon fire.
| 3
|-
| '''shotgunPellets'''
| Number of projectiles fired per unit of ammunition. (note: due to engine limitations it is currently impossible to draw multiple projectiles in flight.)
| 0
|-
| '''zombieUnit'''
| String ID of the unit used for zombification (eg. [[Chrysallid]]s turn units into [[Zombie]]s).
| none
|-
| '''meleeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon attacks a target with melee.
| 39
|-
| '''meleeHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon HITS a target with melee.
| -1
|-
| '''meleeAnimation'''
| Sprite ID from HIT.PCK played when this weapon attacks a target with melee.
| 0
|-
| '''meleePower'''
| Damage this weapon will do when using melee. This only applies to Firearms, and is only available as stun damage. For normal melee weapons, use regular power and damage types.
| 0
|-
| '''LOSRequired'''
| Does this item require line of sight? (only applies to mind probes and psi-amps)
| false
|-
| '''skillApplied'''
| Is melee skill applied to the accuracy of an attack made with this object?
| true
|-
|}

=== UFOs ===

Defines one of the [[UFOs]] that invade Earth, listed in ''"ufos:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the UFO name.
| ''required''
|-
| '''size'''
| String ID of the UFO size.
| STR_VERY_SMALL
|-
| '''sprite'''
| Sprite ID from [[INTERWIN.DAT]] used to draw this UFO in the dogfight view and UFOpaedia.
don't try to add more images if you don't want to punch yourself in the face - use modsprite
| -1
|-
| '''modSprite'''
| Filename used to draw this UFO in the dogfight view and UFOpaedia.
| -
|-
| '''damageMax'''
| Maximum amount of damage this UFO can take. If the UFO takes 50% damage, it crash lands. If it takes 100% damage, it is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''power'''
| Damage power of this UFO's weapon in dogfights.
| 0
|-
| '''range'''
| Maximum range of this UFO's weapon in dogfights (in meters).
| 0
|-
| '''score'''
| [[Score]] gained when this UFO is destroyed, or half this score if it crash lands.
| 0
|-
| '''reload'''
| Time the UFO's weapon takes to fire between each shot.
| 0
|-
| '''breakOffTime'''
| Minimum amount of time for the UFO to be able to break off of a dogfight.
| 0
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this UFO in Battlescape missions.
| ''required''
|-
|}

=== Inventory Sections ===

Defines one of the sections of the [[Inventory TU Table|Battlescape inventory]] (eg. Backpack), listed in ''"invs:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the inventory name.
| ''required''
|-
| '''x'''
'''y'''
| Pixel coordinates of this section on the inventory screen.
| 0
0
|-
| '''type'''
| Type of this section:
* 0 = Slot section, can contain as many items as will fit on the slots.
* 1 = Hand section, can only contain one item regardless of size.
* 2 = Ground section, can contain infinite items.
| 0
|-
| '''slots'''
| List of the grid slots (''[x, y]'') that this section is composed of. For example, to make a 2x2 section, you would have ''[0, 0] [0, 1] [1, 0] [1, 1]''.
| -
|-
| '''costs'''
| List of [[Time Units]] costs to move an item from this section to another one (eg. ''STR_BACKPACK: 16'' means it will cost 16 TUs to move an item from this section to the Backpack).
| -
|-
|}

=== Terrains ===

Defines one of the [[TERRAIN|terrains]] used to generate a Battlescape map, listed in "terrains:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the terrain name.
| ''required''
|-
| '''largeBlockLimit'''
| Maximum amount of large blocks that can be used on map generation.
| 0
|-
| '''textures'''
| List of [[TEXTURE.DAT|Geoscape textures]] that correspond to this terrain.
| -
|-
| '''hemisphere'''
| Geoscape hemisphere associated with this terrain:
* -1 - Northern hemisphere.
* 0 - Both hemispheres.
* 1 - Southern hemisphere.
| 0
|-
| '''mapDataSets'''
| List of filenames (each with matching [[MCD]]/[[Image Formats#PCK|PCK/TAB]] files) that contain the tiles of this terrain.
| -
|-
| '''mapBlocks'''
| List of map blocks (see below) that are used for generating a map.
| -
|-
| '''roadTypeOdds'''
| Odds as a % of generating each type of road (E-W Road, N-S Road, Crossing) odds for crossing are: 100 - EW - NS.
| [0 0]
|-|-
| '''civilianTypes'''
| List of units to use as civilians for this mission.
| [MALE_CIVILIAN, FEMALE_CIVILIAN]
|-
|}

==== Map Blocks ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| Filename of the [[MAPS|map]].
| ''required''
|-
| '''width'''
| Width of this map block in Battlescape grid units.
| 0
|-
| '''length'''
| Length of this map block in Battlescape grid units.
| 0
|-
| '''height'''
| Height of this map block in Battlescape grid units.
| 1
|-
| '''type'''
| Type of this map block:
* -1 - Undefined
* 0 - Default
* 1 - Landing Zone (for placing X-COM / alien craft)
* 2 - E-W Road (for city maps)
* 3 - N-S Road (for city maps)
* 4 - Road Crossing (for city maps)
* 5 - Dirt (for filling empty base blocks)
* 6 - X-COM spawn point (for [[Alien Base]] / [[Cydonia]] missions)
* 7 - [[Alien Base]] Target
* 8 - [[Cydonia]] Target
| -1
|-
| '''subType'''
| Sub-type of this map block (see '''type''').
| -1
|-
| '''frequency'''
| Frequency of this block in a map.
| 1
|-
| '''maxCount'''
| Maximum amount of times this block can be used in a map. If -1 there is no limit.
| -1
|}

*'''frequency''' defines the odds of the map appearing on the map
** The value assigned (default: 1) is used in ''x/n'', which defines the probability of being chosen.
** ''x'' is the integer defined for the map block's frequency and ''n'' is the combined total of probabilities for all the map types combined.
** This property can only be used in type 0 map blocks.
*'''maxCount''' is the maximum number of times it can be used.
** The value assigned is also used in ''x/n'' to determine the probability of being chosen.
** Each use reduces ''x'' by -1, with the caveat that being used as a Landing Zone type will not reduce the x value since it could result in no available Landing Zones.
** This property can only be used in type 0 map blocks.
* '''hemisphere''' only applies to UFO missions, not Terror ones.
*'''width/length''' defines the size of the map
** be aware that the mapview "width"-label is the openxcom ruleset length parameter
** be aware that the mapview "length"-label is the openxcom ruleset width parameter

==== Guidelines/Tips ====
* All maps with an XCOM/Alien craft require at least one type 1 map block. This map block can only contain ground tiles (no walls or objects), otherwise the game will crash or the walls/objects will be removed.
* All Terror terrains (listed under STR_TERROR_MISSION) require at least 1 map block of '''Types''' 2, 3 and 4 (for a total of 3 maps, which are required to place roads) and the corresponding '''roadTypeOdds''' added to the ruleset.
* If there isn't any map blocks designed as roads since you want to keep your terrain 'random', this can be circumvented by designating all 10x10 map blocks, excluding the one(s) used for the XCOM craft, as either '''Type''' 2, 3 and 4 and by defining their '''subType''' to 0. The game will then randomly choose between the map blocks for each type used in the roads, making them map more random.

=== Armor ===

Defines a Battlescape unit's [[armor]] as well as visual representation (so every unit has an armor), listed in ''"armors:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the armor name.
| ''required''
|-
| '''spriteSheet'''
| Sprite sheet from [[UNITS]] used to draw a unit wearing this armor.
| -
|-
| '''spriteInv'''
| Sprite used for the [[Inventory Backgrounds]] of a unit wearing this armor.
| -
|-
| '''corpseBattle'''
| List of string IDs of the corpse [[#Items|items]] generated when a unit wearing this armor is killed (one per unit tile) on the Battlescape.
| -
|-
| '''corpseGeo'''
| String ID of the corpse [[#Items|item]] associated with this unit on the Geoscape.
| -
|-
| '''storeItem'''
| String ID of the [[#Items|item]] that represents this armor in [[Base Stores]] for equipping.
| -
|-
| '''weight'''
| Physical weight of the armor when worn
| 6
|-
| '''stats'''
| like soldier stats (see below) but these are treated as stat bonuses for wearing the specific armor.
| -
|-
| '''frontArmor'''
| Protection provided on the front of the unit.
| 0
|-
| '''sideArmor'''
| Protection provided on the sides of the unit.
| 0
|-
| '''rearArmor'''
| Protection provided on the rear of the unit.
| 0
|-
| '''underArmor'''
| Protection provided under the unit (eg. from explosions).
| 0
|-
| '''drawingRoutine'''
| Drawing routine used to put together the body parts in the unit's '''spriteSheet''':
* 0 = [[Soldier]], [[Sectoid]]
* 1 = [[Floater]]
* 2 = [[HWP]]
* 3 = [[Cyberdisk]]
* 4 = [[Civilian]], [[Ethereal]]
* 5 = [[Sectopod]], [[Reaper]]
* 6 = [[Snakeman]]
* 7 = [[Chryssalid]]
* 8 = [[Silacoid]]
* 9 = [[Celatid]]
* 10 = [[Muton]]
| 0
|-
| '''movementType'''
| Type of movement provided by this armor:
* 0 = Walking
* 1 = Flying
* 2 = Sliding (no walking animation)
it also defines the body of an tank (32-images) in your spriteSheet or the change in sprites while flying using a flying armour see: [[TANKS.PCK]], [[XCOM_2.PCK]]
| 0
|-
| '''damageModifier'''
| List of decimal damage modifiers (1.0 = 100%) this armor applies to each damage type (see [[#Items|Items section]]) received. Modifiers must be specified for all damage types, in this order:
* None
* Armor Piercing
* Incendiary
* High Explosive
* Laser
* Plasma
* Stun
* Melee
* Acid
* Smoke
|
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0
|-
| '''size'''
| Size of the unit wearing this armor, in Battlescape grid units. Every unit is square, so a size of 2 means 2x2.
| 1
|-
| '''loftempsSet'''
| List of [[LOFTEMPS]] IDs (one per unit tile, so a 1x1 unit has 1, a 2x2 unit has 4, etc.) used to represent a unit wearing this armor in 3D space.
| -
|-
| '''loftemps'''
| loftemps is a deprecated option that only works for 1x1 sized units.
| -
|}

=== Player Units (Soldiers) ===

Defines a [[soldier]] recruited by X-COM, listed in ''"soldiers:"''. Currently only one soldier unit type (''XCOM'') is supported.

Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier name.
| ''required''
|-
| '''minStats'''
| Minimum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the initial stat (not generated).
| -
|-
| '''maxStats'''
| Maximum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the minimum value for the first month of psi training (actual value is 100%-150%).
| -
|-
| '''statCaps'''
| Maximum stats this soldier can gain through [[Experience]]. '''NOTE:''' A stat will still go over the limit once, and then will no longer increase (see [[Experience#Regarding Caps|Regarding Caps]]).
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this soldier uses by default.
| -
|-
| '''standHeight'''
| Height of this soldier when standing.
| 0
|-
| '''kneelHeight'''
| Height of this soldier when kneeling.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|}

=== AI Units (Aliens/Civilians) ===

Defines an [[Alien Life Forms|alien]] (enemy) or [[civilian]] (neutral) unit, listed in ''"units:"''. Every different alien rank is a different unit, since they have completely different stats. Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the unit name.
| ''required''
|-
| '''race'''
| String ID of the unit race (for alien units).
| -
|-
| '''rank'''
| String ID of the unit rank (for alien units).
| -
|-
| '''stats'''
| Battlescape stats of this unit.
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this unit uses by default.
| -
|-
| '''standHeight'''
| Height of this unit when standing.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''value'''
| [[Score]] this unit is worth.
| 0
|-
| '''deathSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit dies.
| -1
|-
| '''aggroSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit aggros.
| -1
|-
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit moves.
| -1
|-
| '''intelligence'''
| Intelligence of this unit's AI. The higher the value, the longer this unit remembers player troops between turns.
| 0
|-
| '''aggression'''
| Aggression of this unit's AI. The higher the value, the more ruthless the unit, the more likely to make a frontal assault. Less aggressive units tend to set up ambushes.
Vanilla values are:
* 0 = mostly passive
* 1 = balanced
* 2 = mostly aggresive
| 0
|-
| '''energyRecovery'''
| Energy recovered by the unit each turn (needs verification)
| 40 (?)
|-
| '''specab'''
| Special ability of this unit:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]] (Requires '''power''' and '''blastRadius''' properties to be set on the corpse)
* 2 = [[Bio-Drone|Burns Floor]]
* 3 = [[Zombie|Respawns on Death]]
| 0
|-
| '''spawnUnit'''
| String ID of the unit used to respawn on death (eg. [[Zombie]]s respawn as [[Chrysallid]]s).
| -
|-
| '''livingWeapon'''
| Is this unit a living weapon? (only attacks with a '''fixedWeapon''')
| false
|-
|}

=== Alien Races ===

Defines a [[Alien Life Forms|race]] used in [[Alien Missions]], listed in ''"alienRaces:"''. Heavily tied with deployment data.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the alien race name.
| ''required''
|-
| '''members'''
| Alien crew associated with this alien race (eg. race units + terrorist units), defined by a list of unit string IDs. Order here will define rank in terms of deployment. generally speaking the order is:
* 0 - Commander
* 1 - Leader
* 2 - Engineer
* 3 - Medic
* 4 - Navigator
* 5 - Soldier
* 6 - Terrorist 1
* 7 - Terrorist 2
but of course, not all races have all ranks, so the "fill in" rank would be listed multiple times (see ethereals).
| -
|-
| '''retaliation'''
| retaliation enables/disables the race for retaliation missions.
| ''True''
|-
|}

=== Alien Deployments ===

Defines a Battlescape deployment data used in [[Alien Missions]] (such as alien and map configurations), listed in ''"alienDeployments:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the deployment name.
| ''required''
|-
| '''width'''
| Width of the Battlescape map in grid units.
| 0
|-
| '''length'''
| Length of the Battlescape map in grid units.
| 0
|-
| '''height'''
| Vertical height of the Battlescape map in grid units.
| 0
|-
| '''terrains'''
| list of string IDs of the [[#Terrains|terrain]] to choose from to generate this map. This is not used for UFO sites where the terrain comes from the Geoscape.
| -
|-
| '''shade'''
| Shade of the map (0-15, where 0 is full daytime and 15 is full nighttime). This is not used for UFO sites where the shade comes from the Geoscape.
| 0
|-
| '''nextStage'''
| String ID of the next deployment stage to use after this one, for multi-stage missions.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|}

Notes:
* '''terrains''' can also be used with UFOs, with the game using instead the listed terrain rather than the location of the UFO on Geoscape.
==== Deployment Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''alienRank'''
| [[Alien Rank|Rank]] associated with this deployment data, as defined by the order of the race in question (see above)
| ''required''
|-
| '''lowQty'''
| Minimum quantity of aliens to spawn on beginner/experienced.
| 0
|-
| '''highQty'''
| Minimum quantity of aliens to spawn on superhuman. (minimum quantity for veteran/genius is the median of this and the previous value)
| 0
|-
| '''dQty'''
| Delta in Quantity. ie: random number of aliens to spawn on top of the minimum (all difficulties).
| 0
|-
| '''percentageOutsideUfo'''
| Percentage (0-100%) of aliens to spawn outside in UFO sites.
| 0
|-
| '''itemSets'''
| Three lists (one for each alien technology level) of [[#Items|items]] (string IDs) for the aliens to equip.
| ''required''
|-
|}

=== Research ===

Defines a [[Research|research topic]] that X-COM scientists can investigate, listed in ''"research:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the research project's name (or item, if a '''lookup''' is defined).
| ''required''
|-
| '''lookup'''
| String ID of the research project's display name and UFOPaedia article reference.
| -
|-
| '''cost'''
| Number of man hours (on average) required to complete this project.
| 0
|-
| '''points'''
| [[Score]] earned for completing this project.
| 0
|-
| '''needItem'''
| Does this project require an [[#Items|item]] of the same name?
| false
|-
| '''dependencies'''
| List of research projects that can unlock access to this one. If the full list is researched, or if one of the projects on the list "unlocks" this one, it becomes available.
| -
|-
| '''unlocks'''
| List of research projects unlocked, regardless of other dependencies, but not requirements, by completing this project (for example, any live alien unlocks "alien origins").
| -
|-
| '''requires'''
| List of research projects unilaterally required before this project can be unlocked (for example, "the martian solution" will not even be considered for unlocking until AFTER "alien origins" is completed).
| -
|-
| '''getOneFree'''
| List of "bonus" research projects that may be granted when completing this project (for example, alien medics will give you information on other alien races). Only applies to living aliens.
| -
|-
|}

=== Manufacture ===

Defines a [[Manufacture|manufacture project]] that X-COM engineers can produce, listed in ''"manufacture:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the manufacturing project's name (and the item it produces).
| ''required''
|-
| '''category'''
| String ID of the manufacturing project's category.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this project. If none are specified, this project is unlocked from the start.
| -
|-
| '''space'''
| Amount of [[Workshop]] space required to begin this project.
| 0
|-
| '''time'''
| Number of man hours (on average) required per item.
| 0
|-
| '''cost'''
| Monetary deduction per item manufactured.
| 0
|-
| '''requiredItems'''
| List of [[#Items|items]] required and consumed per item manufactured.
| -
|-
| '''producedItems'''
| List of [[#Items|items]] produced per each item consumed. If not specified, defaults to 1 item with the same string ID as the manufacture.
| 1
|-
|}

=== UFOpaedia Article ===

Defines an article in the in-game [[UFOpaedia]], listed in ''"ufopaedia:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the article name. This must match the ID of the object associated with this article, if applicable.
| ''required''
|-
| '''title'''
| String ID of the article title. If omitted, the '''id''' is used.
| -
|-
| '''type_id'''
| Type of this article:
* 0 = Unknown
* 1 = [[Craft]]
* 2 = [[Craft Armaments]]
* 3 = [[HWP]]
* 4 = [[Equipment (EU)|Equipment]]
* 5 = [[Armour]]
* 6 = [[Base Facilities]]
* 7 = Text & Image (eg. [[Alien Life Forms]], [[UFO Components]])
* 8 = Text (eg. [[Alien Research]])
* 9 = [[UFO]]
| 0
|-
| '''section'''
| String ID of the UFOpaedia section this article belongs in.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this article. If none are specified, this article is unlocked from the start.
| -
|-
| '''image_id'''
| Filename of the [[UP001.SPK-UP042.SPK|background image]] displayed on this article, if applicable.
| -
|-
| '''text'''
| String ID of the description displayed on this article.
| -
|-
| '''text_width'''
| Maximum width of the text displayed, only applicable to ''Text & Image'' articles.
| 0
|-
| '''rect_stats'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the stats text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''rect_text'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the description text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''weapon'''
| String ID of the weapon, only applicable to ''HWP'' articles.
| -
|}

=== UFO Trajectories ===

Defines a trajectory carried out by an UFO during an [[#Alien Missions|alien mission]], listed in ''"ufoTrajectories:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the trajectory name.
| ''required''
|-
| '''groundTimer'''
| Amount of seconds for the UFO to spend on Ground waypoints.
| 0
|-
| '''waypoints'''
| List of waypoints for the UFO to traverse, defined as ''[zone, altitude, speed]''. 
'''zone''': Globe zone where the waypoint is located. 
'''altitude''': UFO altitude after reaching this waypoint:
* 0 - Ground
* 1 - Very Low
* 2 - Low
* 3 - High
* 4 - Very High
'''speed''': UFO speed after reaching this waypoint, as a percentage (0-100%) of its maximum speed.
| -
|}

=== Alien Missions ===

Defines an [[Alien Missions|alien mission]] carried out by UFOs on the Geoscape, listed in ''"alienMissions:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the mission type.
| ''required''
|-
| '''points'''
| [[Score]] allocated to aliens for successfully completing this mission.
| 0
|-
| '''raceWeights'''
| List of alien races likely to carry out this mission, and the % chance of them being allocated to this mission, listed by "number of months after game beginning".
| ''required''
|-
| '''waves'''
| List of UFO waves to spawn as this mission progresses, as described below.
| ''required''
|}

==== Waves ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''ufo'''
| String ID of the [[#UFOs|UFO]] to spawn.
| ''required''
|-
| '''count'''
| Number of UFOs to spawn.
| 0
|-
| '''trajectory'''
| String ID of the [[#UFO Trajectories|trajectory]] for this UFO to use when entering Earth's atmosphere.
| ''required''
|-
| '''timer'''
| How long after the previous wave should this wave arrive? (in seconds)
| 0
|-
|}

=== Alien Item Levels ===

This is a list of item level probabilities, with a number between 0 and 2 representing an item level from plasma pistols to heavy plasmas, as defined in the deployments, expressing a 10% probability for that item level being used.

0 = first set (plasma pistol/clip)
1 = second set (plasma rifle/clip)
2 = third set (heavy plasma/clip)

For example:
[ 2, 0, 0, 0, 0, 0, 0, 1, 1, 1 ]
would represent a 60% chance for pistols, 30% rifles, and 10% heavy weapons. 
Note that the order does not matter, but the length DOES. each line MUST have 10 digits.

The above can be confusing. There are 10 fields; each number represents 10%. 
There are six instances of '0'. 6x10% = 60% chance of plasma pistol 
There are three instances of '1'. 3x10% = 30% chance of plasma rifle 
There is only one instance of '2'. 1x10% = 10% chance of heavy plasma 

Each line represents a month after the beginning of the game, and there is no limit to the number defined. 
OpenXCom will use the most recently available item level in the event the game goes on forever.

=== Extra Sprites ===

Adds or replaces sprites in an existing [[Image Formats|X-COM image file]], listed in ''"extraSprites:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original/new image to modify.
| ''required''
|-
| '''width'''
'''height'''
| Size of the sprite(s) in pixels.
| 0
0
|-
| '''singleImage'''
| Is the image file just a single sprite (true) or a spritesheet (false)?
| false
|-
| '''subX'''
'''subY'''
| Size of the subdivision in pixels. If a subdivision is specified, then the image file is divided into chunks to form the sprites (eg. spritesheets).
| 0
0
|-
| '''files'''
| List of the new sprites to add/replace, listed as ''spriteID: filename''.
| -
|}

Example:
- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/Bunny00.png
1: Resources/Bunny/Bunny01.bmp
2: Resources/Bunny/Bunny02.gif

=== Extra Sounds ===

Adds or replaces sounds in an existing [[SOUND|X-COM sound file]], listed in ''"extraSounds:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ID of the original sound file to modify:
* BATTLE.CAT - Battlescape sounds, corresponds to ''SOUND1.CAT'' or ''SAMPLE2.CAT'' (55 sounds).
* INTRO.CAT - Intro sounds, corresponds to ''INTRO.CAT'' or ''SAMPLE3.CAT'', probably best not to mess with these.
* GEO.CAT - Geoscape sounds, corresponds to ''SOUND2.CAT'' or ''SAMPLE.CAT'' (14 sounds).
| ''required''
|-
| '''files'''
| List of the new sounds to add/replace, listed as ''soundID: filename''.
| -
|}

Example:
- type: BATTLE.CAT
files:
55: Resources/Sounds/sample.wav

=== Extra Strings ===

Adds or replaces text strings in an existing [[Translations (OpenXcom)|OpenXcom language file]], listed in ''"extraStrings:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original language file to modify, sans extension.
| ''required''
|-
| '''strings'''
| List of the new strings to add/replace, listed as ''stringID: text''.
| -
|}

Example:
- type: en-US
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: en-GB
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: de
strings:
STR_SNIPER_RIFLE: Scharfschützengewehr
STR_SNIPER_RIFLE_CLIP: Scharfschützengewehrmunition
- type: ru
strings:
STR_SNIPER_RIFLE: Снайперская винтовка
STR_SNIPER_RIFLE_CLIP: Магазин к снайп. винтовке

=== StatStrings ===

[[Statstrings]] are used for automatically renaming soldiers. They are case sensitive and they are processed in the order in which they are specified.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''string'''
| String to add to name.
| ''required''
|-
| '''psiStrength''' 
'''psiSkill''' 
'''bravery''' 
'''strength''' 
'''firing''' 
'''reactions''' 
'''stamina''' 
'''tu''' 
'''health''' 
'''throwing'''
| One or more stat ranges are ANDed together for success. Each range has a minVal and maxVal. Use YAML standard tilde (~) to indicate null. ((~) = 0 as minvalue; (~) =255 as maxvalue)
| -
|}

Example:
statStrings:
- string: "x"
psiStrength: [~, 30]
- string: "P"
psiStrength: [80, ~]
- string: "p"
psiStrength: [60, 79]
- string: "K"
psiSkill: [60, ~]
- string: "k"
psiSkill: [30, 59]
- string: "b"
bravery: [60, ~]
- string: "c"
bravery: [~, 10]
- string: "w"
strength: [~, 25]
- string: "Snpr"
firing: [60, ~]
reactions: [60, ~]
- string: "M"
firing: [70, ~]
- string: "m"
firing: [60, 69]
- string: "Sct"
reactions: [50, ~]
tu: [60, ~]
- string: "R"
reactions: [60, ~]
- string: "r"
reactions: [50, 59]

==References==
<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2015-02-06T12:00:00Z

Kkmic: /* AI Units (Aliens/Civilians) */ Added specab 1 requirements

A reference of all the customizable values of everything in a [[Rulesets (OpenXcom)|ruleset]], according to the latest nightly. This page should be updated as new versions become available in order to explain the changes from [[Ruleset Reference (OpenXcom)|version 1.0]].

Some guidelines:
* If a value is omitted from the ruleset, the default is used. You cannot omit ''required'' values.
* Text strings (eg. names) are represented by string IDs from the [[Translations (OpenXcom)|language files]]
* Numerical IDs (used for sprites, sounds, etc.) start at 0, not 1.
* Boolean (yes/no) values are represented by true/false.
* World coordinates are represented in degrees (see [[WORLD.DAT]]).
* Money amounts (prices, costs, etc.) are represented in dollars.
* All paths are '''case sensitive'''! If your ruleset uses external files, make sure that they named properly as described in ruleset.

Items are ordered as they come in the ruleset. To override this, you can specify a ''listOrder''. You can find the default listOrders in [[Ruleset List Order (OpenXcom)|Ruleset List Order]].

=== Globe ===

Defines the drawing of landmasses and borders on the globe.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''data'''
| Path name of file which contains polygon and texture information. (For example WORLD.DAT).
| -
|-
| '''polygons'''
| List of polygons drawn on the globe surface. A triangle consist of seven values: the first number defines the texture, followed by three pairs of (x,y) globe coordinates. Only polygons with 3 or 4 vertices are reliable shown on the globe = 7 or 9 values per entry.
| -
|-
| '''polylines'''
| List of border lines. Each list entry consist of a list of (x,y) globe coordinates.
| -
|}

=== Countries ===

Defines one of the [[Country Funding (EU)|funding nations]], listed in ''"countries:"''. They're used for activity graphs and player scoring.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the country name.
| ''required''
|-
| '''fundingBase'''
| Country's base funding, in thousands. The starting funding can be anywhere between 1x and 2x the base funding.
| 0
|-
| '''fundingCap'''
| Country's funding cap, in thousands. Once a country reaches this maximum, it will no longer increase its funding.
| 0
|-
| '''labelLon'''
'''labelLat'''
| Longitude and latitude coordinates of the country's label on the globe. This label is only shown when the globe is zoomed in and "detail" is turned on.
| 0.0
0.0
|-
| '''areas'''
| List of "rectangles" on the globe defined as [''lon1'' ''lat1'' ''lon2'' ''lat2'']. Any activity within these areas counts towards the country's graph activity and affects their opinion of the player.
| -
|}

=== Regions ===

Defines one of the [[Geoscape (EU)#World Regions/Countries|world regions]], listed in ''"regions:"''. They're used for base placement, activity graphs and mission spawning.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the region name.
| ''required''
|-
| '''cost'''
| Amount of money spent building an X-COM base in this region (first base is free).
| 0
|-
| '''areas'''
| List of "rectangles" on the globe defined as ''[lon1, lat1, lon2, lat2]''. Any activity within these areas counts towards the region's graph activity.
| -
|-
| '''cities'''
| List of cities belonging to this region. They will be displayed on the globe and used for terror site missions. Each city is defined by their '''lon''' and '''lat''' coordinates and a '''name''' string ID. Cities can also have a '''zoom''' setting (default value is 3) which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''regionWeight'''
| Weight of this region when selecting regions for alien missions.
| 0
|-
| '''missionWeights'''
| Weighted list of the different mission types for this region (eg. ''STR_ALIEN_RESEARCH: 14'').
| -
|-
| '''missionZones'''
| List of "rectangles" (''[lon1, lat1, lon2, lat2]'') defining the mission zones for this region. Mission zones are waypoints for UFO trajectories.
| -
|-
| '''missionRegion'''
| Spawn mission in this region instead (used for regions without land).
| -
|}

=== Base Facilities ===

Defines one of the [[Base Facilities (EU)|facilities]] that can be built in an X-COM base, listed in ''"facilities:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the facility name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this facility. If none are specified, this facility is unlocked from the start.
| -
|-
| '''spriteShape'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's outer shape in the Basescape and UFOpaedia.
| -1
|-
| '''spriteFacility'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's contents in the Basescape and UFOpaedia. Drawn on top of '''spriteShape'''.
| -1
|-
| '''lift'''
| Is this facility an [[Access Lift]]? All base facilities must be connected to the lift.
| false
|-
| '''hyper'''
| Is this facility a [[Hyperwave Decoder]]? Displays extra information for detected UFOs. Only valid for radar facilities.
| false
|-
| '''mind'''
| Is this facility a [[Mind Shield]]? Reduces the chance of UFOs finding your base. Does not stack.
| false
|-
| '''grav'''
| Is this facility a [[Grav Shield]]? Doubles the power of your base defenses. Does not stack.
| false
|-
| '''size'''
| Size of the facility, in grid units. Every facility is square, so a size of 1 means 1x1, 2 means 2x2, etc. Bigger facilities are made up of multiple sprites, for example a 2x2 facility will use 4 sprites for '''spriteShape''' and 4 sprites for '''spriteFacility''' (top-left, top-right, bottom-left, bottom-right).
| 1
|-
| '''buildCost'''
| Amount of money spent to build this facility in the base.
| 0
|-
| '''buildTime'''
| Amount of days it takes for this facility to be built.
| 0
|-
| '''monthlyCost'''
| Amount of money spent monthly for the maintenance of this facility.
| 0
|-
| '''storage'''
| Amount of storage space (for items) this facility provides. See [[Base Stores]].
| 0
|-
| '''personnel'''
| Amount of personnel (soldiers, scientsts, engineers) these quarters can contain.
| 0
|-
| '''aliens'''
| Amount of live aliens this facility can contain. Only checked if the ''alienContainmentLimitEnforced'' option is enabled.
| 0
|-
| '''crafts'''
| Amount of X-COM craft this facility can contain.
| 0
|-
| '''labs'''
| Amount of lab space this facility provides for research projects.
| 0
|-
| '''workshops'''
| Amount of workshop space this facility provides for manufacture projects.
| 0
|-
| '''psiLabs'''
| Amount of soldier space this facility provides for psionic training.
| 0
|-
| '''radarRange'''
| Maximum radar detection range of this facility, in nautical miles.
| 0
|-
| '''radarChance'''
| Chance (0-100%) of this radar detecting a UFO that enters its range.
| 0
|-
| '''defense'''
| Offensive power provided by this base defense against attacking UFOs.
| 0
|-
| '''hitRatio'''
| Chance (0-100) of the base defense hitting an attacking UFO.
| 0
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense hits a target.
| -1
|-
| '''mapName'''
| [[MAPS|Map]] associated to this facility in Battlescape base defenses.
| -
|-
|}

=== Crafts ===

Defines one of the [[Craft|X-COM crafts]] that go on interception missions, listed in ''"crafts:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the craft name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this craft. If none are specified, this craft is unlocked from the start.
| -
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw this craft in the Basescape and from [[INTICON.PCK]] used to draw the damage indicator in dogfights.
modders: the corresponding extrasprite file id for BASEBITS.PCK is sprite+33 INTICON.PCK contains a minimized icon id=sprite the file id for the dogfight image is sprite+11
| -1
|-
| '''fuelMax'''
| Maximum amount of fuel this craft can carry. Crafts use up fuel based on their speed while travelling.
| 0
|-
| '''damageMax'''
| Maximum amount of damage this craft can take. If this amount is exceeded, the craft is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles. Crafts travel at max speed when flying and half speed when patrolling.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''weapons'''
| Amount of craft weapons this craft can equip. The UI can only display a max of 2 weapons.
| 0
|-
| '''soldiers'''
| Amount of soldiers this craft can carry.
| 0
|-
| '''maxItems'''
| Amount of items this craft can carry.
| 80
|-
| '''vehicles'''
| Amount of vehicles this craft can carry.
| 0
|-
| '''costBuy'''
| Amount of money spent for purchasing this craft. If set to 0, the craft will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costRent'''
| Amount of money spent monthly for renting this craft. If set to 0, the craft is not on rental and won't count towards base maintenance.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this craft.
| 0
|-
| '''refuelItem'''
| Item required for refuelling this craft. If no item is specified, the craft uses human fuel.
| 0
|-
| '''repairRate'''
| Amount of damage restored every hour while [[Repairs|Repairing]] in base.
| 1
|-
| '''refuelRate'''
| Amount of fuel restored every 30 mins while [[Refueling]] in base. If specified, a '''refuelItem''' is spent each time.
| 1
|-
| '''radarRange'''
| Detection range of the craft's radar in nautical miles. Every craft radar has a 100% detection chance.
| 600
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this craft to a base.
| 0
|-
| '''score'''
| [[Score]] lost when this craft is destroyed.
| 0
|-
| '''spacecraft'''
| Can this craft go to [[Cydonia]]?
| false
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this craft in Battlescape missions.
| -
|-
| '''deployment'''
| Custom positions for the unit deployment in the craft, listed as: ''[x, y, z, facing]''
If not specified, units are placed on empty spots from top-left to bottom-right facing top-right.
| -
|}

=== Craft Weapons ===

Defines one of the [[Craft Armaments|weapons]] equipped by X-COM craft for shooting down UFOs, listed in ''"craftWeapons:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the weapon name.
| ''required''
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the weapon in the Basescape and from [[INTICON.PCK]] used to draw the weapon in dogfights.
modders: the corresponding extrasprites file id for INTICON.PCK is sprite+5 and sprite+48 for BASEBITS.PCK
| -1
|-
| '''sound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when this weapon fires.
| -1
|-
| '''damage'''
| Amount of damage this weapon does to enemy UFOs.
| 0
|-
| '''range'''
| Maximum range of this weapon in dogfights (in meters).
| 0
|-
| '''accuracy'''
| Chance (0-100%) of each shot hitting the enemy UFO.
| 0
|-
| '''reloadCautious'''
| Time this weapon takes to fire between each shot in ''Cautious Mode''.
| 0
|-
| '''reloadStandard'''
| Time this weapon takes to fire between each shot in ''Standard Mode''.
| 0
|-
| '''reloadAggressive'''
| Time this weapon takes to fire between each shot in ''Aggressive Mode''.
| 0
|-
| '''ammoMax'''
| Maximum amount of ammo this weapon can carry.
| 0
|-
| '''rearmRate'''
| Amount of ammo restored every 30 mins while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize'''. If the '''clipSize''' of the specified ammo is 0, no '''clip'''s are spent.
| 1
|-
| '''projectileType'''
| Type of the weapon projectile, used for the projectile sprite in dogfights:
* 0 - [[Stingray]]
* 1 - [[Avalanche]]
* 2 - [[Cannon]]
* 3 - [[Fusion Ball]]
* 4 - [[Laser Cannon]]
* 5 - [[Plasma Beam]]
| 2
|-
| '''projectileSpeed'''
| Speed of the weapon projectile in dogfights.
| 0
|-
| '''launcher'''
| String ID of the [[#Items|item]] required to equip this weapon.
| -
|-
| '''clip'''
| String ID of the [[#Items|item]] required to rearm this weapon.
| -
|}

=== Items ===

Defines the Geoscape and Battlescape properties of an [[Equipment (EU)|item]] that can be stored in X-COM bases, listed in ''"items:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the internal item name.
| ''required''
|-
| '''name'''
| String ID of the displayed item name, for cases where it's different from the internal name. If omitted, '''type''' is used.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this item. If none are specified, this item is unlocked from the start. Soldiers can only use unlocked items in the Battlescape.
| -
|-
| '''size'''
| Space occupied by this item in [[Base Stores]]. Can be a decimal value.
| 0.0
|-
| '''costBuy'''
| Amount of money spent for purchasing this item. If set to 0, this item will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this item.
| 0
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this item to a base.
| 24
|-
| '''weight'''
| [[Item_Weight|Weight]] occupied by this item in a soldier's inventory.
| 999
|-
| '''bigSprite'''
| Sprite ID from [[BIGOBS.PCK]] used to draw this item in a soldier's inventory and UFOpaedia.
| -1
|-
| '''floorSprite'''
| Sprite ID from [[FLOOROB.PCK]] used to draw this item on the floor of a Battlescape tile.
| -1
|-
| '''handSprite'''
| Sprite ID from [[HANDOB.PCK]] used to draw this item on a soldier's hand in the Battlescape.
modders: each handobject needs 8 images (8 directions) define the extrasprites accordingly
| 120
|-
| '''bulletSprite'''
| Sprite ID from ''BulletSprites.png'' used to draw this weapon's projectile on the Battlescape:
* 0 - [[Rocket Launcher]]
* 1 - [[Pistol]]
* 2 - [[Rifle]]
* 3 - [[Auto Cannon]]
* 4 - [[Heavy Cannon]]
* 5 - [[Laser Pistol]]
* 6 - [[Laser Rifle]]
* 7 - [[Heavy Laser]]
* 8 - [[Plasma Rifle|Plasma]]
* 9 - [[Small Launcher]]
* 10 - [[Blaster Launcher]]
for modders: the bulletsprite needs to be put into the extraSprites type "Projectiles" the bulletsprite can contain up to 35 3x3 images. The corresponding file id is 35*[bulletSprite]
| -1
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target.
| -1
|-
| '''hitAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "hit explosion".
'''NOTE''': Do not define this value for melee/psi weapons, they use [[HIT.PCK]] and therefore meleeAnimation instead.
| 0
|-
| '''power'''
| Average damage of the weapon, in most cases it will be +-50% this value.
| 0
|-
| '''strengthApplied'''
| Add the attacking unit's strength to this weapon's damage.
| false
|-
| '''compatibleAmmo'''
| List of string IDs of the ammo items that can be loaded on this weapon. If none are specified, the weapon doesn't need ammo.
| -
|-
| '''damageType'''
| What type of [[damage]] does this weapon do:
* 0 - None
* 1 - Armor Piercing
* 2 - Incendiary
* 3 - High Explosive
* 4 - Laser
* 5 - Plasma
* 6 - Stun
* 7 - Melee
* 8 - Acid
* 9 - Smoke
'''NOTE:''' A damage type other than 0-9 will do nothing.
| 0
|-
| '''tuAuto'''
'''accuracyAuto'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Auto Shot. If 0, the weapon does not have an Auto Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Auto Shot.
| 0
0
|-
| '''tuSnap'''
'''accuracySnap'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire a Snap Shot. If 0, the weapon does not have a Snap Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing a Snap Shot.
| 0
0
|-
| '''tuAimed'''
'''accuracyAimed'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Aimed Shot. If 0, the weapon does not have an Aimed Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Aimed Shot.
| 0
0
|-
|-
| '''tuMelee'''
'''accuracyMelee'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to do a melee attack (Hit). If 0, the weapon does not have a melee attack.
The base accuracy (0-100%) applied to a soldier's [[Melee Accuracy]] when doing a melee attack.
| 0
0
|-
| '''clipSize'''
| The amount of ammo stored in each weapon clip. If -1 is specified, this weapon has infinite ammo.
| 0
|-
| '''battleType'''
| Defines the weapon's behavior in the Battlescape:
* 0 - None (Geoscape-only item)
* 1 - [[Weapons|Firearm]]
* 2 - Ammo
* 3 - Melee
* 4 - [[Grenade]]
* 5 - [[Proximity Grenade]]
* 6 - [[Medi-Kit (EU)|Medi-Kit]]
* 7 - [[Motion Scanner]]
* 8 - [[Mind Probe]]
* 9 - [[Psi-Amp]]
* 10 - [[Electro-flare]]
* 11 - Corpse
| 0
|-
| '''twoHanded'''
| Is this weapon two-handed? If true, incurs an accuracy penalty if used with both hands occupied. Note that the handsprite of a twoHanded item is also drawn at a slightly different position than a one handed item.
| false
|-
| '''waypoint'''
| Does this weapon use waypoints? (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system.
| false
|-
| '''fixedWeapon'''
| Is this weapon fixed? (it's part of a unit, eg. tanks and terrorist units)
| false
|-
| '''invWidth'''
| Item width in a soldier's inventory (in grid units).
| 1
|-
| '''invHeight'''
| Item height in a soldier's inventory (in grid units).
| 1
|-
| '''painKiller'''
| Amount of painkillers contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''heal'''
| Amount of heal's contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stimulant'''
| Amount of stimulants contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''woundRecovery'''
| Amount of [[Fatal Wounds]] treated by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''healthRecovery'''
| Amount of [[Health]] recovered by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stunRecovery'''
| Amount of [[Stun]] removed by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''energyRecovery'''
| Amount of [[Energy]] recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''tuUse'''
| Amount of [[Time Units]] required to use this item (for non-offensive items). It's a flat rate if '''flatRate''' is true, otherwise it's a percentage (0-100%).
| 0
|-
| '''recoveryPoints'''
| [[Score]] gained for recovering this alien artifact.
| 0
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''turretType'''
| Sprite ID from [[TANKS.PCK]] of the turret to assign to this tank:
* 0 - [[Tank/Cannon]]
* 1 - [[Tank/Rocket Launcher]]
* 2 - [[Tank/Laser Cannon]]
* 3 - [[Hovertank/Plasma]]
* 4 - [[Hovertank/Launcher]]
| -1
|-
| '''liveAlien'''
| Does this item represent a live alien? (counts towards [[Alien Containment]])
| false
|-
| '''blastRadius'''
| Size of the projectile explosions. 0 for no explosion. -1 to automatically calculate based on weapon power and damage type (actual '''blastRadius''' currently is capped due [[Explosions#Playing_With_Fire|Explosion calculations]]).
| -1
|-
| '''flatRate'''
| If true, then TU costs for this weapon are a flat rate (instead of a percentage of unit TUs).
| false
|-
| '''arcingShot'''
| Does this weapon fire in an arc?
| false
|-
| '''attraction'''
| Represents how likely an alien is to pick up this item. Values below 5 will be ignored (by design).
| 0
|-
| '''maxRange'''
| Maximum range at which this weapon can operate.
| 200
|-
| '''aimRange'''
| Maximum effective range with this weapon before which range-based dropoff occurs.
| 200
|-
| '''snapRange'''
| Maximum effective range with snap shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 15
|-
| '''autoRange'''
| Maximum effective range with auto shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 7
|-
| '''minRange'''
| Range-based dropoff will work in reverse for ranges below this.
| 0
|-
| '''dropoff'''
| The value by which the accuracy lowers for each tile after (or before) the thresholds above.
| 2
|-
| '''bulletSpeed'''
| How much faster (or slower, if you use a negative number) is a projectile fired from this weapon compared to the average.
| 0
|-
| '''autoShots'''
| How many auto shots does this weapon fire.
| 3
|-
| '''shotgunPellets'''
| Number of projectiles fired per unit of ammunition. (note: due to engine limitations it is currently impossible to draw multiple projectiles in flight.)
| 0
|-
| '''zombieUnit'''
| String ID of the unit used for zombification (eg. [[Chrysallid]]s turn units into [[Zombie]]s).
| none
|-
| '''meleeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon attacks a target with melee.
| 39
|-
| '''meleeHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon HITS a target with melee.
| -1
|-
| '''meleeAnimation'''
| Sprite ID from HIT.PCK played when this weapon attacks a target with melee.
| 0
|-
| '''meleePower'''
| Damage this weapon will do when using melee. This only applies to Firearms, and is only available as stun damage. For normal melee weapons, use regular power and damage types.
| 0
|-
| '''LOSRequired'''
| Does this item require line of sight? (only applies to mind probes and psi-amps)
| false
|-
| '''skillApplied'''
| Is melee skill applied to the accuracy of an attack made with this object?
| true
|-
|}

=== UFOs ===

Defines one of the [[UFOs]] that invade Earth, listed in ''"ufos:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the UFO name.
| ''required''
|-
| '''size'''
| String ID of the UFO size.
| STR_VERY_SMALL
|-
| '''sprite'''
| Sprite ID from [[INTERWIN.DAT]] used to draw this UFO in the dogfight view and UFOpaedia.
don't try to add more images if you don't want to punch yourself in the face - use modsprite
| -1
|-
| '''modSprite'''
| Filename used to draw this UFO in the dogfight view and UFOpaedia.
| -
|-
| '''damageMax'''
| Maximum amount of damage this UFO can take. If the UFO takes 50% damage, it crash lands. If it takes 100% damage, it is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''power'''
| Damage power of this UFO's weapon in dogfights.
| 0
|-
| '''range'''
| Maximum range of this UFO's weapon in dogfights (in meters).
| 0
|-
| '''score'''
| [[Score]] gained when this UFO is destroyed, or half this score if it crash lands.
| 0
|-
| '''reload'''
| Time the UFO's weapon takes to fire between each shot.
| 0
|-
| '''breakOffTime'''
| Minimum amount of time for the UFO to be able to break off of a dogfight.
| 0
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this UFO in Battlescape missions.
| ''required''
|-
|}

=== Inventory Sections ===

Defines one of the sections of the [[Inventory TU Table|Battlescape inventory]] (eg. Backpack), listed in ''"invs:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the inventory name.
| ''required''
|-
| '''x'''
'''y'''
| Pixel coordinates of this section on the inventory screen.
| 0
0
|-
| '''type'''
| Type of this section:
* 0 = Slot section, can contain as many items as will fit on the slots.
* 1 = Hand section, can only contain one item regardless of size.
* 2 = Ground section, can contain infinite items.
| 0
|-
| '''slots'''
| List of the grid slots (''[x, y]'') that this section is composed of. For example, to make a 2x2 section, you would have ''[0, 0] [0, 1] [1, 0] [1, 1]''.
| -
|-
| '''costs'''
| List of [[Time Units]] costs to move an item from this section to another one (eg. ''STR_BACKPACK: 16'' means it will cost 16 TUs to move an item from this section to the Backpack).
| -
|-
|}

=== Terrains ===

Defines one of the [[TERRAIN|terrains]] used to generate a Battlescape map, listed in "terrains:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the terrain name.
| ''required''
|-
| '''textures'''
| List of [[TEXTURE.DAT|Geoscape textures]] that correspond to this terrain.
| -
|-
| '''hemisphere'''
| Geoscape hemisphere associated with this terrain:
* -1 - Northern hemisphere.
* 0 - Both hemispheres.
* 1 - Southern hemisphere.
| 0
|-
| '''mapDataSets'''
| List of filenames (each with matching [[MCD]]/[[Image Formats#PCK|PCK/TAB]] files) that contain the tiles of this terrain.
| -
|-
| '''mapBlocks'''
| List of map blocks (see below) that are used for generating a map.
| -
|-
| '''civilianTypes'''
| List of units to use as civilians for this mission.
| [MALE_CIVILIAN, FEMALE_CIVILIAN]
|-
|}

==== Map Blocks ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| Filename of the [[MAPS|map]].
| ''required''
|-
| '''width'''
| Width of this map block in Battlescape grid units.
| 0
|-
| '''length'''
| Length of this map block in Battlescape grid units.
| 0
|-
| '''height'''
| Height of this map block in Battlescape grid units.
| 1
|-
| '''groups'''
| List (or single number) of groups this mapblock belongs to (used in mapscripts)
default usage:
* 0 - Default
* 1 - Landing Zone (for placing X-COM / alien craft) (used in addcraft/ufo command)
* 2 - E-W Road (for city maps) (used in addline command)
* 3 - N-S Road (for city maps) (used in addline command)
* 4 - Road Crossing (for city maps) (used in addline command)
| 0
|-
| '''items'''
| An array of items to add to this mapblock, an the positions to place them at.
| -1
|}

* '''hemisphere''' only applies to UFO missions, not Terror ones.
*'''width/length''' defines the size of the map
** be aware that the mapview "width"-label is the openxcom ruleset length parameter
** be aware that the mapview "length"-label is the openxcom ruleset width parameter

==== Guidelines/Tips ====
* All maps with an XCOM/Alien craft require at least one map block assigned to Group 1. This map block can only contain ground tiles (no walls or objects), otherwise the game will crash or the walls/objects will be removed.
* All Terror terrains (listed under STR_TERROR_MISSION) require the Groups of '''Types''' 2, 3 and 4 (for a total of 3 maps, which are required to place roads).

=== Map Scripts ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| name of the script
| ''required''
|-
| '''commands'''
| List of MapCommands
| -
|}

==== Map Command ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Currently these commands are implemented:
* addBlock
* addLine
* addCraft
* addUFO
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
depending on the command type some of the following parameters are needed
| ''required''
|-
| '''label'''
| A numeric label that can be used for conditional execution of commands.
Each label should be unique within the command list (0=default no need for uniqueness).
| 0
|-
| '''conditionals'''
| Defines the conditions that allows the execution of this command.
eg. [1, -4] means it will be executed if command with label 1 was a success and command with label 4 failed.
commands that are not yet executed are always in failed state.
| 0
|-
| '''executionChances'''
| the chance that this command will be executed (or fails)
| 100
|-
| '''executions'''
| this command will be executed multiple times with a value > 1
| 1
|-
| '''groups'''
| Defines the what mapblock are used within this command. Can be list of goups or a single number.
| 0
|-
| '''blocks'''
| Alternative to groups. Here we define a list of mapblocks that are used within this command.
| 0
|-
| '''rects'''
| A list of possible ranges where (random) placement/checks/removal can happen in a map.
Is a list of a list of four integers.
| ?
|-
| '''size'''
| size of mapblocks that can be placed/checked/removed within rects. Also used for resize command type.
| ?
|-
| '''freqs'''
| For a list of mapblocks (defined by blocks?) we can define distribution frequency here.
| 1
|-
| '''maxUses'''
| For a list of mapblocks (defined by blocks?) we can define the maximal amount a mapblock can be used here.
| -1
|-
| '''direction'''
| used for addLine command type. Values are both, horizontal or vertical. Typically defines the road type distribution.
| -1
|-
| '''tunnelData'''
| Parameter for digTunnel command type. Contains level (default: 0) and a list of MCD replacement rules (MCDReplacements)
| 0
|}

==== Guidelines/Tips ====
* The Mapscript is still somewhat in development

=== Armor ===

Defines a Battlescape unit's [[armor]] as well as visual representation (so every unit has an armor), listed in ''"armors:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the armor name.
| ''required''
|-
| '''spriteSheet'''
| Sprite sheet from [[UNITS]] used to draw a unit wearing this armor.
| -
|-
| '''spriteInv'''
| Sprite used for the [[Inventory Backgrounds]] of a unit wearing this armor.
| -
|-
| '''corpseBattle'''
| List of string IDs of the corpse [[#Items|items]] generated when a unit wearing this armor is killed (one per unit tile) on the Battlescape.
| -
|-
| '''corpseGeo'''
| String ID of the corpse [[#Items|item]] associated with this unit on the Geoscape.
| -
|-
| '''storeItem'''
| String ID of the [[#Items|item]] that represents this armor in [[Base Stores]] for equipping.
| -
|-
| '''weight'''
| Physical weight of the armor when worn
| 6
|-
| '''stats'''
| like soldier stats (see below) but these are treated as stat bonuses for wearing the specific armor.
| -
|-
| '''frontArmor'''
| Protection provided on the front of the unit.
| 0
|-
| '''sideArmor'''
| Protection provided on the sides of the unit.
| 0
|-
| '''rearArmor'''
| Protection provided on the rear of the unit.
| 0
|-
| '''underArmor'''
| Protection provided under the unit (eg. from explosions).
| 0
|-
| '''drawingRoutine'''
| Drawing routine used to put together the body parts in the unit's '''spriteSheet''':
* 0 = [[Soldier]], [[Sectoid]]
* 1 = [[Floater]]
* 2 = [[HWP]]
* 3 = [[Cyberdisk]]
* 4 = [[Civilian]], [[Ethereal]]
* 5 = [[Sectopod]], [[Reaper]]
* 6 = [[Snakeman]]
* 7 = [[Chryssalid]]
* 8 = [[Silacoid]]
* 9 = [[Celatid]]
* 10 = [[Muton]]
* 11 = [[Submersible Weapons Systems]]
* 12 = [[Hallucinoid]]
* 13 = [[Aquanauts]]
* 14 = [[Calcinite]], [[Deep One]], [[Gillman]], [[Lobster Man]], [[Tasoth]]
* 15 = [[Aquatoid]]
* 16 = [[Bio-Drone]]
* 17 = TFTD Civilians type A and [[Zombie_(TFTD)]]
* 18 = TFTD Civilians type B
* 19 = [[Tentaculat]]
* 20 = [[Triscene]]
* 21 = [[Xarquid]]
| 0
|-
| '''movementType'''
| Type of movement provided by this armor:
* 0 = Walking
* 1 = Flying
* 2 = Sliding (no walking animation)
it also defines the body of an tank (32-images) in your spriteSheet or the change in sprites while flying using a flying armour see: [[TANKS.PCK]], [[XCOM_2.PCK]]
| 0
|-
| '''damageModifier'''
| List of decimal damage modifiers (1.0 = 100%) this armor applies to each damage type (see [[#Items|Items section]]) received. Modifiers must be specified for all damage types, in this order:
* None
* Armor Piercing
* Incendiary
* High Explosive
* Laser
* Plasma
* Stun
* Melee
* Acid
* Smoke
|
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0
|-
| '''size'''
| Size of the unit wearing this armor, in Battlescape grid units. Every unit is square, so a size of 2 means 2x2.
| 1
|-
| '''loftempsSet'''
| List of [[LOFTEMPS]] IDs (one per unit tile, so a 1x1 unit has 1, a 2x2 unit has 4, etc.) used to represent a unit wearing this armor in 3D space.
| -
|-
| '''loftemps'''
| loftemps is a deprecated option that only works for 1x1 sized units.
| -
|-
| '''forcedTorso'''
| soldier sprites have female and male torsos. some armours reuse these sprites for flying/non flying torso without difference between genders. This can be controlled by the parameter: 0 = use genderrelated torso, 1 = use male torso, 2 = use female torso
| 0

|}

=== Player Units (Soldiers) ===

Defines a [[soldier]] recruited by X-COM, listed in ''"soldiers:"''. Currently only one soldier unit type (''XCOM'') is supported.

Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier name.
| ''required''
|-
| '''minStats'''
| Minimum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the initial stat (not generated).
| -
|-
| '''maxStats'''
| Maximum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the minimum value for the first month of psi training (actual value is 100%-150%).
| -
|-
| '''statCaps'''
| Maximum stats this soldier can gain through [[Experience]]. '''NOTE:''' A stat will still go over the limit once, and then will no longer increase (see [[Experience#Regarding Caps|Regarding Caps]]).
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this soldier uses by default.
| -
|-
| '''standHeight'''
| Height of this soldier when standing.
| 0
|-
| '''kneelHeight'''
| Height of this soldier when kneeling.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''femaleFrequency'''
| The probability that a female soldier is hired.
| 50
|}

=== AI Units (Aliens/Civilians) ===

Defines an [[Alien Life Forms|alien]] (enemy) or [[civilian]] (neutral) unit, listed in ''"units:"''. Every different alien rank is a different unit, since they have completely different stats. Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the unit name.
| ''required''
|-
| '''race'''
| String ID of the unit race (for alien units).
| -
|-
| '''rank'''
| String ID of the unit rank (for alien units).
| -
|-
| '''stats'''
| Battlescape stats of this unit.
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this unit uses by default.
| -
|-
| '''standHeight'''
| Height of this unit when standing.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''value'''
| [[Score]] this unit is worth.
| 0
|-
| '''deathSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit dies.
| -1
|-
| '''aggroSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit aggros.
| -1
|-
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit moves.
| -1
|-
| '''intelligence'''
| Intelligence of this unit's AI. The higher the value, the longer this unit remembers player troops between turns.
| 0
|-
| '''aggression'''
| Aggression of this unit's AI. The higher the value, the more ruthless the unit, the more likely to make a frontal assault. Less aggressive units tend to set up ambushes.
Vanilla values are:
* 0 = mostly passive
* 1 = balanced
* 2 = mostly aggresive
| 0
|-
| '''energyRecovery'''
| Energy recovered by the unit each turn (needs verification)
| 40 (?)
|-
| '''specab'''
| Special ability of this unit:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]] (Requires '''power''' and '''blastRadius''' properties to be set on the corpse)
* 2 = [[Silacoid|Burns Floor]]
* 3 = [[Bio-Drone|Burns Floor and explodes on Death]]
| 0
|-
| '''spawnUnit'''
| String ID of the unit used to respawn on death (eg. [[Zombie]]s respawn as [[Chrysallid]]s).
| -
|-
| '''livingWeapon'''
| Is this unit a living weapon? (only attacks with a '''fixedWeapon''')
| false
|-
| '''female'''
| Is this unit a female? (used for TFTD civilian types)
| false
|-
|}

=== Alien Races ===

Defines a [[Alien Life Forms|race]] used in [[Alien Missions]], listed in ''"alienRaces:"''. Heavily tied with deployment data.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the alien race name.
| ''required''
|-
| '''members'''
| Alien crew associated with this alien race (eg. race units + terrorist units), defined by a list of unit string IDs. Order here will define rank in terms of deployment. generally speaking the order is:
* 0 - Commander
* 1 - Leader
* 2 - Engineer
* 3 - Medic
* 4 - Navigator
* 5 - Soldier
* 6 - Terrorist 1
* 7 - Terrorist 2
but of course, not all races have all ranks, so the "fill in" rank would be listed multiple times (see ethereals).
| -
|-
| '''retaliation'''
| retaliation enables/disables the race for retaliation missions.
| ''True''
|-
|}

=== Alien Deployments ===

Defines a Battlescape deployment data used in [[Alien Missions]] (such as alien and map configurations), listed in ''"alienDeployments:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the deployment name.
| ''required''
|-
| '''width'''
| Width of the Battlescape map in grid units.
| 0
|-
| '''length'''
| Length of the Battlescape map in grid units.
| 0
|-
| '''height'''
| Vertical height of the Battlescape map in grid units.
| 0
|-
| '''terrains'''
| list of string IDs of the [[#Terrains|terrain]] to choose from to generate this map. This is not used for UFO sites where the terrain comes from the Geoscape.
| -
|-
| '''shade'''
| Shade of the map (0-15, where 0 is full daytime and 15 is full nighttime). This is not used for UFO sites where the shade comes from the Geoscape.
| 0
|-
| '''nextStage'''
| String ID of the next deployment stage to use after this one, for multi-stage missions.
| -
|-
| '''race'''
| Sets the race to use in the next stage.
| ""
|-
| '''script'''
| Reference to a mapScript.
| ""
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|}

Notes:
* '''terrains''' can also be used with UFOs, with the game using instead the listed terrain rather than the location of the UFO on Geoscape.
==== Deployment Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''alienRank'''
| [[Alien Rank|Rank]] associated with this deployment data, as defined by the order of the race in question (see above)
| ''required''
|-
| '''lowQty'''
| Minimum quantity of aliens to spawn on beginner/experienced.
| 0
|-
| '''highQty'''
| Minimum quantity of aliens to spawn on superhuman. (minimum quantity for veteran/genius is the median of this and the previous value)
| 0
|-
| '''dQty'''
| Delta in Quantity. ie: random number of aliens to spawn on top of the minimum (all difficulties).
| 0
|-
| '''extraQty'''
| functionally identical to dQty, spawns a random number of additional aliens.
| 0
|-
| '''percentageOutsideUfo'''
| Percentage (0-100%) of aliens to spawn outside in UFO sites.
| 0
|-
| '''itemSets'''
| Three lists (one for each alien technology level) of [[#Items|items]] (string IDs) for the aliens to equip.
| ''required''
|-
|}

=== Research ===

Defines a [[Research|research topic]] that X-COM scientists can investigate, listed in ''"research:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the research project's name (or item, if a '''lookup''' is defined).
| ''required''
|-
| '''lookup'''
| String ID of the research project's display name and UFOPaedia article reference.
| -
|-
| '''cost'''
| Number of man hours (on average) required to complete this project.
| 0
|-
| '''points'''
| [[Score]] earned for completing this project.
| 0
|-
| '''needItem'''
| Does this project require an [[#Items|item]] of the same name?
| false
|-
| '''dependencies'''
| List of research projects that can unlock access to this one. If the full list is researched, or if one of the projects on the list "unlocks" this one, it becomes available.
| -
|-
| '''unlocks'''
| List of research projects unlocked, regardless of other dependencies, but not requirements, by completing this project (for example, any live alien unlocks "alien origins").
| -
|-
| '''requires'''
| List of research projects unilaterally required before this project can be unlocked (for example, "the martian solution" will not even be considered for unlocking until AFTER "alien origins" is completed).
| -
|-
| '''getOneFree'''
| List of "bonus" research projects that may be granted when completing this project (for example, alien medics will give you information on other alien races). Used in Alien Navigators (gives random alien Mission), Medics (random alien interrogation or autopsy) or Engineers (gives UFO type).
| -
|-
|}

=== Manufacture ===

Defines a [[Manufacture|manufacture project]] that X-COM engineers can produce, listed in ''"manufacture:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the manufacturing project's name (and the item it produces).
| ''required''
|-
| '''category'''
| String ID of the manufacturing project's category.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this project. If none are specified, this project is unlocked from the start.
| -
|-
| '''space'''
| Amount of [[Workshop]] space required to begin this project.
| 0
|-
| '''time'''
| Number of man hours (on average) required per item.
| 0
|-
| '''cost'''
| Monetary deduction per item manufactured.
| 0
|-
| '''requiredItems'''
| List of [[#Items|items]] required and consumed per item manufactured.
| -
|-
| '''producedItems'''
| List of [[#Items|items]] produced per each item consumed. If not specified, defaults to 1 item with the same string ID as the manufacture.
| 1
|-
|}

=== UFOpaedia Article ===

Defines an article in the in-game [[UFOpaedia]], listed in ''"ufopaedia:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the article name. This must match the ID of the object associated with this article, if applicable.
| ''required''
|-
| '''title'''
| String ID of the article title. If omitted, the '''id''' is used.
| -
|-
| '''type_id'''
| Type of this article:
* 0 = Unknown
* 1 = [[Craft]]
* 2 = [[Craft Armaments]]
* 3 = [[HWP]]
* 4 = [[Equipment (EU)|Equipment]]
* 5 = [[Armour]]
* 6 = [[Base Facilities]]
* 7 = Text & Image (eg. [[Alien Life Forms]], [[UFO Components]])
* 8 = Text (eg. [[Alien Research]])
* 9 = [[UFO]]
* 10 = [[TFTD]]
* 11 = TFTD [[Subs]]
* 12 = TFTD [[Sub_Armaments]]
* 13 = TFTD [[Submersible_Weapons_Systems]]
* 14 = TFTD [[Equipment_(TFTD)]]
* 15 = TFTD Armour
* 16 = TFTD [[Base_Facilities_(TFTD)]]
* 17 = TFTD [[Alien_Subs]]
| 0
|-
| '''section'''
| String ID of the UFOpaedia section this article belongs in.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this article. If none are specified, this article is unlocked from the start.
| -
|-
| '''image_id'''
| Filename of the [[UP001.SPK-UP042.SPK|background image]] displayed on this article, if applicable.
| -
|-
| '''text'''
| String ID of the description displayed on this article.
| -
|-
| '''text_width'''
| Maximum width of the text displayed, only applicable to ''Text & Image'' articles.
| 150
|-
| '''rect_stats'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the stats text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''rect_text'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the description text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''weapon'''
| String ID of the weapon, only applicable to ''HWP'' articles.
| -
|}

=== UFO Trajectories ===

Defines a trajectory carried out by an UFO during an [[#Alien Missions|alien mission]], listed in ''"ufoTrajectories:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the trajectory name.
| ''required''
|-
| '''groundTimer'''
| Amount of seconds for the UFO to spend on Ground waypoints.
| 0
|-
| '''waypoints'''
| List of waypoints for the UFO to traverse, defined as ''[zone, altitude, speed]''. 
'''zone''': Globe zone where the waypoint is located. 
'''altitude''': UFO altitude after reaching this waypoint:
* 0 - Ground
* 1 - Very Low
* 2 - Low
* 3 - High
* 4 - Very High
'''speed''': UFO speed after reaching this waypoint, as a percentage (0-100%) of its maximum speed.
| -
|}

=== Alien Missions ===

Defines an [[Alien Missions|alien mission]] carried out by UFOs on the Geoscape, listed in ''"alienMissions:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the mission type.
| ''required''
|-
| '''points'''
| [[Score]] allocated to aliens for successfully completing this mission.
| 0
|-
| '''raceWeights'''
| List of alien races likely to carry out this mission, and the % chance of them being allocated to this mission, listed by "number of months after game beginning".
| ''required''
|-
| '''waves'''
| List of UFO waves to spawn as this mission progresses, as described below.
| ''required''
|}

==== Waves ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''ufo'''
| String ID of the [[#UFOs|UFO]] to spawn.
| ''required''
|-
| '''count'''
| Number of UFOs to spawn.
| 0
|-
| '''trajectory'''
| String ID of the [[#UFO Trajectories|trajectory]] for this UFO to use when entering Earth's atmosphere.
| ''required''
|-
| '''timer'''
| How long after the previous wave should this wave arrive? (in seconds)
| 0
|-
|}

=== Alien Item Levels ===

This is a list of item level probabilities, with a number between 0 and 2 representing an item level from plasma pistols to heavy plasmas, as defined in the deployments, expressing a 10% probability for that item level being used.

0 = first set (plasma pistol/clip)
1 = second set (plasma rifle/clip)
2 = third set (heavy plasma/clip)

For example:
[ 2, 0, 0, 0, 0, 0, 0, 1, 1, 1 ]
would represent a 60% chance for pistols, 30% rifles, and 10% heavy weapons. 
Note that the order does not matter, but the length DOES. each line MUST have 10 digits.

The above can be confusing. There are 10 fields; each number represents 10%. 
There are six instances of '0'. 6x10% = 60% chance of plasma pistol 
There are three instances of '1'. 3x10% = 30% chance of plasma rifle 
There is only one instance of '2'. 1x10% = 10% chance of heavy plasma 

Each line represents a month after the beginning of the game, and there is no limit to the number defined. 
OpenXCom will use the most recently available item level in the event the game goes on forever.

=== Extra Sprites ===

Adds or replaces sprites in an existing [[Image Formats|X-COM image file]], listed in ''"extraSprites:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original/new image to modify.
| ''required''
|-
| '''width'''
'''height'''
| Size of the sprite(s) in pixels.
| 0
0
|-
| '''singleImage'''
| Is the image file just a single sprite (true) or a spritesheet (false)?
| false
|-
| '''subX'''
'''subY'''
| Size of the subdivision in pixels. If a subdivision is specified, then the image file is divided into chunks to form the sprites (eg. spritesheets).
| 0
0
|-
| '''files'''
| List of the new sprites to add/replace, listed as ''spriteID: filename''.
| -
|}

Example:
- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/Bunny00.png
1: Resources/Bunny/Bunny01.bmp
2: Resources/Bunny/Bunny02.gif

=== Extra Sounds ===

Adds or replaces sounds in an existing [[SOUND|X-COM sound file]], listed in ''"extraSounds:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ID of the original sound file to modify:
* BATTLE.CAT - Battlescape sounds, corresponds to ''SOUND1.CAT'' or ''SAMPLE2.CAT'' (55 sounds).
* INTRO.CAT - Intro sounds, corresponds to ''INTRO.CAT'' or ''SAMPLE3.CAT'', probably best not to mess with these.
* GEO.CAT - Geoscape sounds, corresponds to ''SOUND2.CAT'' or ''SAMPLE.CAT'' (14 sounds).
| ''required''
|-
| '''files'''
| List of the new sounds to add/replace, listed as ''soundID: filename''.
| -
|}

Example:
- type: BATTLE.CAT
files:
55: Resources/Sounds/sample.wav

=== Extra Strings ===

Adds or replaces text strings in an existing [[Translations (OpenXcom)|OpenXcom language file]], listed in ''"extraStrings:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original language file to modify, sans extension.
| ''required''
|-
| '''strings'''
| List of the new strings to add/replace, listed as ''stringID: text''.
| -
|}

Example:
- type: en-US
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: en-GB
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: de
strings:
STR_SNIPER_RIFLE: Scharfschützengewehr
STR_SNIPER_RIFLE_CLIP: Scharfschützengewehrmunition
- type: ru
strings:
STR_SNIPER_RIFLE: Снайперская винтовка
STR_SNIPER_RIFLE_CLIP: Магазин к снайп. винтовке

=== Interfaces ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ''?''
| -
|-
| '''elements'''
| ''?''
| -
|-
| '''id'''
| ''?''
| -
|-
| '''color'''
| ''?''
| -
|}

=== StatStrings ===

[[Statstrings]] are used for automatically renaming soldiers. They are case sensitive and they are processed in the order in which they are specified.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''string'''
| String to add to name.
| ''required''
|-
| '''psiStrength''' 
'''psiSkill''' 
'''bravery''' 
'''strength''' 
'''firing''' 
'''reactions''' 
'''stamina''' 
'''tu''' 
'''health''' 
'''throwing'''
| One or more stat ranges are ANDed together for success. Each range has a minVal and maxVal. Use YAML standard tilde (~) to indicate null. ((~) = 0 as minvalue; (~) =255 as maxvalue)
| -
|}

Example:
statStrings:
- string: "x"
psiStrength: [~, 30]
- string: "P"
psiStrength: [80, ~]
- string: "p"
psiStrength: [60, 79]
- string: "K"
psiSkill: [60, ~]
- string: "k"
psiSkill: [30, 59]
- string: "b"
bravery: [60, ~]
- string: "c"
bravery: [~, 10]
- string: "w"
strength: [~, 25]
- string: "Snpr"
firing: [60, ~]
reactions: [60, ~]
- string: "M"
firing: [70, ~]
- string: "m"
firing: [60, 69]
- string: "Sct"
reactions: [50, ~]
tu: [60, ~]
- string: "R"
reactions: [60, ~]
- string: "r"
reactions: [50, 59]

==References==
<references />

[[Category:OpenXcom]]

Compiling (OpenXcom)

2015-02-04T09:51:52Z

Kkmic: /* Dependencies */ Commented out Boost as it is actually a YAML dependency

The OpenXcom codebase is hosted on [https://github.com/SupSuper/OpenXcom Github], and you can grab the latest source with any Git client from: <code>https://github.com/SupSuper/OpenXcom.git</code>

If you're a Github user you might wanna [http://help.github.com/forking 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 [http://openxcom.org/docs/html/ Doxygen documentation] available.

'''Don't forget to copy the X-Com resources to your ''bin'' folder as shown in [[Installing (OpenXcom)|Installing]].'''

== Dependencies ==

OpenXcom requires the following libraries to compile:

* [http://www.libsdl.org/ SDL] (libsdl1.2)
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
* [http://cms.ferzkopp.net/index.php/software/13-sdl-gfx SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
* [http://code.google.com/p/yaml-cpp/ yaml-cpp], (libyaml-cpp), version 0.5 or later


== Windows ==

* [[Compiling with Microsoft Visual C++ (OpenXcom)|Compiling with Microsoft Visual C++]]
* [[Compiling with MinGW (OpenXcom)|Compiling with MinGW]]

== Mac OS X ==

* [[Compiling with Xcode (OpenXcom)|Compiling with Xcode]]
* [[Compiling with brew (OpenXcom)|Compiling with brew]]

== Linux/BSD ==

* [[Compiling with Make (OpenXcom)|Compiling with Make]]
* [[Compiling with Autotools (OpenXcom)|Compiling with Autotools]]

== Misc. ==

* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
* [[Android port (OpenXcom)|Compiling for Android]]

[[Category:OpenXcom]]

Compiling (OpenXcom)

2015-01-29T13:32:01Z

Kkmic: /* Dependencies */ added boost dependency

The OpenXcom codebase is hosted on [https://github.com/SupSuper/OpenXcom Github], and you can grab the latest source with any Git client from: <code>https://github.com/SupSuper/OpenXcom.git</code>

If you're a Github user you might wanna [http://help.github.com/forking 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 [http://openxcom.org/docs/html/ Doxygen documentation] available.

'''Don't forget to copy the X-Com resources to your ''bin'' folder as shown in [[Installing (OpenXcom)|Installing]].'''

== Dependencies ==

OpenXcom requires the following libraries to compile:

* [http://www.libsdl.org/ SDL] (libsdl1.2)
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
* [http://cms.ferzkopp.net/index.php/software/13-sdl-gfx SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
* [http://code.google.com/p/yaml-cpp/ yaml-cpp], (libyaml-cpp), version 0.5 or later
* [http://www.boost.org/ Boost], (boost)

== Windows ==

* [[Compiling with Microsoft Visual C++ (OpenXcom)|Compiling with Microsoft Visual C++]]
* [[Compiling with MinGW (OpenXcom)|Compiling with MinGW]]

== Mac OS X ==

* [[Compiling with Xcode (OpenXcom)|Compiling with Xcode]]
* [[Compiling with brew (OpenXcom)|Compiling with brew]]

== Linux/BSD ==

* [[Compiling with Make (OpenXcom)|Compiling with Make]]
* [[Compiling with Autotools (OpenXcom)|Compiling with Autotools]]

== Misc. ==

* [[Compiling with CMake (OpenXcom)|Compiling with CMake]]
* [[Android port (OpenXcom)|Compiling for Android]]

[[Category:OpenXcom]]

Differences to X-COM (OpenXcom)

2014-12-11T16:33:06Z

Kkmic: /* Geoscape */ typo

OpenXcom is modelled after the original [[X-COM]] and enhances the game experience dramatically. Many features were inspired by [[UFO Extender]] and [[XcomUtil]] while others are original.

== General ==
* None of [[Known Bugs|these bugs or limits]].
* Cross-platform.
* Mouse wheel support.
* Caret for text editing.
* No CPU-based speed (animations play at a constant speed regardless of the computer).
* Mouse input works like modern systems.
* Human-readable savegame format.
* Quicksave/Quickload feature.
* Autosaves and Ironman mode.
* No savegame limit.
* Painless customizability with modular rulesets in human-readable format.
* Full Unicode support.
* Localized in many more languages.
* Take screenshots in-game.
* Standalone "Skirmish" style custom Battlescape mission generator.
* Customizable keyboard shortcuts.
* Native support for in-game music in many different file formats (including OGG, MP3, etc.)
* Customizable display and audio options.
* A built-in and extendable selection of optional display filters.
* Various gameplay options, including [[XcomUtil]] and [[UFO Extender]] features.
* Corrected erroneous text and descriptions.
* Various UI and quality-of-life enhancements like sliders, scrollbars, etc.
* Melee stat shown in the unit stat page.

== Geoscape ==
* Since there's no 80 item limit, items in crafts count towards your [[Base Stores]] to prevent exploiting infinite storage. This also lets you freely move items between bases and crafts without storage issues.
* Each radar facility contributes to the detection check, so having multiple [[Small Radar System]]s and/or [[Large Radar System]]s ''does'' improve your chances. The [[Hyperwave Decoder]] still makes all other facilities obsolete though since it has a 100% detection chance.
* The aircraft phase order when returning to base is: [[Repairs|Repairing]], [[Rearming]], [[Refueling]].
* Purchase/Recruit screens have a column for current storage.
* Aircraft weapons may be unequipped.
* You should hire personal and rent ships at the beginning of a month rather than at the end, because in OpenXcom you pay a salary for those who are in transit, and this includes the ones that you just hired.
* Can cancel out of selecting armor for soldiers.
* Selling aircraft automatically unequips all their contents.
* No gap in Australasia zone.
* Soldiers can be reordered in aircraft.
* Soldier equipment is saved for each soldier and restored as possible before mission.
* Aircraft can be renamed.
* Globe can show radar coverage and flight paths.
* Potential radar coverage will be displayed when placing a new base.
* Aircraft will use proper great circle calculations when travelling so they'll always take the shortest path along the globe.
* Aircraft have better fuel calculation so they will always travel the maximum their fuel supply will allow.
* Night/Day line is dithered slightly.
* UFOPaedia articles regarding Aircraft weapons have flavour text (unused strings that existed in the original were implemented).
* Manufactured items can be automatically sold directly, bypassing the stores.
* Can set manufacture to produce infinite items.
* Can jump to a craft from the Intercept screen.
* Can jump to a base from a "X complete" message.

== Battlescape ==
* Objects, fire and smoke keeps animating while walking or scrolling the screen.
* Pathfinding is a different algorithm: it will always find a solution, if there is one, no matter how difficult.
* AI of aliens is more cunning - Impossible to 100% exactly mimic original AI.
* Waypoint-based projectiles have no upward limit on the number of waypoints they may use.
* The inventories of mind controlled, non-terrorist aliens may be accessed.
* Can use special abilities of mind-controlled aliens.
* The limit on units has been removed, allowing 23 or more soldiers to assault alien bases.
* Unit spawning function has been improved - no more large units stuck in walls.
* Units holding two single-handed weapons will have the fact represented on their sprite.
* Soldier sprites will have their hair and skin recolored to represent their race.
* Can cancel out enemy's mind-control with your own.
* "Not enough equipment" screen shows items missing.
* At the end of the mission, ammo from clips is totalled, so you only lose enough clips to match the total ammo used (as opposed to losing any used clip).
* Soldier equipment loadouts are automatically saved.
* Soldier rank and stats accessible from inventory.
* Can load game from Battlescape.
* Right-click opens doors.
* Right-click will cancel a unit's movement, and will cause projectiles to "skip" their flight paths, instantly hitting their target.
* Possibility to use "force fire" when no line of sight is available. (CTRL + Left Mouse Button for firing)
* Tooltips on Battlescape buttons.
* Melee stat is used for melee attacks, except for Stun Rods.

== Optional features ==
While the above differences are hardcoded, there are also various new "non-vanilla" features you can choose to enable, such as gameplay features and keyboard shortcuts. See the [[Options (OpenXcom)|Options]] section for more information.

[[Category:OpenXcom]]

MCDEdit

2014-10-10T10:14:41Z

Kkmic: /* Technical */ updated wine link to point to the Wine homepage instead of it's Wikipedia page

''Disclamer: This page is dedicated not to the great old [http://www.strategycore.co.uk/files/mcdedit/ MCDView (MCDEdit) tool by Koralt] ([http://openxcommods.weebly.com/mcdedit.html manual]), but for another one, written by [[User:Volutar|Volutar]] for [[OpenXcom]], though still suitable for xcom1/2.''

= MCD Edit tool =
The application title bar shows which file is opened, whether it is vanilla or custom, and in custom mode, the path to the file.

Tilesets in xcom1/2 consist of 3 files with the same name and different extensions. [[MCD]] is the main file with values and references to images. [[Image_Formats|PCK+TAB]] are the files of sprite images. The number of tiles in the MCD is not necessary equal to the number of images in the PCKs. If there are animated tiles, the number of PCK entries will be more than number of MCDs. In some tilesets, single PCK images are reused in several MCDs, but with different heights.

== Main screen ==
[[File:Mcdedit_113.png|400px|thumb|right|Main screen]]

* '''Custom''' button opens custom MCD set (tileset automatically fetches all *.mcd files from specified folder) - same as ''File->Open custom MCD ...''. If you open an MCD from the vanilla folder (as defined in the config file) - it will switch to vanilla mode.
* '''Tileset''' switches between different MCDs in the folder. Don't forget to save the current MCD if you don't want to lose your work (''File->Save MCD+PCK+TAB'' or ''File->Save MCD+PCK+TAB as...''. The '*' sign indicates it's a vanilla MCD, and you will not be able to change the number of MCDs in the file, this is in order to prevent breaking the vanilla maps.
* '''Checkered''' button changes the image background from black (or underwater background) to checkered, just to highlight any holes you've made. Kinda handy when dealing with dark sprites.
* '''UFO/TFTD''' changes gametype. Vanilla mode will switch between game folders and re-read '''Tilesets'''. In '''custom MCD''' mode it will simply change associated [[LOFTEMPS|LOFT]] and [[SCANG.DAT|SCANg]] (and will treat tiles as of another game type). It doesn't affect anything else.
* '''Palette''' dropdown menu changes the current palette. The current palette is displayed at the right top corner. Ambiguous color entries in the palette will be highlighted (different indexes but same RGB) - these colors could cause problems when working with RGB graphics (not indexed). [http://mtpaint.sourceforge.net/ mtPaint] is a recommended free tool to edit paletted png files in indexed mode.
* '''Edit PCKs''' opens [[#PCK_list|PCK list]] window from which you can manipulate with PCKs.

At the top of the main area is the MCD preview/selection line with the bar. Yellow highlighted MCDs are animated. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD. '''RMB''' calls the context menu for the clicked MCD (''Copy MCD / Paste MCD / Insert MCD / Add MCD / Delete MCD / Clear MCD'') - same as in the '''Edit''' menu. If you are not allowed to change the number of MCDs (ie: in vanilla mode) these menu entries will be greyed out.

Below are 16 small images showing the different light levels of the tile (so you can preview how will it look). '''LMB''' on these small shaded sprites toggles animation mode (off by default).

Slightly lower is the stipe with the 8 zoomed animation frames of this tile (if MCD is not animated - all of them are the same). '''LMB''' on a particular image opens the '''PCK selection''' screen. RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

At the right of them is the animated zoomed tile and a voxelized 3D representation. Hold '''LMB''' to rotate the voxel view (after release it will switch back to the center). The small bar below changes view angle permanently. Remember: it alters only view angle.

The rightmost part is the heap of voxel slices or [[LOFTEMPS|LOFTs]]. '''LMB''' click on particular layer image to open LOFT sheet and change it.

The bottom part is the main MCD fields editor. When editing a field, a description shows in the box at the right. '''Tab'''/'''Shift+Tab''' jumps between fields.

The status bar at the bottom shows current PCK file size (in bytes), TAB (in number of records, or PCK images), LOFTemps size (in images), and SCANGs (also in images). The last two are fixed for each particular game type.

[[SCANG.DAT|SCANg]] icon is clickable and opens the minimap image selection.

You can also create the new tileset (MCD+PCK+TAB) by clicking ''File->New MCD''. It will ask you for the path and filename for the new MCD, and if it is in a vanilla folder - it will automatically switch into the respective game mode/palette.

== PCK list ==
[[File:Mcdedit_pck.png|300px|thumb|right|PCK list]]
Besides selecting PCK images you can also manipulate the PCK sheet, associated with the current MCD.

'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy as TXT / Paste as TXT / Export PCK / Import PCK / Delete PCK / Insert PCK / Export PNG sheet / Import PNG sheet'').

Single PCKs are exported as png images at 32x40 resolution, 8bit color (with current palette). Color 0 is "invisible".
When importing an image to a PCK, it takes the top-left 32x40 pixels, everything else will be ignored.

It can import RGB+alpha PNG files. If the alpha is greater than 128, it assumes this pixel is invisible, even if there are color components - Xcom uses binary transparency. Other color RGB values are taken from the closest matching color of the current palette, excluding system parts. Colors 254/255 can't be used because they are used for PCK encoding. For TFTD palettes it also don't use colors of group 9 (144..159) and colors below 16 - they are treated as system thus also not used.

If it's a paletted PNG, and the palette isn't changed, and matches the current selection - it keeps every pixel index intact (it won't re-convert and won't add ambiguity). But if it's PCK of TFTD, it won't allow import of system colors (groups 9 and 0) - it will replace these indexes with closest allowed versions.

If even a single color is changed, or doesn't match the current palette, it treats it as a "different" palette, and re-converts whole image as if it's RGB+alpha.

PNG sheets are exported and imported as consisting of sprites with 32x40 size (without any spacing). The image itself can be of any size, it just runs from the top to the bottom, from the left to the right, if the sprite can't fit in the rightmost part it just skips it. Last empty images (at the tail of the sheet) are ignored.

It won't allow import of more than 256 images (because MCD uses 8bit value for PCK reference).

== PCK editor ==
[[File:mcdedit_pckedit.png|300px|thumb|right|PCK edit]]
Embedded PCK editor is a new part of MCD editor which allows you to edit 8bit PCK images without the need to use another image editor, in order to reduce any incompatibilities or palette mishandling.

At the top there's a toolbar where you can '''save changes''' (they will immedately reflect in other screens).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: checkered background, regular grid, isometric template, and wrap scrolling.

Palette selector also presents (though you can't change its value with mouse wheel or cursor keys).

Top part of the palette is the current Foreground ('''LMB''') and Background ('''RMB''') colors (with hex and decimal index values).

Palette selector works as color picker for both '''LMB''' and '''RMB'''. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within this sprite.

Below are preview of the sprite (2x zoomed and 2x2 adjacently tiled).

The bottommost right part is the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Esc'' - deselect all.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' over selected pixels move selected area. Also affected by '''Wrap scrolling'''.
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from PCK selection screen.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), or ''Alt'' to subtract from the selection (cursor gets '-' sign). Without these modifiers selection just renews.

====Drawing mode====
''Alt'' key switches into color picker/highlighter mode, '''LMB''' and '''RMB''' are respectively changes colors assiciated with those mouse keys. Same modifier key marks all pixels of same color index. In palette selector ''Color picker'' works without ''Alt'' pressed.

Pixels are drawn with '''LMB''' and '''RMB''' of respective colors. It works in "smart" drawing mode, when diagonally "touched" neighbour pixels aren't changed (as is often a problem with pixel-based editors).

When an area is selected, drawing is limited to within its borders (drawing outside of selection is simply ignored).

== MCDEdit.txt ==
The config file contains paths to the game folders for '''ufo''' and '''tftd''' and optionally folders for "alternative" versions.

Setting alternative folders switches MCDEdit into ''compare mode'' - if MCD values are different, they will be shown at the right of the current values in red.

Also it contains information about editable MCD fields (index, name, type, help text). If you want to clarify help/field names - you can do that any time, and feel free to share the config.

''boxpat'' entries are defining "isometric template", you can modify it if you want.

= Download =
Current version 1.16b (2014-09-18) ([http://volutar.eu5.org/_mcdedit116b.7z download])

= Technical =
MCD Edit is a Windows based application. Designed to run natively on x64 systems, it is written using Borland Pascal, and can be easily run on other platforms using [https://www.winehq.org/ Wine] (or a similar tool).

[[Category:Enemy Unknown/UFO Defense]]
[[Category:TFTD]]
[[Category:OpenXcom]]

MCDEdit

2014-10-01T09:20:16Z

Kkmic: Moved misc section

''Disclamer: This page is dedicated not to the great old [http://www.strategycore.co.uk/files/mcdedit/ MCDView (MCDEdit) tool by Koralt] ([http://openxcommods.weebly.com/mcdedit.html manual]), but for another one, written by [[User:Volutar|Volutar]] for [[OpenXcom]], though still suitable for xcom1/2.''

= MCD Edit tool =
The application title bar shows which file is opened, whether it is vanilla or custom, and in custom mode, the path to the file.

Tilesets in xcom1/2 consist of 3 files with the same name and different extensions. [[MCD]] is the main file with values and references to images. [[Image_Formats|PCK+TAB]] are the files of sprite images. The number of tiles in the MCD is not necessary equal to the number of images in the PCKs. If there are animated tiles, the number of PCK entries will be more than number of MCDs. In some tilesets, single PCK images are reused in several MCDs, but with different heights.

== Main screen ==
[[File:Mcdedit_113.png|400px|thumb|right|Main screen]]

* '''Custom''' button opens custom MCD set (tileset automatically fetches all *.mcd files from specified folder) - same as ''File->Open custom MCD ...''. If you open an MCD from the vanilla folder (as defined in the config file) - it will switch to vanilla mode.
* '''Tileset''' switches between different MCDs in the folder. Don't forget to save the current MCD if you don't want to lose your work (''File->Save MCD+PCK+TAB'' or ''File->Save MCD+PCK+TAB as...''. The '*' sign indicates it's a vanilla MCD, and you will not be able to change the number of MCDs in the file, this is in order to prevent breaking the vanilla maps.
* '''Checkered''' button changes the image background from black (or underwater background) to checkered, just to highlight any holes you've made. Kinda handy when dealing with dark sprites.
* '''UFO/TFTD''' changes gametype. Vanilla mode will switch between game folders and re-read '''Tilesets'''. In '''custom MCD''' mode it will simply change associated [[LOFTEMPS|LOFT]] and [[SCANG.DAT|SCANg]] (and will treat tiles as of another game type). It doesn't affect anything else.
* '''Palette''' dropdown menu changes the current palette. The current palette is displayed at the right top corner. Ambiguous color entries in the palette will be highlighted (different indexes but same RGB) - these colors could cause problems when working with RGB graphics (not indexed). [http://mtpaint.sourceforge.net/ mtPaint] is a recommended free tool to edit paletted png files in indexed mode.
* '''Edit PCKs''' opens [[#PCK_list|PCK list]] window from which you can manipulate with PCKs.

At the top of the main area is the MCD preview/selection line with the bar. Yellow highlighted MCDs are animated. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD. '''RMB''' calls the context menu for the clicked MCD (''Copy MCD / Paste MCD / Insert MCD / Add MCD / Delete MCD / Clear MCD'') - same as in the '''Edit''' menu. If you are not allowed to change the number of MCDs (ie: in vanilla mode) these menu entries will be greyed out.

Below are 16 small images showing the different light levels of the tile (so you can preview how will it look). '''LMB''' on these small shaded sprites toggles animation mode (off by default).

Slightly lower is the stipe with the 8 zoomed animation frames of this tile (if MCD is not animated - all of them are the same). '''LMB''' on a particular image opens the '''PCK selection''' screen. RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

At the right of them is the animated zoomed tile and a voxelized 3D representation. Hold '''LMB''' to rotate the voxel view (after release it will switch back to the center). The small bar below changes view angle permanently. Remember: it alters only view angle.

The rightmost part is the heap of voxel slices or [[LOFTEMPS|LOFTs]]. '''LMB''' click on particular layer image to open LOFT sheet and change it.

The bottom part is the main MCD fields editor. When editing a field, a description shows in the box at the right. '''Tab'''/'''Shift+Tab''' jumps between fields.

The status bar at the bottom shows current PCK file size (in bytes), TAB (in number of records, or PCK images), LOFTemps size (in images), and SCANGs (also in images). The last two are fixed for each particular game type.

[[SCANG.DAT|SCANg]] icon is clickable and opens the minimap image selection.

You can also create the new tileset (MCD+PCK+TAB) by clicking ''File->New MCD''. It will ask you for the path and filename for the new MCD, and if it is in a vanilla folder - it will automatically switch into the respective game mode/palette.

== PCK list ==
[[File:Mcdedit_pck.png|300px|thumb|right|PCK list]]
Besides selecting PCK images you can also manipulate the PCK sheet, associated with the current MCD.

'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy as TXT / Paste as TXT / Export PCK / Import PCK / Delete PCK / Insert PCK / Export PNG sheet / Import PNG sheet'').

Single PCKs are exported as png images at 32x40 resolution, 8bit color (with current palette). Color 0 is "invisible".
When importing an image to a PCK, it takes the top-left 32x40 pixels, everything else will be ignored.

It can import RGB+alpha PNG files. If the alpha is greater than 128, it assumes this pixel is invisible, even if there are color components - Xcom uses binary transparency. Other color RGB values are taken from the closest matching color of the current palette, excluding system parts. Colors 254/255 can't be used because they are used for PCK encoding. For TFTD palettes it also don't use colors of group 9 (144..159) and colors below 16 - they are treated as system thus also not used.

If it's a paletted PNG, and the palette isn't changed, and matches the current selection - it keeps every pixel index intact (it won't re-convert and won't add ambiguity). But if it's PCK of TFTD, it won't allow import of system colors (groups 9 and 0) - it will replace these indexes with closest allowed versions.

If even a single color is changed, or doesn't match the current palette, it treats it as a "different" palette, and re-converts whole image as if it's RGB+alpha.

PNG sheets are exported and imported as consisting of sprites with 32x40 size (without any spacing). The image itself can be of any size, it just runs from the top to the bottom, from the left to the right, if the sprite can't fit in the rightmost part it just skips it. Last empty images (at the tail of the sheet) are ignored.

It won't allow import of more than 256 images (because MCD uses 8bit value for PCK reference).

== PCK editor ==
[[File:mcdedit_pckedit.png|300px|thumb|right|PCK edit]]
Embedded PCK editor is a new part of MCD editor which allows you to edit 8bit PCK images without the need to use another image editor, in order to reduce any incompatibilities or palette mishandling.

At the top there's a toolbar where you can '''save changes''' (they will immedately reflect in other screens).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: checkered background, regular grid, isometric template, and wrap scrolling.

Palette selector also presents (though you can't change its value with mouse wheel or cursor keys).

Top part of the palette is the current Foreground ('''LMB''') and Background ('''RMB''') colors (with hex and decimal index values).

Palette selector works as color picker for both '''LMB''' and '''RMB'''. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within this sprite.

Below are preview of the sprite (2x zoomed and 2x2 adjacently tiled).

The bottommost right part is the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Esc'' - deselect all.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' over selected pixels move selected area. Also affected by '''Wrap scrolling'''.
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from PCK selection screen.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), or ''Alt'' to subtract from the selection (cursor gets '-' sign). Without these modifiers selection just renews.

====Drawing mode====
''Alt'' key switches into color picker/highlighter mode, '''LMB''' and '''RMB''' are respectively changes colors assiciated with those mouse keys. Same modifier key marks all pixels of same color index. In palette selector ''Color picker'' works without ''Alt'' pressed.

Pixels are drawn with '''LMB''' and '''RMB''' of respective colors. It works in "smart" drawing mode, when diagonally "touched" neighbour pixels aren't changed (as is often a problem with pixel-based editors).

When an area is selected, drawing is limited to within its borders (drawing outside of selection is simply ignored).

== MCDEdit.txt ==
The config file contains paths to the game folders for '''ufo''' and '''tftd''' and optionally folders for "alternative" versions.

Setting alternative folders switches MCDEdit into ''compare mode'' - if MCD values are different, they will be shown at the right of the current values in red.

Also it contains information about editable MCD fields (index, name, type, help text). If you want to clarify help/field names - you can do that any time, and feel free to share the config.

''boxpat'' entries are defining "isometric template", you can modify it if you want.

= Download =
Current version 1.16b (2014-09-18) ([http://volutar.eu5.org/_mcdedit116b.7z download])

= Technical =
MCD Edit is a Windows based application. Designed to run natively on x64 systems, it is written using Borland Pascal, and can be easily run on other platforms using [https://en.wikipedia.org/wiki/Wine_%28software%29 Wine] (or a similar tool).

[[Category:Enemy Unknown/UFO Defense]]
[[Category:TFTD]]
[[Category:OpenXcom]]

MCDEdit

2014-10-01T07:14:13Z

Kkmic: Added proper tool credit and a short technical description

''Disclamer: This page is dedicated not to the great old [http://www.strategycore.co.uk/files/mcdedit/ MCDView (MCDEdit) tool by Koralt] ([http://openxcommods.weebly.com/mcdedit.html manual]), but for another one, written by [[User:Volutar|Volutar]] for [[OpenXcom]], though still suitable for xcom1/2.''
= Technical =
MCD Edit is a Windows based application. Designed to run natively on x64 systems, it is written using Borland Pascal, and can be easily run on other platforms using [https://en.wikipedia.org/wiki/Wine_%28software%29 Wine] (or a similar tool).

= MCD Edit tool =
The application title bar shows which file is opened, whether it is vanilla or custom, and in custom mode, the path to the file.

Tilesets in xcom1/2 consist of 3 files with the same name and different extensions. [[MCD]] is the main file with values and references to images. [[Image_Formats|PCK+TAB]] are the files of sprite images. The number of tiles in the MCD is not necessary equal to the number of images in the PCKs. If there are animated tiles, the number of PCK entries will be more than number of MCDs. In some tilesets, single PCK images are reused in several MCDs, but with different heights.

== Main screen ==
[[File:Mcdedit_113.png|400px|thumb|right|Main screen]]

* '''Custom''' button opens custom MCD set (tileset automatically fetches all *.mcd files from specified folder) - same as ''File->Open custom MCD ...''. If you open an MCD from the vanilla folder (as defined in the config file) - it will switch to vanilla mode.
* '''Tileset''' switches between different MCDs in the folder. Don't forget to save the current MCD if you don't want to lose your work (''File->Save MCD+PCK+TAB'' or ''File->Save MCD+PCK+TAB as...''. The '*' sign indicates it's a vanilla MCD, and you will not be able to change the number of MCDs in the file, this is in order to prevent breaking the vanilla maps.
* '''Checkered''' button changes the image background from black (or underwater background) to checkered, just to highlight any holes you've made. Kinda handy when dealing with dark sprites.
* '''UFO/TFTD''' changes gametype. Vanilla mode will switch between game folders and re-read '''Tilesets'''. In '''custom MCD''' mode it will simply change associated [[LOFTEMPS|LOFT]] and [[SCANG.DAT|SCANg]] (and will treat tiles as of another game type). It doesn't affect anything else.
* '''Palette''' dropdown menu changes the current palette. The current palette is displayed at the right top corner. Ambiguous color entries in the palette will be highlighted (different indexes but same RGB) - these colors could cause problems when working with RGB graphics (not indexed). [http://mtpaint.sourceforge.net/ mtPaint] is a recommended free tool to edit paletted png files in indexed mode.
* '''Edit PCKs''' opens [[#PCK_list|PCK list]] window from which you can manipulate with PCKs.

At the top of the main area is the MCD preview/selection line with the bar. Yellow highlighted MCDs are animated. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD. '''RMB''' calls the context menu for the clicked MCD (''Copy MCD / Paste MCD / Insert MCD / Add MCD / Delete MCD / Clear MCD'') - same as in the '''Edit''' menu. If you are not allowed to change the number of MCDs (ie: in vanilla mode) these menu entries will be greyed out.

Below are 16 small images showing the different light levels of the tile (so you can preview how will it look). '''LMB''' on these small shaded sprites toggles animation mode (off by default).

Slightly lower is the stipe with the 8 zoomed animation frames of this tile (if MCD is not animated - all of them are the same). '''LMB''' on a particular image opens the '''PCK selection''' screen. RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

At the right of them is the animated zoomed tile and a voxelized 3D representation. Hold '''LMB''' to rotate the voxel view (after release it will switch back to the center). The small bar below changes view angle permanently. Remember: it alters only view angle.

The rightmost part is the heap of voxel slices or [[LOFTEMPS|LOFTs]]. '''LMB''' click on particular layer image to open LOFT sheet and change it.

The bottom part is the main MCD fields editor. When editing a field, a description shows in the box at the right. '''Tab'''/'''Shift+Tab''' jumps between fields.

The status bar at the bottom shows current PCK file size (in bytes), TAB (in number of records, or PCK images), LOFTemps size (in images), and SCANGs (also in images). The last two are fixed for each particular game type.

[[SCANG.DAT|SCANg]] icon is clickable and opens the minimap image selection.

You can also create the new tileset (MCD+PCK+TAB) by clicking ''File->New MCD''. It will ask you for the path and filename for the new MCD, and if it is in a vanilla folder - it will automatically switch into the respective game mode/palette.

== PCK list ==
[[File:Mcdedit_pck.png|300px|thumb|right|PCK list]]
Besides selecting PCK images you can also manipulate the PCK sheet, associated with the current MCD.

'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy as TXT / Paste as TXT / Export PCK / Import PCK / Delete PCK / Insert PCK / Export PNG sheet / Import PNG sheet'').

Single PCKs are exported as png images at 32x40 resolution, 8bit color (with current palette). Color 0 is "invisible".
When importing an image to a PCK, it takes the top-left 32x40 pixels, everything else will be ignored.

It can import RGB+alpha PNG files. If the alpha is greater than 128, it assumes this pixel is invisible, even if there are color components - Xcom uses binary transparency. Other color RGB values are taken from the closest matching color of the current palette, excluding system parts. Colors 254/255 can't be used because they are used for PCK encoding. For TFTD palettes it also don't use colors of group 9 (144..159) and colors below 16 - they are treated as system thus also not used.

If it's a paletted PNG, and the palette isn't changed, and matches the current selection - it keeps every pixel index intact (it won't re-convert and won't add ambiguity). But if it's PCK of TFTD, it won't allow import of system colors (groups 9 and 0) - it will replace these indexes with closest allowed versions.

If even a single color is changed, or doesn't match the current palette, it treats it as a "different" palette, and re-converts whole image as if it's RGB+alpha.

PNG sheets are exported and imported as consisting of sprites with 32x40 size (without any spacing). The image itself can be of any size, it just runs from the top to the bottom, from the left to the right, if the sprite can't fit in the rightmost part it just skips it. Last empty images (at the tail of the sheet) are ignored.

It won't allow import of more than 256 images (because MCD uses 8bit value for PCK reference).

== PCK editor ==
[[File:mcdedit_pckedit.png|300px|thumb|right|PCK edit]]
Embedded PCK editor is a new part of MCD editor which allows you to edit 8bit PCK images without the need to use another image editor, in order to reduce any incompatibilities or palette mishandling.

At the top there's a toolbar where you can '''save changes''' (they will immedately reflect in other screens).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: checkered background, regular grid, isometric template, and wrap scrolling.

Palette selector also presents (though you can't change its value with mouse wheel or cursor keys).

Top part of the palette is the current Foreground ('''LMB''') and Background ('''RMB''') colors (with hex and decimal index values).

Palette selector works as color picker for both '''LMB''' and '''RMB'''. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within this sprite.

Below are preview of the sprite (2x zoomed and 2x2 adjacently tiled).

The bottommost right part is the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Esc'' - deselect all.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' over selected pixels move selected area. Also affected by '''Wrap scrolling'''.
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from PCK selection screen.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), or ''Alt'' to subtract from the selection (cursor gets '-' sign). Without these modifiers selection just renews.

====Drawing mode====
''Alt'' key switches into color picker/highlighter mode, '''LMB''' and '''RMB''' are respectively changes colors assiciated with those mouse keys. Same modifier key marks all pixels of same color index. In palette selector ''Color picker'' works without ''Alt'' pressed.

Pixels are drawn with '''LMB''' and '''RMB''' of respective colors. It works in "smart" drawing mode, when diagonally "touched" neighbour pixels aren't changed (as is often a problem with pixel-based editors).

When an area is selected, drawing is limited to within its borders (drawing outside of selection is simply ignored).

== MCDEdit.txt ==
The config file contains paths to the game folders for '''ufo''' and '''tftd''' and optionally folders for "alternative" versions.

Setting alternative folders switches MCDEdit into ''compare mode'' - if MCD values are different, they will be shown at the right of the current values in red.

Also it contains information about editable MCD fields (index, name, type, help text). If you want to clarify help/field names - you can do that any time, and feel free to share the config.

''boxpat'' entries are defining "isometric template", you can modify it if you want.

= Download =
Current version 1.16b (2014-09-18) ([http://volutar.eu5.org/_mcdedit116b.7z download])

[[Category:Enemy Unknown/UFO Defense]]
[[Category:TFTD]]
[[Category:OpenXcom]]

Ruleset Reference (OpenXcom)

2014-09-05T07:01:24Z

Kkmic: /* AI Units (Aliens/Civilians) */ Some aggression clarification

A reference of all the customizable values of everything in a [[Rulesets (OpenXcom)|ruleset]]. Some guidelines:
* If a value is omitted from the ruleset, the default is used. You cannot omit ''required'' values.
* Text strings (eg. names) are represented by string IDs from the [[Translations (OpenXcom)|language files]]
* Numerical IDs (used for sprites, sounds, etc.) start at 0, not 1.
* Boolean (yes/no) values are represented by true/false.
* World coordinates are represented in degrees (see [[WORLD.DAT]]).
* Money amounts (prices, costs, etc.) are represented in dollars.
* All paths are '''case sensitive'''! If your ruleset uses external files, make sure that they named properly as described in ruleset.

Items are ordered as they come in the ruleset. To override this, you can specify a ''listOrder''. You can find the default listOrders in [[Ruleset List Order (OpenXcom)|Ruleset List Order]].

=== Globe ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''data'''
| ''path name of ?.''
| ''required''
|-
| '''polylines'''
| ''?''
| -
|}

=== Countries ===

Defines one of the [[Country Funding (EU)|funding nations]], listed in ''"countries:"''. They're used for activity graphs and player scoring.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the country name.
| ''required''
|-
| '''fundingBase'''
| Country's base funding, in thousands. The starting funding can be anywhere between 1x and 2x the base funding.
| 0
|-
| '''fundingCap'''
| Country's funding cap, in thousands. Once a country reaches this maximum, it will no longer increase its funding.
| 0
|-
| '''labelLon'''
'''labelLat'''
| Longitude and latitude coordinates of the country's label on the globe. This label is only shown when the globe is zoomed in and "detail" is turned on.
| 0.0
0.0
|-
| '''areas'''
| List of "rectangles" on the globe defined as [''lon1'' ''lat1'' ''lon2'' ''lat2'']. Any activity within these areas counts towards the country's graph activity and affects their opinion of the player.
| -
|}

=== Regions ===

Defines one of the [[Geoscape (EU)#World Regions/Countries|world regions]], listed in ''"regions:"''. They're used for base placement, activity graphs and mission spawning.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the region name.
| ''required''
|-
| '''cost'''
| Amount of money spent building an X-COM base in this region (first base is free).
| 0
|-
| '''areas'''
| List of "rectangles" on the globe defined as ''[lon1, lat1, lon2, lat2]''. Any activity within these areas counts towards the region's graph activity.
| -
|-
| '''cities'''
| List of cities belonging to this region. They will be displayed on the globe and used for terror site missions. Each city is defined by their '''lon''' and '''lat''' coordinates and a '''name''' string ID.
| -
|-
| '''regionWeight'''
| Weight of this region when selecting regions for alien missions.
| 0
|-
| '''missionWeights'''
| Weighted list of the different mission types for this region (eg. ''STR_ALIEN_RESEARCH: 14'').
| -
|-
| '''missionZones'''
| List of "rectangles" (''[lon1, lat1, lon2, lat2]'') defining the mission zones for this region.
| -
|-
| '''missionRegion'''
| Spawn mission in this region instead (used for regions without land).
| -
|}

=== Base Facilities ===

Defines one of the [[Base Facilities (EU)|facilities]] that can be built in an X-COM base, listed in ''"facilities:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the facility name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this facility. If none are specified, this facility is unlocked from the start.
| -
|-
| '''spriteShape'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's outer shape in the Basescape and UFOpaedia.
| -1
|-
| '''spriteFacility'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the facility's contents in the Basescape and UFOpaedia. Drawn on top of '''spriteShape'''.
| -1
|-
| '''lift'''
| Is this facility an [[Access Lift]]? All base facilities must be connected to the lift.
| false
|-
| '''hyper'''
| Is this facility a [[Hyperwave Decoder]]? Displays extra information for detected UFOs. Only valid for radar facilities.
| false
|-
| '''mind'''
| Is this facility a [[Mind Shield]]? Reduces the chance of UFOs finding your base. Does not stack.
| false
|-
| '''grav'''
| Is this facility a [[Grav Shield]]? Doubles the power of your base defenses. Does not stack.
| false
|-
| '''size'''
| Size of the facility, in grid units. Every facility is square, so a size of 1 means 1x1, 2 means 2x2, etc. Bigger facilities are made up of multiple sprites, for example a 2x2 facility will use 4 sprites for '''spriteShape''' and 4 sprites for '''spriteFacility''' (top-left, top-right, bottom-left, bottom-right).
| 1
|-
| '''buildCost'''
| Amount of money spent to build this facility in the base.
| 0
|-
| '''buildTime'''
| Amount of days it takes for this facility to be built.
| 0
|-
| '''monthlyCost'''
| Amount of money spent monthly for the maintenance of this facility.
| 0
|-
| '''storage'''
| Amount of storage space (for items) this facility provides. See [[Base Stores]].
| 0
|-
| '''personnel'''
| Amount of personnel (soldiers, scientsts, engineers) these quarters can contain.
| 0
|-
| '''aliens'''
| Amount of live aliens this facility can contain. Only checked if the ''alienContainmentLimitEnforced'' option is enabled.
| 0
|-
| '''crafts'''
| Amount of X-COM craft this facility can contain.
| 0
|-
| '''labs'''
| Amount of lab space this facility provides for research projects.
| 0
|-
| '''workshops'''
| Amount of workshop space this facility provides for manufacture projects.
| 0
|-
| '''psiLabs'''
| Amount of soldier space this facility provides for psionic training.
| 0
|-
| '''radarRange'''
| Maximum radar detection range of this facility, in nautical miles.
| 0
|-
| '''radarChance'''
| Chance (0-100%) of this radar detecting a UFO that enters its range.
| 0
|-
| '''defense'''
| Offensive power provided by this base defense against attacking UFOs.
| 0
|-
| '''hitRatio'''
| Chance (0-100) of the base defense hitting an attacking UFO.
| 0
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when the base defense hits a target.
| -1
|-
| '''mapName'''
| [[MAPS|Map]] associated to this facility in Battlescape base defenses.
| -
|-
|}

=== Crafts ===

Defines one of the [[Craft|X-COM crafts]] that go on interception missions, listed in ''"crafts:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the craft name.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this craft. If none are specified, this craft is unlocked from the start.
| -
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw this craft in the Basescape and from [[INTICON.PCK]] used to draw the damage indicator in dogfights.
modders: the corresponding extrasprite file id for BASEBITS.PCK is sprite+33 INTICON.PCK contains a minimized icon id=sprite the file id for the dogfight image is sprite+11
| -1
|-
| '''fuelMax'''
| Maximum amount of fuel this craft can carry. Crafts use up fuel based on their speed while travelling.
| 0
|-
| '''damageMax'''
| Maximum amount of damage this craft can take. If this amount is exceeded, the craft is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles. Crafts travel at max speed when flying and half speed when patrolling.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''weapons'''
| Amount of craft weapons this craft can equip. The UI can only display a max of 2 weapons.
| 0
|-
| '''soldiers'''
| Amount of soldiers this craft can carry.
| 0
|-
| '''maxItems'''
| Amount of items this craft can carry.
| 80
|-
| '''vehicles'''
| Amount of vehicles this craft can carry.
| 0
|-
| '''costBuy'''
| Amount of money spent for purchasing this craft. If set to 0, the craft will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costRent'''
| Amount of money spent monthly for renting this craft. If set to 0, the craft is not on rental and won't count towards base maintenance.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this craft.
| 0
|-
| '''refuelItem'''
| Item required for refuelling this craft. If no item is specified, the craft uses human fuel.
| 0
|-
| '''repairRate'''
| Amount of damage restored every hour while [[Repairs|Repairing]] in base.
| 1
|-
| '''refuelRate'''
| Amount of fuel restored every 30 mins while [[Refueling]] in base. If specified, a '''refuelItem''' is spent each time.
| 1
|-
| '''radarRange'''
| Detection range of the craft's radar in nautical miles. Every craft radar has a 100% detection chance.
| 600
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this craft to a base.
| 0
|-
| '''score'''
| [[Score]] lost when this craft is destroyed.
| 0
|-
| '''spacecraft'''
| Can this craft go to [[Cydonia]]?
| false
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this craft in Battlescape missions.
| -
|}

=== Craft Weapons ===

Defines one of the [[Craft Armaments|weapons]] equipped by X-COM craft for shooting down UFOs, listed in ''"craftWeapons:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the weapon name.
| ''required''
|-
| '''sprite'''
| Sprite ID from [[BASEBITS.PCK]] used to draw the weapon in the Basescape and from [[INTICON.PCK]] used to draw the weapon in dogfights.
modders: the corresponding extrasprites file id for INTICON.PCK is sprite+5 and sprite+48 for BASEBITS.PCK
| -1
|-
| '''sound'''
| Sound ID from [[#Extra_Sounds|GEO.CAT]] played when this weapon fires.
| -1
|-
| '''damage'''
| Amount of damage this weapon does to enemy UFOs.
| 0
|-
| '''range'''
| Maximum range of this weapon in dogfights (in meters).
| 0
|-
| '''accuracy'''
| Chance (0-100%) of each shot hitting the enemy UFO.
| 0
|-
| '''reloadCautious'''
| Time this weapon takes to fire between each shot in ''Cautious Mode''.
| 0
|-
| '''reloadStandard'''
| Time this weapon takes to fire between each shot in ''Standard Mode''.
| 0
|-
| '''reloadAggressive'''
| Time this weapon takes to fire between each shot in ''Aggressive Mode''.
| 0
|-
| '''ammoMax'''
| Maximum amount of ammo this weapon can carry.
| 0
|-
| '''rearmRate'''
| Amount of ammo restored every 30 mins while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize'''. If the '''clipSize''' of the specified ammo is 0, no '''clip'''s are spent.
| 1
|-
| '''projectileType'''
| Type of the weapon projectile, used for the projectile sprite in dogfights:
* 0 - [[Stingray]]
* 1 - [[Avalanche]]
* 2 - [[Cannon]]
* 3 - [[Fusion Ball]]
* 4 - [[Laser Cannon]]
* 5 - [[Plasma Beam]]
| 2
|-
| '''projectileSpeed'''
| Speed of the weapon projectile in dogfights.
| 0
|-
| '''launcher'''
| String ID of the [[#Items|item]] required to equip this weapon.
| -
|-
| '''clip'''
| String ID of the [[#Items|item]] required to rearm this weapon.
| -
|}

=== Items ===

Defines the Geoscape and Battlescape properties of an [[Equipment (EU)|item]] that can be stored in X-COM bases, listed in ''"items:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the internal item name.
| ''required''
|-
| '''name'''
| String ID of the displayed item name, for cases where it's different from the internal name. If omitted, '''type''' is used.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this item. If none are specified, this item is unlocked from the start. Soldiers can only use unlocked items in the Battlescape.
| -
|-
| '''size'''
| Space occupied by this item in [[Base Stores]]. Can be a decimal value.
| 0.0
|-
| '''costBuy'''
| Amount of money spent for purchasing this item. If set to 0, this item will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSell'''
| Amount of money gained for selling this item.
| 0
|-
| '''transferTime'''
| Number of hours it takes to purchase/transfer this item to a base.
| 24
|-
| '''weight'''
| [[Item_Weight|Weight]] occupied by this item in a soldier's inventory.
| 999
|-
| '''bigSprite'''
| Sprite ID from [[BIGOBS.PCK]] used to draw this item in a soldier's inventory and UFOpaedia.
| -1
|-
| '''floorSprite'''
| Sprite ID from [[FLOOROB.PCK]] used to draw this item on the floor of a Battlescape tile.
| -1
|-
| '''handSprite'''
| Sprite ID from [[HANDOB.PCK]] used to draw this item on a soldier's hand in the Battlescape.
modders: each handobject needs 8 images (8 directions) define the extrasprites accordingly
| 120
|-
| '''bulletSprite'''
| Sprite ID from ''BulletSprites.png'' used to draw this weapon's projectile on the Battlescape:
* 0 - [[Rocket Launcher]]
* 1 - [[Pistol]]
* 2 - [[Rifle]]
* 3 - [[Auto Cannon]]
* 4 - [[Heavy Cannon]]
* 5 - [[Laser Pistol]]
* 6 - [[Laser Rifle]]
* 7 - [[Heavy Laser]]
* 8 - [[Plasma Rifle|Plasma]]
* 9 - [[Small Launcher]]
* 10 - [[Blaster Launcher]]
for modders: the bulletsprite needs to be put into the extraSprites type "Projectiles" the bulletsprite can contain up to 35 3x3 images
| -1
|-
| '''fireSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon fires.
| -1
|-
| '''hitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon hits a target.
| -1
|-
| '''hitAnimation'''
| Sprite ID from [[SMOKE.PCK]] used to draw the weapon's "hit explosion".
'''NOTE''': Do not define this value for melee/psi weapons, they use [[HIT.PCK]] and therefore meleeAnimation instead.
| 0
|-
| '''power'''
| Average damage of the weapon, in most cases it will be +-50% this value.
| 0
|-
| '''strengthApplied'''
| Add the attacking unit's strength to this weapon's damage.
| false
|-
| '''compatibleAmmo'''
| List of string IDs of the ammo items that can be loaded on this weapon. If none are specified, the weapon doesn't need ammo.
| -
|-
| '''damageType'''
| What type of [[damage]] does this weapon do:
* 0 - None
* 1 - Armor Piercing
* 2 - Incendiary
* 3 - High Explosive
* 4 - Laser
* 5 - Plasma
* 6 - Stun
* 7 - Melee
* 8 - Acid
* 9 - Smoke
'''NOTE:''' A damage type other than 0-9 will do nothing.
| 0
|-
| '''tuAuto'''
'''accuracyAuto'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Auto Shot. If 0, the weapon does not have an Auto Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Auto Shot.
| 0
0
|-
| '''tuSnap'''
'''accuracySnap'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire a Snap Shot. If 0, the weapon does not have a Snap Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing a Snap Shot.
| 0
0
|-
| '''tuAimed'''
'''accuracyAimed'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to fire an Aimed Shot. If 0, the weapon does not have an Aimed Shot.
The base accuracy (0-100%) applied to a soldier's [[Firing Accuracy]] when firing an Aimed Shot.
| 0
0
|-
|-
| '''tuMelee'''
'''accuracyMelee'''
| The percentage (0-100%) of [[Time Units]] (from the soldier's total) required to do a melee attack (Hit). If 0, the weapon does not have a melee attack.
The base accuracy (0-100%) applied to a soldier's [[Melee Accuracy]] when doing a melee attack.
| 0
0
|-
| '''clipSize'''
| The amount of ammo stored in each weapon clip. If -1 is specified, this weapon has infinite ammo.
| 0
|-
| '''battleType'''
| Defines the weapon's behavior in the Battlescape:
* 0 - None (Geoscape-only item)
* 1 - [[Weapons|Firearm]]
* 2 - Ammo
* 3 - Melee
* 4 - [[Grenade]]
* 5 - [[Proximity Grenade]]
* 6 - [[Medi-Kit (EU)|Medi-Kit]]
* 7 - [[Motion Scanner]]
* 8 - [[Mind Probe]]
* 9 - [[Psi-Amp]]
* 10 - [[Electro-flare]]
* 11 - Corpse
| 0
|-
| '''twoHanded'''
| Is this weapon two-handed? (incurs an accuracy penalty if used with both hands occupied)
| false
|-
| '''waypoint'''
| Does this weapon use waypoints? (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system.
| false
|-
| '''fixedWeapon'''
| Is this weapon fixed? (it's part of a unit, eg. tanks and terrorist units)
| false
|-
| '''invWidth'''
| Item width in a soldier's inventory (in grid units).
| 1
|-
| '''invHeight'''
| Item height in a soldier's inventory (in grid units).
| 1
|-
| '''painKiller'''
| Amount of painkillers contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''heal'''
| Amount of heal's contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stimulant'''
| Amount of stimulants contained in a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''woundRecovery'''
| Amount of [[Fatal Wounds]] treated by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''healthRecovery'''
| Amount of [[Health]] recovered by each heal of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''stunRecovery'''
| Amount of [[Stun]] removed by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''energyRecovery'''
| Amount of [[Energy]] recovered by each stimulant of a [[Medi-Kit (EU)|Medi-Kit]].
| 0
|-
| '''tuUse'''
| Amount of [[Time Units]] required to use this item (for non-offensive items). It's a flat rate if '''flatRate''' is true, otherwise it's a percentage (0-100%).
| 0
|-
| '''recoveryPoints'''
| [[Score]] gained for recovering this alien artifact.
| 0
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''turretType'''
| Sprite ID from [[TANKS.PCK]] of the turret to assign to this tank:
* 0 - [[Tank/Cannon]]
* 1 - [[Tank/Rocket Launcher]]
* 2 - [[Tank/Laser Cannon]]
* 3 - [[Hovertank/Plasma]]
* 4 - [[Hovertank/Launcher]]
| -1
|-
| '''liveAlien'''
| Does this item represent a live alien? (counts towards [[Alien Containment]])
| false
|-
| '''blastRadius'''
| Size of the projectile explosions. 0 for no explosion. -1 to automatically calculate based on weapon power and damage type (actual '''blastRadius''' currently is capped due [[Explosions#Playing_With_Fire|Explosion calculations]]).
| -1
|-
| '''flatRate'''
| If true, then TU costs for this weapon are a flat rate (instead of a percentage of unit TUs).
| false
|-
| '''arcingShot'''
| Does this weapon fire in an arc?
| false
|-
| '''attraction'''
| Represents how likely an alien is to pick up this item. Values below 5 will be ignored (by design).
| 0
|-
| '''maxRange'''
| Maximum range at which this weapon can operate.
| 200
|-
| '''aimRange'''
| Maximum effective range with this weapon before which range-based dropoff occurs.
| 200
|-
| '''snapRange'''
| Maximum effective range with snap shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 15
|-
| '''autoRange'''
| Maximum effective range with auto shot before which range-based dropoff occurs. (ufoextender accuracy only)
| 7
|-
| '''minRange'''
| Range-based dropoff will work in reverse for ranges below this.
| 0
|-
| '''dropoff'''
| The value by which the accuracy lowers for each tile after (or before) the thresholds above.
| 2
|-
| '''bulletSpeed'''
| How much faster (or slower, if you use a negative number) is a projectile fired from this weapon compared to the average.
| 0
|-
| '''autoShots'''
| How many auto shots does this weapon fire.
| 3
|-
| '''shotgunPellets'''
| Number of projectiles fired per unit of ammunition. (note: due to engine limitations it is currently impossible to draw multiple projectiles in flight.)
| 0
|-
| '''zombieUnit'''
| String ID of the unit used for zombification (eg. [[Chrysallid]]s turn units into [[Zombie]]s).
| none
|-
| '''meleeSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon attacks a target with melee.
| 39
|-
| '''meleeHitSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this weapon HITS a target with melee.
| -1
|-
| '''meleeAnimation'''
| Sprite ID from HIT.PCK played when this weapon attacks a target with melee.
| 0
|-
| '''meleePower'''
| Damage this weapon will do when using melee. This only applies to Firearms, and is only available as stun damage. For normal melee weapons, use regular power and damage types.
| 0
|-
| '''LOSRequired'''
| Does this item require line of sight? (only applies to mind probes and psi-amps)
| false
|-
| '''skillApplied'''
| Is melee skill applied to the accuracy of an attack made with this object?
| true
|-
|}

=== UFOs ===

Defines one of the [[UFOs]] that invade Earth, listed in ''"ufos:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the UFO name.
| ''required''
|-
| '''size'''
| String ID of the UFO size.
| STR_VERY_SMALL
|-
| '''sprite'''
| Sprite ID from [[INTERWIN.DAT]] used to draw this UFO in the dogfight view and UFOpaedia.
don't try to add more images if you don't want to punch yourself in the face - use modsprite
| -1
|-
| '''modSprite'''
| Filename used to draw this UFO in the dogfight view and UFOpaedia.
| -
|-
| '''damageMax'''
| Maximum amount of damage this UFO can take. If the UFO takes 50% damage, it crash lands. If it takes 100% damage, it is destroyed.
| 0
|-
| '''speedMax'''
| Maximum speed in nautical miles.
| 0
|-
| '''accel'''
| Aceeleration value shown in the UFOpaedia.
| 0
|-
| '''power'''
| Damage power of this UFO's weapon in dogfights.
| 0
|-
| '''range'''
| Maximum range of this UFO's weapon in dogfights (in meters).
| 0
|-
| '''score'''
| [[Score]] gained when this UFO is destroyed, or half this score if it crash lands.
| 0
|-
| '''reload'''
| Time the UFO's weapon takes to fire between each shot.
| 0
|-
| '''breakOffTime'''
| Minimum amount of time for the UFO to be able to break off of a dogfight.
| 0
|-
| '''battlescapeTerrainData'''
| [[#Terrains|Terrain]] associated to this UFO in Battlescape missions.
| ''required''
|-
|}

=== Inventory Sections ===

Defines one of the sections of the [[Inventory TU Table|Battlescape inventory]] (eg. Backpack), listed in ''"invs:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the inventory name.
| ''required''
|-
| '''x'''
'''y'''
| Pixel coordinates of this section on the inventory screen.
| 0
0
|-
| '''type'''
| Type of this section:
* 0 = Slot section, can contain as many items as will fit on the slots.
* 1 = Hand section, can only contain one item regardless of size.
* 2 = Ground section, can contain infinite items.
| 0
|-
| '''slots'''
| List of the grid slots (''[x, y]'') that this section is composed of. For example, to make a 2x2 section, you would have ''[0, 0] [0, 1] [1, 0] [1, 1]''.
| -
|-
| '''costs'''
| List of [[Time Units]] costs to move an item from this section to another one (eg. ''STR_BACKPACK: 16'' means it will cost 16 TUs to move an item from this section to the Backpack).
| -
|-
|}

=== Terrains ===

Defines one of the [[TERRAIN|terrains]] used to generate a Battlescape map, listed in "terrains:".

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the terrain name.
| ''required''
|-
| '''largeBlockLimit'''
| Maximum amount of large blocks that can be used on map generation.
| 0
|-
| '''textures'''
| List of [[TEXTURE.DAT|Geoscape textures]] that correspond to this terrain.
| -
|-
| '''hemisphere'''
| Geoscape hemisphere associated with this terrain:
* -1 - Northern hemisphere.
* 0 - Both hemispheres.
* 1 - Southern hemisphere.
| 0
|-
| '''mapDataSets'''
| List of filenames (each with matching [[MCD]]/[[Image Formats#PCK|PCK/TAB]] files) that contain the tiles of this terrain.
| -
|-
| '''mapBlocks'''
| List of map blocks (see below) that are used for generating a map.
| -
|-
| '''roadTypeOdds'''
| Odds as a % of generating each type of road (E-W Road, N-S Road, Crossing) odds for crossing are: 100 - EW - NS.
| [0 0]
|-|-
| '''civilianTypes'''
| List of units to use as civilians for this mission.
| [MALE_CIVILIAN, FEMALE_CIVILIAN]
|-
|}

==== Map Blocks ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| Filename of the [[MAPS|map]].
| ''required''
|-
| '''width'''
| Width of this map block in Battlescape grid units.
| 0
|-
| '''length'''
| Length of this map block in Battlescape grid units.
| 0
|-
| '''height'''
| Height of this map block in Battlescape grid units.
| 1
|-
| '''type'''
| Type of this map block:
* -1 - Undefined
* 0 - Default
* 1 - Landing Zone (for placing X-COM / alien craft)
* 2 - E-W Road (for city maps)
* 3 - N-S Road (for city maps)
* 4 - Road Crossing (for city maps)
* 5 - Dirt (for filling empty base blocks)
* 6 - X-COM spawn point (for [[Alien Base]] / [[Cydonia]] missions)
* 7 - [[Alien Base]] Target
* 8 - [[Cydonia]] Target
| -1
|-
| '''subType'''
| Sub-type of this map block (see '''type''').
| -1
|-
| '''frequency'''
| Frequency of this block in a map.
| 1
|-
| '''maxCount'''
| Maximum amount of times this block can be used in a map. If -1 there is no limit.
| -1
|-
| '''items'''
| An array of items to add to this mapblock, an the positions to place them at.
| -1
|}

*'''frequency''' defines the odds of the map appearing on the map
** The value assigned (default: 1) is used in ''x/n'', which defines the probability of being chosen.
** ''x'' is the integer defined for the map block's frequency and ''n'' is the combined total of probabilities for all the map types combined.
** This property can only be used in type 0 map blocks.
*'''maxCount''' is the maximum number of times it can be used.
** The value assigned is also used in ''x/n'' to determine the probability of being chosen.
** Each use reduces ''x'' by -1, with the caveat that being used as a Landing Zone type will not reduce the x value since it could result in no available Landing Zones.
** This property can only be used in type 0 map blocks.
* '''hemisphere''' only applies to UFO missions, not Terror ones.
*'''width/length''' defines the size of the map
** be aware that the mapview "width"-label is the openxcom ruleset length parameter
** be aware that the mapview "length"-label is the openxcom ruleset width parameter

==== Guidelines/Tips ====
* All maps with an XCOM/Alien craft require at least one type 1 map block. This map block can only contain ground tiles (no walls or objects), otherwise the game will crash or the walls/objects will be removed.
* All Terror terrains (listed under STR_TERROR_MISSION) require at least 1 map block of '''Types''' 2, 3 and 4 (for a total of 3 maps, which are required to place roads) and the corresponding '''roadTypeOdds''' added to the ruleset.
* If there isn't any map blocks designed as roads since you want to keep your terrain 'random', this can be circumvented by designating all 10x10 map blocks, excluding the one(s) used for the XCOM craft, as either '''Type''' 2, 3 and 4 and by defining their '''subType''' to 0. The game will then randomly choose between the map blocks for each type used in the roads, making them map more random.

=== Armor ===

Defines a Battlescape unit's [[armor]] as well as visual representation (so every unit has an armor), listed in ''"armors:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the armor name.
| ''required''
|-
| '''spriteSheet'''
| Sprite sheet from [[UNITS]] used to draw a unit wearing this armor.
| -
|-
| '''spriteInv'''
| Sprite used for the [[Inventory Backgrounds]] of a unit wearing this armor.
| -
|-
| '''corpseBattle'''
| List of string IDs of the corpse [[#Items|items]] generated when a unit wearing this armor is killed (one per unit tile) on the Battlescape.
| -
|-
| '''corpseGeo'''
| String ID of the corpse [[#Items|item]] associated with this unit on the Geoscape.
| -
|-
| '''storeItem'''
| String ID of the [[#Items|item]] that represents this armor in [[Base Stores]] for equipping.
| -
|-
| '''weight'''
| Physical weight of the armor when worn
| 6
|-
| '''stats'''
| like soldier stats (see below) but these are treated as stat bonuses for wearing the specific armor.
| -
|-
| '''frontArmor'''
| Protection provided on the front of the unit.
| 0
|-
| '''sideArmor'''
| Protection provided on the sides of the unit.
| 0
|-
| '''rearArmor'''
| Protection provided on the rear of the unit.
| 0
|-
| '''underArmor'''
| Protection provided under the unit (eg. from explosions).
| 0
|-
| '''drawingRoutine'''
| Drawing routine used to put together the body parts in the unit's '''spriteSheet''':
* 0 = [[Soldier]], [[Sectoid]]
* 1 = [[Floater]]
* 2 = [[HWP]]
* 3 = [[Cyberdisk]]
* 4 = [[Civilian]], [[Ethereal]]
* 5 = [[Sectopod]], [[Reaper]]
* 6 = [[Snakeman]]
* 7 = [[Chryssalid]]
* 8 = [[Silacoid]]
* 9 = [[Celatid]]
* 10 = [[Muton]]
| 0
|-
| '''movementType'''
| Type of movement provided by this armor:
* 0 = Walking
* 1 = Flying
* 2 = Sliding (no walking animation)
it also defines the body of an tank (32-images) in your spriteSheet or the change in sprites while flying using a flying armour see: [[TANKS.PCK]], [[XCOM_2.PCK]]
| 0
|-
| '''damageModifier'''
| List of decimal damage modifiers (1.0 = 100%) this armor applies to each damage type (see [[#Items|Items section]]) received. Modifiers must be specified for all damage types, in this order:
* None
* Armor Piercing
* Incendiary
* High Explosive
* Laser
* Plasma
* Stun
* Melee
* Acid
* Smoke
|
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0 
- 1.0
|-
| '''size'''
| Size of the unit wearing this armor, in Battlescape grid units. Every unit is square, so a size of 2 means 2x2.
| 1
|-
| '''loftempsSet'''
| List of [[LOFTEMPS]] IDs (one per unit tile, so a 1x1 unit has 1, a 2x2 unit has 4, etc.) used to represent a unit wearing this armor in 3D space.
| -
|-
| '''loftemps'''
| loftemps is a deprecated option that only works for 1x1 sized units.
| -
|}

=== Player Units (Soldiers) ===

Defines a [[soldier]] recruited by X-COM, listed in ''"soldiers:"''. Currently only one soldier unit type (''XCOM'') is supported.

Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier name.
| ''required''
|-
| '''minStats'''
| Minimum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the initial stat (not generated).
| -
|-
| '''maxStats'''
| Maximum values used to generate the soldier's [[Starting Stats]]. In this case, ''psiSkill'' is treated as the minimum value for the first month of psi training (actual value is 100%-150%).
| -
|-
| '''statCaps'''
| Maximum stats this soldier can gain through [[Experience]]. '''NOTE:''' A stat will still go over the limit once, and then will no longer increase (see [[Experience#Regarding Caps|Regarding Caps]]).
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this soldier uses by default.
| -
|-
| '''standHeight'''
| Height of this soldier when standing.
| 0
|-
| '''kneelHeight'''
| Height of this soldier when kneeling.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|}

=== AI Units (Aliens/Civilians) ===

Defines an [[Alien Life Forms|alien]] (enemy) or [[civilian]] (neutral) unit, listed in ''"units:"''. Every different alien rank is a different unit, since they have completely different stats. Unit stats are represented as follows:
* [[Time Units|tu]]
* [[Energy|stamina]]
* [[Health|health]]
* [[Bravery|bravery]] (always a multiple of 10)
* [[Reactions|reactions]]
* [[Firing Accuracy|firing]]
* [[Throwing Accuracy|throwing]]
* [[Strength|strength]]
* [[Psi Strength|psiStrength]]
* [[Psi Skill|psiSkill]]
* [[Melee Accuracy|melee]] (not visible)

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the unit name.
| ''required''
|-
| '''race'''
| String ID of the unit race (for alien units).
| -
|-
| '''rank'''
| String ID of the unit rank (for alien units).
| -
|-
| '''stats'''
| Battlescape stats of this unit.
| -
|-
| '''armor'''
| String ID of the [[#Armor|armor]] this unit uses by default.
| -
|-
| '''standHeight'''
| Height of this unit when standing.
| 0
|-
| '''floatHeight'''
| Distance between the bottom of this unit and the ground.
| 0
|-
| '''value'''
| [[Score]] this unit is worth.
| 0
|-
| '''deathSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit dies.
| -1
|-
| '''aggroSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit aggros.
| -1
|-
| '''moveSound'''
| Sound ID from [[#Extra_Sounds|BATTLE.CAT]] played when this unit moves.
| -1
|-
| '''intelligence'''
| Intelligence of this unit's AI. The higher the value, the longer this unit remembers player troops between turns.
| 0
|-
| '''aggression'''
| Aggression of this unit's AI. The higher the value, the more ruthless the unit, the more likely to make a frontal assault. Less aggressive units tend to set up ambushes.
Vanilla values are:
* 0 = mostly passive
* 1 = balanced
* 2 = mostly aggresive
| 0
|-
| '''energyRecovery'''
| Energy recovered by the unit each turn (needs verification)
| 40 (?)
|-
| '''specab'''
| Special ability of this unit:
* 0 = None
* 1 = [[Cyberdisc|Explodes on Death]]
* 2 = [[Bio-Drone|Burns Floor]]
* 3 = [[Zombie|Respawns on Death]]
| 0
|-
| '''spawnUnit'''
| String ID of the unit used to respawn on death (eg. [[Zombie]]s respawn as [[Chrysallid]]s).
| -
|-
| '''livingWeapon'''
| Is this unit a living weapon? (only attacks with a '''fixedWeapon''')
| false
|-
|}

=== Alien Races ===

Defines a [[Alien Life Forms|race]] used in [[Alien Missions]], listed in ''"alienRaces:"''. Heavily tied with deployment data.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the alien race name.
| ''required''
|-
| '''members'''
| Alien crew associated with this alien race (eg. race units + terrorist units), defined by a list of unit string IDs. Order here will define rank in terms of deployment. generally speaking the order is:
* 0 - Commander
* 1 - Leader
* 2 - Engineer
* 3 - Medic
* 4 - Navigator
* 5 - Soldier
* 6 - Terrorist 1
* 7 - Terrorist 2
but of course, not all races have all ranks, so the "fill in" rank would be listed multiple times (see ethereals).
|-
| '''retaliation'''
| retaliation enables/disables the race for retaliation missions.
| ''True''
| -
|}

=== Alien Deployments ===

Defines a Battlescape deployment data used in [[Alien Missions]] (such as alien and map configurations), listed in ''"alienDeployments:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the deployment name.
| ''required''
|-
| '''width'''
| Width of the Battlescape map in grid units.
| 0
|-
| '''length'''
| Length of the Battlescape map in grid units.
| 0
|-
| '''height'''
| Vertical height of the Battlescape map in grid units.
| 0
|-
| '''terrains'''
| list of string IDs of the [[#Terrains|terrain]] to choose from to generate this map. This is not used for UFO sites where the terrain comes from the Geoscape.
| -
|-
| '''shade'''
| Shade of the map (0-15, where 0 is full daytime and 15 is full nighttime). This is not used for UFO sites where the shade comes from the Geoscape.
| 0
|-
| '''nextStage'''
| String ID of the next deployment stage to use after this one, for multi-stage missions.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|}

Notes:
* '''terrains''' can also be used with UFOs, with the game using instead the listed terrain rather than the location of the UFO on Geoscape.
==== Deployment Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''alienRank'''
| [[Alien Rank|Rank]] associated with this deployment data, as defined by the order of the race in question (see above)
| ''required''
|-
| '''lowQty'''
| Maximum quantity of aliens to spawn (beginner).
| 0
|-
| '''highQty'''
| Maximum quantity of aliens to spawn (superhuman).
| 0
|-
| '''dQty'''
| Minimum Desired Quantity of aliens to spawn.
| 0
|-
| '''percentageOutsideUfo'''
| Percentage (0-100%) of aliens to spawn outside in UFO sites.
| 0
|-
| '''itemSets'''
| Three lists (one for each alien technology level) of [[#Items|items]] (string IDs) for the aliens to equip.
| ''required''
|-
|}

=== Research ===

Defines a [[Research|research topic]] that X-COM scientists can investigate, listed in ''"research:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the research project's name (or item, if a '''lookup''' is defined).
| ''required''
|-
| '''lookup'''
| String ID of the research project's display name and UFOPaedia article reference.
| -
|-
| '''cost'''
| Number of man hours (on average) required to complete this project.
| 0
|-
| '''points'''
| [[Score]] earned for completing this project.
| 0
|-
| '''needItem'''
| Does this project require an [[#Items|item]] of the same name?
| false
|-
| '''dependencies'''
| List of research projects that can unlock access to this one. If the full list is researched, or if one of the projects on the list "unlocks" this one, it becomes available.
| -
|-
| '''unlocks'''
| List of research projects unlocked, regardless of other dependencies, but not requirements, by completing this project (for example, any live alien unlocks "alien origins").
| -
|-
| '''requires'''
| List of research projects unilaterally required before this project can be unlocked (for example, "the martian solution" will not even be considered for unlocking until AFTER "alien origins" is completed).
| -
|-
| '''getOneFree'''
| List of "bonus" research projects that may be granted when completing this project (for example, alien medics will give you information on other alien races). Only applies to living aliens.
| -
|-
|}

=== Manufacture ===

Defines a [[Manufacture|manufacture project]] that X-COM engineers can produce, listed in ''"manufacture:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''name'''
| String ID of the manufacturing project's name (and the item it produces).
| ''required''
|-
| '''category'''
| String ID of the manufacturing project's category.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this project. If none are specified, this project is unlocked from the start.
| -
|-
| '''space'''
| Amount of [[Workshop]] space required to begin this project.
| 0
|-
| '''time'''
| Number of man hours (on average) required per item.
| 0
|-
| '''cost'''
| Monetary deduction per item manufactured.
| 0
|-
| '''requiredItems'''
| List of [[#Items|items]] required and consumed per item manufactured.
| -
|-
| '''producedItems'''
| List of [[#Items|items]] produced per each item consumed. If not specified, defaults to 1 item with the same string ID as the manufacture.
| 1
|-
|}

=== UFOpaedia Article ===

Defines an article in the in-game [[UFOpaedia]], listed in ''"ufopaedia:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the article name. This must match the ID of the object associated with this article, if applicable.
| ''required''
|-
| '''title'''
| String ID of the article title. If omitted, the '''id''' is used.
| -
|-
| '''type_id'''
| Type of this article:
* 0 = Unknown
* 1 = [[Craft]]
* 2 = [[Craft Armaments]]
* 3 = [[HWP]]
* 4 = [[Equipment (EU)|Equipment]]
* 5 = [[Armour]]
* 6 = [[Base Facilities]]
* 7 = Text & Image (eg. [[Alien Life Forms]], [[UFO Components]])
* 8 = Text (eg. [[Alien Research]])
* 9 = [[UFO]]
| 0
|-
| '''section'''
| String ID of the UFOpaedia section this article belongs in.
| -
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this article. If none are specified, this article is unlocked from the start.
| -
|-
| '''image_id'''
| Filename of the [[UP001.SPK-UP042.SPK|background image]] displayed on this article, if applicable.
| -
|-
| '''text'''
| String ID of the description displayed on this article.
| -
|-
| '''text_width'''
| Maximum width of the text displayed, only applicable to ''Text & Image'' articles.
| 0
|-
| '''rect_stats'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the stats text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''rect_text'''
| Rectangle ('''x''', '''y''', '''width''', '''height''') of the description text on the screen, only applicable to ''Craft'' articles.
| 0
|-
| '''weapon'''
| String ID of the weapon, only applicable to ''HWP'' articles.
| -
|}

=== UFO Trajectories ===

Defines a trajectory carried out by an UFO during an [[#Alien Missions|alien mission]], listed in ''"ufoTrajectories:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''id'''
| String ID of the trajectory name.
| ''required''
|-
| '''groundTimer'''
| Amount of seconds for the UFO to spend on Ground waypoints.
| 0
|-
| '''waypoints'''
| List of waypoints for the UFO to traverse, defined as ''[zone, altitude, speed]''. 
'''zone''': Globe zone where the waypoint is located. 
'''altitude''': UFO altitude after reaching this waypoint:
* 0 - Ground
* 1 - Very Low
* 2 - Low
* 3 - High
* 4 - Very High
'''speed''': UFO speed after reaching this waypoint, as a percentage (0-100%) of its maximum speed.
| -
|}

=== Alien Missions ===

Defines an [[Alien Missions|alien mission]] carried out by UFOs on the Geoscape, listed in ''"alienMissions:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the mission type.
| ''required''
|-
| '''points'''
| [[Score]] allocated to aliens for successfully completing this mission.
| 0
|-
| '''raceWeights'''
| List of alien races likely to carry out this mission, and the % chance of them being allocated to this mission, listed by "number of months after game beginning".
| ''required''
|-
| '''waves'''
| List of UFO waves to spawn as this mission progresses, as described below.
| ''required''
|}

==== Waves ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''ufo'''
| String ID of the [[#UFOs|UFO]] to spawn.
| ''required''
|-
| '''count'''
| Number of UFOs to spawn.
| 0
|-
| '''trajectory'''
| String ID of the [[#UFO Trajectories|trajectory]] for this UFO to use when entering Earth's atmosphere.
| ''required''
|-
| '''timer'''
| How long after the previous wave should this wave arrive? (in seconds)
| 0
|-
|}

=== Alien Item Levels ===

This is a list of item level probabilities, with a number between 0 and 2 representing an item level from plasma pistols to heavy plasmas, as defined in the deployments, expressing a 10% probability for that item level being used.

0 = first set (plasma pistol/clip)
1 = second set (plasma rifle/clip)
2 = third set (heavy plasma/clip)

For example:
[ 2, 0, 0, 0, 0, 0, 0, 1, 1, 1 ]
would represent a 60% chance for pistols, 30% rifles, and 10% heavy weapons. 
Note that the order does not matter, but the length DOES. each line MUST have 10 digits.

The above can be confusing. There are 10 fields; each number represents 10%. 
There is only one instance of '2'. 1x10% = 10% chance of plasma pistol 
There are three instances of '1'. 3x10% = 30% chance of plasma rifle 
There are six instances of '0'. 6x10% = 60% chance of heavy plasma 

Each line represents a month after the beginning of the game, and there is no limit to the number defined. 
OpenXCom will use the most recently available item level in the event the game goes on forever.

=== Extra Sprites ===

Adds or replaces sprites in an existing [[Image Formats|X-COM image file]], listed in ''"extraSprites:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original/new image to modify.
| ''required''
|-
| '''width'''
'''height'''
| Size of the sprite(s) in pixels.
| 0
0
|-
| '''singleImage'''
| Is the image file just a single sprite (true) or a spritesheet (false)?
| false
|-
| '''subX'''
'''subY'''
| Size of the subdivision in pixels. If a subdivision is specified, then the image file is divided into chunks to form the sprites (eg. spritesheets).
| 0
0
|-
| '''files'''
| List of the new sprites to add/replace, listed as ''spriteID: filename''.
| -
|}

Example:
- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/Bunny00.png
1: Resources/Bunny/Bunny01.bmp
2: Resources/Bunny/Bunny02.gif

=== Extra Sounds ===

Adds or replaces sounds in an existing [[SOUND|X-COM sound file]], listed in ''"extraSounds:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ID of the original sound file to modify:
* BATTLE.CAT - Battlescape sounds, corresponds to ''SOUND1.CAT'' or ''SAMPLE2.CAT'' (55 sounds).
* INTRO.CAT - Intro sounds, corresponds to ''INTRO.CAT'' or ''SAMPLE3.CAT'', probably best not to mess with these.
* GEO.CAT - Geoscape sounds, corresponds to ''SOUND2.CAT'' or ''SAMPLE.CAT'' (14 sounds).
| ''required''
|-
| '''files'''
| List of the new sounds to add/replace, listed as ''soundID: filename''.
| -
|}

Example:
- type: BATTLE.CAT
files:
55: Resources/Sounds/sample.wav

=== Extra Strings ===

Adds or replaces text strings in an existing [[Translations (OpenXcom)|OpenXcom language file]], listed in ''"extraStrings:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Filename of the original language file to modify, sans extension.
| ''required''
|-
| '''strings'''
| List of the new strings to add/replace, listed as ''stringID: text''.
| -
|}

Example:
- type: en-US
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: en-GB
strings:
STR_SNIPER_RIFLE: Sniper Rifle
STR_SNIPER_RIFLE_CLIP: Sniper Rifle Clip
- type: de
strings:
STR_SNIPER_RIFLE: Scharfschützengewehr
STR_SNIPER_RIFLE_CLIP: Scharfschützengewehrmunition
- type: ru
strings:
STR_SNIPER_RIFLE: Снайперская винтовка
STR_SNIPER_RIFLE_CLIP: Магазин к снайп. винтовке

=== Interfaces ===

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| ''?''
| -
|-
| '''elements'''
| ''?''
| -
|-
| '''id'''
| ''?''
| -
|-
| '''color'''
| ''?''
| -
|}

=== StatStrings ===

[[Statstrings]] are used for automatically renaming soldiers. They are case sensitive and they are processed in the order in which they are specified.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''string'''
| String to add to name.
| ''required''
|-
| '''psiStrength''' 
'''psiSkill''' 
'''bravery''' 
'''strength''' 
'''firing''' 
'''reactions''' 
'''stamina''' 
'''tu''' 
'''health''' 
'''throwing'''
| One or more stat ranges are ANDed together for success. Each range has a minVal and maxVal. Use YAML standard tilde (~) to indicate null.
| -
|}

Example:
statStrings:
- string: "x"
psiStrength: [~, 30]
- string: "P"
psiStrength: [80, ~]
- string: "p"
psiStrength: [60, 79]
- string: "K"
psiSkill: [60, ~]
- string: "k"
psiSkill: [30, 59]
- string: "b"
bravery: [60, ~]
- string: "c"
bravery: [~, 10]
- string: "w"
strength: [~, 25]
- string: "Snpr"
firing: [60, ~]
reactions: [60, ~]
- string: "M"
firing: [70, ~]
- string: "m"
firing: [60, 69]
- string: "Sct"
reactions: [50, ~]
tu: [60, ~]
- string: "R"
reactions: [60, ~]
- string: "r"
reactions: [50, 59]

==References==
<references />

[[Category:OpenXcom]]

Dimension Gates

2014-08-28T11:15:57Z

Kkmic:

== Profile ==
The Dimension Gates appear to be the means by which the Alien craft travel from their home world.
Our craft cannot travel through these gates without being annihilated by an anti-matter implosion.
We must disable a UFO and recover its control systems, propulsion systems and power sources for
research.

==Notes==
The Dimensional Gates are used to go to and from the Alien Dimension.

No standard human vehicle can enter a dimensional gate without being annihilated by anti-matter.

Once a number of captured alien craft and their control, propulsion and energy systems are researched, it is possible to build a [[Dimension Probe|Dimension Probe]] that can enter a dimensional gate and begin the exploration of the [[Alien Dimension (Apocalypse)|Alien Dimension]].

==See Also==
* [[Alien Dimension (Apocalypse)|Alien Dimension]]
* [[Research (Apocalypse)|Research]]

[[Category: Apocalypse]]
[[Category: Research (Apocalypse)]]
[[Category: Aliens (Apocalypse)]]
[[Category: Alien Dimension (Apocalypse)]]

Installing (OpenXcom)

2014-06-18T07:08:08Z

Kkmic:

'''OpenXcom requires a vanilla version of the original [[X-COM]] resources.''' This includes:

* 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".

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.

== Instructions ==
=== All platforms ===

Copy the original resources (specifically the GEODATA, GEOGRAPH, MAPS, ROUTES, SOUND, TERRAIN, UFOGRAPH, UFOINTRO, UNITS subfolders) to OpenXcom's Data folder (usually the "data" subfolder). '''Do not''' just drag/copy your whole X-COM folder into the Data folder, it won't work. It should end up like this:

* data
** GEODATA
** GEOGRAPH
** Language
** MAPS
** Resources
** ROUTES
** Ruleset
** Shaders
** SoldierName
** 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 [https://www.youtube.com/watch?v=rNneKAwvjoU is available here] (courtesy of [https://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.

=== Windows ===

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

If installing manually, copy the resources to the '''data''' subfolder.

=== Mac OS X ===

Copy the resources to the application's '''data''' resource (right click the application > Show Package Contents > Contents > Resources > data).

=== Unix-like ===

OpenXcom requires the following libraries:

* [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 or later

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

If installing through a package manager, you should copy the resources to '''/usr/share/openxcom/data''', otherwise the '''data''' subfolder is preferred.

=== Portable ===

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.

== Data Folder ==

In most cases the OpenXcom data is in the '''data''' subfolder, but it will also look in one of the following paths.

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.

* <game directory>\data

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom\data
* C:\Users\<user>\Documents\OpenXcom\data

=== Mac OS X ===
* <application resources>\data
* ~/Library/Application Support/OpenXcom/data

=== Unix-like ===
* $XDG_DATA_HOME/openxcom/data (usually ~/.local/share/openxcom/data/)
* $XDG_DATA_DIRS/openxcom/data (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== User Folder ==
OpenXcom automatically creates a User folder on first startup (if one doesn't already exists) in one of the following paths, where it stores all your screenshots, savegames and options.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <game directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom
* $XDG_CONFIG_HOME/openxcom

== 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].

[[Category:OpenXcom]]

Installing (OpenXcom)

2014-06-18T07:07:37Z

Kkmic: Added video tutorial link

Highway1 (EU2012)

2014-04-27T19:40:24Z

Kkmic:

{{Map Data Box (EU2012)
|missions=[[Alien Terror (EU2012)|Terror Site]]
|length=57 tiles
|width=50 tiles
|area=~2850 tiles
}}

'''Notes'''
* Starting Location - towards the bottom of the [[Maps (EU2012)|map]] near a semi with a low truck bed.
* Map is shaped as the intersection of two highways, one of them at a higher level
* The semi truck at the starting location can be a good perch for [[Sniper (EU2012)|snipers]] with grappling hooks.
* Ahead to the left is an upper area reached with grappling hook (or a ladder under the billboard) with line of sight to most of the map.
** In particular, you can target the raised area in the opposite direction with Squad Sight snipers.
** In contrast, Squad Sight [[Sniper (EU2012)|snipers]] placed in the starting area cannot shoot into the raised area on the right (with the bus), as there is an invisible wall.
* Up the fallen road span to the right is a bus.
 

<gallery widths=200px heights=150px perrow=4>
File:Highway1.png|Loading screen
File:Highway1 1 (EU2012).png|LZ overview
File:Highway1 2 (EU2012).png|Opposite overview
</gallery>

{{Template:Maps Navbar (EU2012)}}
{{EU2012 Style}}
[[Category: Enemy Unknown (2012)]]
[[Category: Maps (EU2012)]]

Talk:M.C. Generator

2013-11-08T15:33:46Z

Kkmic: Created page with "= Building it after being detected = I remeber building a generator after my base was discovered (I was holding them back with Leviathans and/or Bombardment Shields), and after t..."

= Building it after being detected =
I remeber building a generator after my base was discovered (I was holding them back with Leviathans and/or Bombardment Shields), and after the generator finished constructing, the attacks have stopped.

Anyone else encountered that? Is this normal? [[User:Kkmic|Kkmic]] 10:33, 8 November 2013 (EST)

Compiling with Make (OpenXcom)

2013-07-31T13:16:35Z

Kkmic:

== Required packages ==
* [http://git-scm.com/ git] (git)
* [http://www.libsdl.org/ SDL] (libsdl1.2-dev)
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2-dev)
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2-dev)
* [http://www.ferzkopp.net/joomla/content/view/19/14/ SDL_gfx] (libsdl-gfx1.2-dev), version 2.0.22 or later
* [http://code.google.com/p/yaml-cpp/ yaml-cpp] (libyaml-cpp-dev), version '''0.3.0 or older'''

Check the library websites if you can't find them on your distribution's package manager.

== Commands ==

# Open up a terminal.
# Type '''git clone <repository url>''' (the official one or your own fork) to get the latest code.
# Go into the '''src/''' folder inside the repository you just pulled and rename '''Makefile.simple''' to just '''Makefile'''.
# Edit the '''Makefile''' in case there's any settings you need to change for your particular platform.
# Type '''make''' to compile all the code.
# Go to the '''bin/''' folder and run '''./openxcom'''.
# In the future, you can stay up to date by using '''git pull'''.

[[Category:OpenXcom]]

User talk:Warboy1982

2013-07-01T13:40:41Z

Kkmic: poked warboy

I know that the forum profile link works fine for you, but in order to avoid more headscratching like "wtf? this is my profile!" when clicking it, you may want to use this one: http://openxcom.org/forum/index.php?action=profile;u=969

Options (OpenXcom)

2013-04-21T18:33:08Z

Kkmic:

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen (outdated)]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom 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>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''pauseMode''': Controls how the game behaves on loss of focus.
** 0,1 = Continue running normally on loss of focus.
** 2 = Slow down the game on loss of focus.
** 3 = Pause completely on loss of focus.
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated. This setting is only compatible with 320x200, 640x400 and 960x600 resolutions.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which smoothes pixel edges, but not quite to the extreme of useHQXFilter.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in a more subtle smoothing of pixel edges.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, aliens on any type of mission may detect your base if they are in very close range.
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''NewBattle_''': (...various options starting with this prefix) Stores your game settings from last time you started a random battle.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Development History (OpenXcom)

2012-11-28T13:02:45Z

Kkmic: Turned the list of features into a table

== Roadmap ==

Planned features for each stable version of OpenXcom.

{| class="wikitable"
|-
! Version !! Release date !! Changes
|-
| '''0.1''' || [http://openxcom.org/index.php/2010/10/version-0-1-is-here/ October 17th, 2010] ||
* Engine
* Geoscape
* Basescape
|-
|'''0.2''' || [http://openxcom.org/index.php/2011/01/version-0-2-is-out/ January 28th, 2011] ||
* Language strings
* Saved games
* Battlescape
** Terrain generation
** Basic units
** Basic pathfinding, fog of war, lighting
|-
|'''0.3''' || [http://openxcom.org/index.php/2011/09/holy-crap-its-version-0-3/ September 1st, 2011] ||
* Items
* Purchasing
* Selling
* Transferring
* Ufopaedia
* Options
* Platform-specific Folders
* Battlescape
** Item equipping, firing, throwing
** Environment: fire, smoke, explosions, damage, kills
** Unit stats
** AI Phase 1 (patrol, aggro)
|-
|'''0.4''' || [http://openxcom.org/index.php/2012/08/incoming-version-0-4/ August 14th, 2012] ||
* Research
* Manufacture
* Rulesets
* Battlescape
** Terror sites
** Debriefing, scores, experience and skill ups
** Large units and other alien units
** Special items (medi-kit, motion sensor, proximity grenade, psi-amp, mind probe, blaster launcher, electroflare)
|-
| '''0.45''' || [http://openxcom.org/index.php/2012/11/the-handymens-version/ November 5, 2012] ||
*Ufopaedia
*Modular rulesets
*New options
*Man page / command-line help
*Logging
|-
| '''0.5''' || (unreleased) ||
* Graphs
* Victory/Defeat
* Battlescape
** More alien units
** Alien base and X-Com base missions
** AI Phase 2 (grenades, blaster launcher, taking cover)
|-
| ''' 1.0 ''' || (unreleased) ||
* Resource Packs
* Intro/Outro
* Anything else missing
|}

== Feature List ==

List of every X-Com feature and whether it's supported in the latest stable

OpenXcom version.

{| class="wikitable"
! colspan="2" | Geoscape
|-
| width="300" | Game timer
| width="75" {{yes}}
|-
| colspan="2" | Globe
|-
|    Ocean rendering
| {{yes}}
|-
|    Land rendering
| {{yes}}
|-
|    Rotation and zoom
| {{yes}}
|-
|    Lighting
| {{yes}}
|-
|    Object markers
| {{yes}}
|-
|    Country names and details
| {{yes}}
|-
|    Cities
| {{yes}}
|-
|    Base placement
| {{yes}}
|-
|    Object selection
| {{yes}}
|-
| colspan="2" | Events
|-
|    UFO spawning
| {{yes}}
|-
|    Terror Site spawning
| {{yes}}
|-
|    Alien Base generation
| {{yes}}
|-
|    Base Defenses
| {{no}}
|-
|    Cydonia
| {{no}}
|-
|    Favor point gain/loss
| {{yes}}
|-
|    Multi-UFO Alien Missions
| {{no}}
|-
| colspan="2" | AI/Progression
|-
|    Alien Mission spawning
| {{no}}
|-
|    Race progression
| {{no}}
|-
|    Frequency & type of missions
| {{no}}
|-
| colspan="2" | Interceptions
|-
|    Craft list
| {{yes}}
|-
|    Target selection
| {{yes}}
|-
|    Weapon firing
| {{yes}}
|-
|    Dogfight modes
| {{yes}}
|-
|    X-Com craft behavior
| {{yes}}
|-
|    UFO behavior
| {{yes}}
|-
|    Damage indicator
| {{yes}}
|-
|    UFO view
| {{yes}}
|-
|    Multiple dogfights
| {{yes}}
|-
|    Minimizing
| {{yes}}
|-
| colspan="2" | Battlescape After-Effects
|-
|    Experience
| {{yes}}
|-
|    Score
| {{yes}}
|-
|    Item recovery
| {{yes}}
|-
|    Wound recovery
| {{yes}}
|-
|    KIA/MIA soldiers
| {{yes}}
|-
|    Promotions
| {{yes}}
|-
|    Alien Mission impact
| {{yes}}
|-
|    Re-Equip Soldiers
| {{yes}}
|-
| Graphs
| {{yes}}
|-
| Options
| {{yes}}
|-
| Load/Save
| {{yes}}
|-
| Funding
| {{yes}}
|-
! colspan="2" | Basescape
|-
| View base layout
| {{yes}}
|-
| View base details
| {{yes}}
|-
| View multiple bases
| {{yes}}
|-
| Build new bases
| {{yes}}
|-
| Base information
| {{yes}}
|-
| Soldier management
| {{yes}}
|-
| colspan="2" | Craft management
|-
|    Craft weapons
| {{yes}}
|-
|    Craft soldiers
| {{yes}}
|-
|    Craft equipment
| {{yes}}
|-
|    Craft armor
| {{yes}}
|-
| Facility construction / removal
| {{yes}}
|-
| Research
| {{yes}}
|-
| Manufacture
| {{yes}}
|-
| Purchase items
| {{yes}}
|-
| Sell items
| {{yes}}
|-
| Transfer items between bases
| {{yes}}
|-
! colspan="2" | Battlescape
|-
| colspan="2" | Launch
|-
|    Site terrain creation
| {{yes}}
|-
|    Craft/UFO terrain
| {{yes}}
|-
|    Unit spawning
| {{yes}}
|-
|    Tanks organized in craft
| {{yes}}
|-
|    Item generation
| {{yes}}

|-
| colspan="2" | Equip Screen
|-
|     unit/armor portrait
| {{yes}}
|-
|     unit inventory boxes
| {{yes}}
|-
|     ground
| {{yes}}
|-
|     items shown
| {{yes}}
|-
|     move/equip items
| {{yes}}

|-
| colspan="2" | Races
|-
|     animations
| {{yes}}
|-
|     racial attacks
| {{yes}}
|-
|     all ranks
| {{yes}}

|-
| colspan="2" | General Actions & Effects
|-
|     experience triggers
| {{yes}}
|-
|     select unit
| {{yes}}
|-
|     select unit (2x2)
| {{yes}}
|-
|     movement
| {{yes}}
|-
|     movement (2x2)
| {{yes}}
|-
|     shoot weapons
| {{yes}}
|-
|     shoot weapons at target unit
| {{yes}}
|-
|     use items
| {{yes}}
|-
|     throw items
| {{yes}}
|-
|     fire projectile with occlusion
| {{yes}}
|-
|     hit units
| {{yes}}
|-
|     hit terrain
| {{yes}}
|-
|     damage to units
| {{yes}}
|-
|     fatal wounds
| {{yes}}
|-
|     stun damage
| {{yes}}
|-
|     destroy/degenerate terrain
| {{yes}}
|-
|     Night Mission Darkness
| {{yes}}
|-
|     lighting from terrain lights
| {{yes}}
|-
|     lighting from soldiers
| {{yes}}
|-
|     items equipped to unit hands
| {{yes}}
|-
|     unit built-in/racial items
| {{yes}}
|-
|     explosion
| {{yes}}
|-
|     smoke
| {{yes}}
|-
|     smoke stun
| {{yes}}

|-
| colspan="2" | Equipment
|-
|     ballistic weapons
| {{yes}}
|-
|     Laser weapons
| {{yes}}
|-
|     plasma weapons
| {{yes}}
|-
|     small/rocket launcher
| {{yes}}
|-
|     blaster launcher
| {{yes}}
|-
|     grenades
| {{yes}}
|-
|     Psi-Amps
| {{yes}}
|-
|     First Aid Kit
| {{yes}}
|-
|     motion scanner
| {{yes}}
|-
|     mind probe
| {{yes}}

|-
| colspan="2" | Weapon effects/functions
|-
|     grenade prime state/timer
| {{yes}}
|-
|     grenade explosion
| {{yes}}
|-
|     electro-flare
| {{yes}}
|-
|     projectile launch
| {{yes}}
|-
|     damage on impact
| {{yes}}
|-
|     explode on impact
| {{yes}}
|-
|     waypointed missle
| {{yes}}
|-
|     unit moral
| {{yes}}
|-
|     psy-panic
| {{yes}}
|-
|     psy control
| {{yes}}
|-
|     first aid
| {{yes}}
|-
|     motion sensing
| {{yes}}
|}

[[Category:OpenXcom]]

User talk:Kkmic

2012-11-28T12:59:44Z

Kkmic: Tested tables

Testbed

{| class="wikitable"
|-
! Version !! Release date !! Changes
|-
| '''0.1''' || [http://openxcom.org/index.php/2010/10/version-0-1-is-here/ October 17th, 2010] ||
* Engine
* Geoscape
* Basescape
|-
|'''0.2''' || [http://openxcom.org/index.php/2011/01/version-0-2-is-out/ January 28th, 2011] ||
* Language strings
* Saved games
* Battlescape
** Terrain generation
** Basic units
** Basic pathfinding, fog of war, lighting
|-
|'''0.3''' || [http://openxcom.org/index.php/2011/09/holy-crap-its-version-0-3/ September 1st, 2011] ||
* Items
* Purchasing
* Selling
* Transferring
* Ufopaedia
* Options
* Platform-specific Folders
* Battlescape
** Item equipping, firing, throwing
** Environment: fire, smoke, explosions, damage, kills
** Unit stats
** AI Phase 1 (patrol, aggro)
|-
|'''0.4''' || [http://openxcom.org/index.php/2012/08/incoming-version-0-4/ August 14th, 2012] ||
* Research
* Manufacture
* Rulesets
* Battlescape
** Terror sites
** Debriefing, scores, experience and skill ups
** Large units and other alien units
** Special items (medi-kit, motion sensor, proximity grenade, psi-amp, mind probe, blaster launcher, electroflare)
|-
| '''0.45''' || [http://openxcom.org/index.php/2012/11/the-handymens-version/ November 5, 2012] ||
*Ufopaedia
*Modular rulesets
*New options
*Man page / command-line help
*Logging
|-
| '''0.5''' || (unreleased) ||
* Graphs
* Victory/Defeat
* Battlescape
** More alien units
** Alien base and X-Com base missions
** AI Phase 2 (grenades, blaster launcher, taking cover)
|}

User talk:Kkmic

2012-11-28T12:45:15Z

Kkmic:

User talk:Kkmic

2012-11-28T12:41:38Z

Kkmic: Created page with "Testbed {| class="wikitable" |- ! Version !! Release date !! Changes |- | '''0.1''' || [http://openxcom.org/index.php/2010/10/version-0-1-is-here/ October 17th, 2010] || Example |}"

Testbed

{| class="wikitable"
|-
! Version !! Release date !! Changes
|-
| '''0.1''' || [http://openxcom.org/index.php/2010/10/version-0-1-is-here/ October 17th, 2010] || Example
|}