UFOpaedia - User contributions [en]

MCD

2025-05-25T23:50:22Z

Warboy1982: removed hypothetical context for unused variables

{{tocright}}MCD (Map Control Data) files, which are stored in the [[TERRAIN]] folder, contain multiple 62-byte records that define the tiles that make up a given terrain. For example, BARN.MCD defines a number of terrain items such as walls, haybales, floors and ceilings, while DESERT.MCD defines things like sand (ground tiles), sand dunes, rocks, and cacti.

Each MCD file is accompanied by a [[Image_Formats#PCK|PCK and a TAB file]] with the same filename. These contain the image data referenced by the MCD itself. The tiles within the MCD files are referenced by both the files in the [[MAPS|MAPS folder]] and [[MAP.DAT]], in order to create "map modules"; these are then grouped together at run-time to create randomly generated battlescapes.

Often, more than one MCD file will be required to represent a given map. For example, farms are made using tiles from both the CULTIVAT (fields) and BARN (farmhouse) sets.

 
==Usage==
At run-time, a collated MCD array is created from the smaller sets stored in this folder. In order, this is made up of:

* BLANKS.MCD (two records, the first of which is the black tiles rendered outside of the "map boundaries", and the second of which is the burnt dirt resulting from explosions).
* The set(s) corresponding to the terrain (for example, the MCD files corresponding to the desert or forest areas).
* The set corresponding to the X-COM dropship, if one is present on the map.
* The set(s) corresponding to the alien craft, if one is present on the map.

This large table may never exceed 256 total entries (or the game will crash). For example, you can't have an X-COM and an alien craft present in an urban map; this will result in a "too many map-codes" error.

The [[MAPS|associated map modules]] are also loaded into a [[MAP.DAT|single large map array]], with the tile indexes modified to account for the re-positioning caused by appending the MCD tables together. For example, a wall tile in the Supply Ship MCD file might be the second record, and that's what the map module file will index to (well, that plus 2, but see the [[MAPS]] page for more on that): However, after appending the Supply Ship MCD file to the end of the collated MCD array, that wall tile might now be index number two hundred!

Likewise, any tile indexes within the collated MCD files themselves, or to the associated PCK sprites (which are ''also'' collated into a single array), need to be "updated" in the same way (tile indexes within the MCD structure are at offsets [[#44|44]] and [[#46|46]] of each record).

Because the collated MCD array can be (mostly) recreated at any time, it is not written to the hard drive when the user saves the game mid-battle. This has a side effect of causing [[Known_Bugs#Door_jam|doors to stick open]], as offset [[#47|47]] won't be correctly tracked.

==Structure==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0-7
!0x00-0x07
|Animation of the tile.

The eight bytes refer to images on the PCK files which are used in a sequence (from the first byte to the last) to animate tiles. This animation is used by several tiles on both games, such as doors (see [[#46|[46]]]), bubbles on TFTD, blinking lifts, etc. If all eight frames are the same, it's a static tile.
|- valign="top"
!8-19
!0x08-0x13
|Line Of Fire Template (LOFT) for the tile. 12 values, each references into [[LOFTEMPS.DAT]] file.

Each LOFT record is a 16x16 grid; these are stacked one over the other, with mcd[8] being the bottom. Used to create a 3D map (16x16x12) of the tile, for LOS. For more info, see [[LOFTEMPS.DAT]].
|- valign="top"
!20-21
!0x14-0x15
|Reference into [[SCANG.DAT]] file. Two-byte integer ([20] + [21] * 256 + 35 = offset). 4x4 bmp images for the top-down map; see [[SCANG.DAT]].
|- valign="top"
!22-25
!0x16-0x19
|Four byte value pointing to the RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the terrain file. Only used at run-time.
|- valign="top"
!26-29
!0x1A-0x1D
|Four byte value pointing to the RAM location of the [[Image_Formats#PCK|PCK set]] used by the terrain file. Only used at run-time.
|- valign="top"
!30
!0x1E
|Boolean: Is sliding door? See [[#46|[46]]].
|- valign="top"
!31
!0x1F
|Boolean: Blocks visibility of terrain? AKA LOS (Line Of Sight)
0 = False = Doesn't block visibility.
1 = True = Blocks visibility.
Visibility of units is blocked by voxels formed with [[LOFTEMPS.DAT]].
Note that floor tiles always block visibility of terrain, although their flag is 0, but it's ignored for floor tiles.
|- valign="top"
!32
!0x20
|Boolean: Can't be stood on? For ground tiles: non-flying units fall through. ''Only two ground tiles have this set: BLANKS MCD id 0 and UFO1 MCD id 0''
|- valign="top"
!33
!0x21
|Boolean: Is Wall? Used for Objects intended to act as Walls; used to make UFO, Skyranger, and Avenger outer "walls" that aren't otherwise possible as "real" North or West walls. If that sounds ambiguous, that's because no one's worked out what it actually does; whether an object can be walked on/through depends on it's TU cost ([[#39|[39]]]) and height ([[#48|[48]]]). Called "BigWall" in [[MapView]].
|- valign="top"
!34
!0x22
|Boolean: Is Grav lift? Up/down of lifts is determined by whether there is another one above or below in the .MAP.
|- valign="top"
!35
!0x23
|Boolean: Is hinged door? See [[#46|[46]]].
|- valign="top"
!36
!0x24
|Boolean: Blocks fire?
|- valign="top"
!37
!0x25
|Boolean: Tile blocks smoke (or a "gas" type which was never implemented) from spreading. Used in smoke propagation routine.
|- valign="top"
!38
!0x26
|Always 3. Defined as "printype"; 3=whole, 2=right side, 1=left side. Since this is always 3 the game prints the entire object, while the assumption is that values of 2 or 1 are possibly used for the map designer. But the actual game totally ignores this value.
|- valign="top"
!39
!0x27
|Time units used to walk across the tile (255 means unpassable).
|- valign="top"
!40
!0x28
|Time units used to slide across the tile (255 means unpassable).
|- valign="top"
!41
!0x29
|Time units used to fly across the tile (255 means unpassable).
|-
|colspan="3"|For [[#39|[39]]] to [[#41|[41]]], values range from 0 to 8, or are 255. There are only a few places where they are not all the same ([[#39|[39]]]=[[#40|[40]]]=[[#41|[41]]]):

Walk Slide Fly File Description

2 0 2 Avenger Middle ramp object

255 255 4 Arctic Water pools in ice (18 ground MCDs)

2 2 0 U_Base Death ''objects'' for large round containers in alien bases (four quadrants)...
thus, their remnants don't ''add'' TUs for fliers

1 1 0 U_Base Little green plant objects found on black "base garden" flooring

2 2 0 Urbits Two death objects (splinters on ground) for city's tall green picket fence
(one is a North-wall fence, the other is a West-wall fence)

Which of the three movement types a given unit uses is determined by [[UNITREF.DAT#11|UnitRef[11]]]. Note that by default, ALL units are "walkers".
|- valign="top"
!42
!0x2A
|Armor of tile.

*Tile must take this amount of damage to be destroyed, at which point it changes to a tile set according to [[#44|[44]]].
*Terrain items do not "remember" damage (like units); terrain is either destroyed in a single blast/shot (if damage >= armor) or not.
*Some things are set to 255 to mean "indestructible" but actually, anything >100 is indestructible in a non-hacked game, and anything >127 (for explosives, 255/2) or >191 (firearms, 255x.75) cannot be destroyed, even in a hacked game (see [[Damage]] re: Damage to terrain).
*With explosions, all four terrain items in the tile are hit by the same strength, but firearm shots target only one of them.
*For a loopy exception to explosions being equally applied (due to erroneous data), see [[Explosions#Mile-High Madness|Mountain Madness]].
*''[[User:NKF|NKF]]:'' I suppose you could make a gate out of this by creating two tiles, each easily destroyed, which change to the other when hit. One could be walked across, the other could not.
|- valign="top"
!43
!0x2B
|[[Explosions#HE Block|HE Blockage]]
|- valign="top"
!44
!0x2C
|Tile becomes a tile of this type (i.e., this other MCD record in the same MCD file) when destroyed. Also known as the '''death tile'''. Also see [[#53|[53]]].

'''Note:''' If [44]=0, it means there is no death tile per se; it reverts to a "raw earth" (BLANKS[01]) tile if on ground, or nothing if in air. (It does not revert to the MCD id 0 record in the current collection.)
|- valign="top"
!45
!0x2D
|Flammability - the higher this is, the less likely the tile will be set on fire.
|- valign="top"
!46
!0x2E
|If the tile is a door ([[#30|[30]]] or [[#35|[35]]]), the tile will become this tile number when opened. Animation [0] (see [[#0-7|[0-7]]]) is shown until someone walks through the door, in which case it cycles through its animation stopping and holding Animation [7]. Then it will return to a closed door next turn.
|- valign="top"
!47
!0x2F
|Flags 1 for the "open" version of a sliding door if a door of that type was opened this turn (hence notifying the game that it needs to search the map for doors to close on the next). Because this value is only used at run-time, and the collated MCD array is not written to disk if the player saves the game, reloading while sliding doors are open will [[Known_Bugs#Door_jam|cause them to jam]] until another door of the same type is opened.
|- valign="top"
!48
!0x30
|Signed value, usually negative; add this to the graphical Y offset of units or objects on this tile (adding a negative is the same as subtracting, and the lower the Y offset is, the higher the unit will appear on-screen). The value is relative to the level the tile is placed on, so it's usually 0 (meaning "at the same level").

A unit may only step from one tile to another if the effective difference in tile heights are 8 or less. For example, ground level is at 0, while the lower segment of a staircase will typically have this set to -8 and the higher segment at -16. A soldier can step onto the lower segment from the ground, then onto the upper segment, then finally onto the next level above. He cannot step directly from the ground to the upper staircase, let alone to the next level, as it's too great a "jump" to perform in a single movement.

The effective difference between levels on the map is 24.
|- valign="top"
!49
!0x31
|Subtract this value from the graphical Y offset of the tile image (used for hills).
|- valign="top"
!50
!0x32
|Received damage modifier type (taken from [[Damage#Damage_Modifiers|Damage modifier table]]) - Always 0.
|- valign="top"
!51
!0x33
|?????? OpenXCom and MCDEditor call this 'light block'. Note that the actual game seems to ignore this value.
|- valign="top"
!52
!0x34
|Footstep sound effect. Most likely an index to the .CAT file RAW wave ''-[http://www.strategycore.co.uk/forums/Map-Control-Data-MCD-long-Post-t1468.html BladeFireLight]
0 Not used in XCOM (makes a metal sound if hacked); is used on TFTD for some objects
1 Metal
2 Normal (Grass, Wood, Dirt)
3 Three mountain ground tiles, and some city apt. furniture objects that can't be
walked on? (six furniture objects might've been - but they're death tiles that
nothing points to.) Uses same sound as 6 in DOS version.
4 Pool of water (Not used in XCOM)
5 Sand (Desert)
6 Martian ground (DOS version), snow (CE version)
7 Snow (only DOS version, Not used in XCOM, Arctic terrain actually uses 2)
|- valign="top"
!53
!0x35
|Tile type:
0 Floor
1 West Wall
2 North Wall
3 Object

In the map, there are four bytes per tile: One each for the floor, west wall, north wall and object. If one of those changes (eg is destroyed, or in the case of a door, opened), it is removed from the map and a new object is placed instead. This byte is used to work out which of the four map bytes should recieve the new object.

For example, in the mountains, if you destroy the ground tile you get an object (tree stump). The new tile gets written into the fourth byte of the map record, even though the original tile that was destroyed belonged in the first byte.

As for the potential for change in tile type when becoming death tile ([[#44|[44]]]): There are 22 instances of [[Explosions#Mile-High Madness|Mountain Madness]] (ground to object), 1 instance of North Wall becoming an object (XCOM1 northwall door becomes rubble), one MCD record with tile type of '''10''' (Barn 7 which looks like a North Wall and becomes northwall when killed; obviously a typo'd Tile Type), and 31 total instances on 18 different tilesets where objects become ground upon dying (probably to "scorched earth", but this was not checked).
|- valign="top"
!54
!0x36
|Explosive type; [[#55|[55]]] must be >0:
0 HE
1 Smoke
''Notes:''
#To see explosive objects in XCOM, see [[Explosions#Explosive Map Objects]].
#Type 0 (HE) explosions follow the usual rules for [[explosions]] (average damage to units decreases by 10 per tile outward, etc.).
#Hackers: Type 0 (HE) terrain items with little or no armor ([[#42|[42]]]=0) are obliterated before exploding (i.e., they won't explode, no matter how high [[#55|[55]]] is). Probably also depends on whether it was a very big blast relative to the armor.
#Chain reactions are exceedingly difficult to set up (per Hobbes). Most of the time when you see e.g. the four sections of the Navigator's table explode, it's because you used explosives that actually set off each one individually. It has to do with a balance of, among other things, not obliterating the object (see previous point).
#Type 1 (Smoke) explosives are strange, and mainly only affect aliens - and very haphazardly at that. XCOM units are only very rarely affected; I could only get it to work if they were 1) unarmored, 2) on a diagonal, and 3) no other objects are "in the way" between the blast moving "over and up" or "up and over" to the diagonal (blast propagation never moves directly diagonally per se; see [[Explosions#Playing With Fire]]). ''-MTR''
#Chain reactions are not possible with Type 1 (Smoke) explosive objects.
#Also, when dealing with smoke damage, remember that if there is already tons of smoke on the map (filling up the smoke table) such that no new smoke can appear, you might get unexpected results (or no effect). ''[[user:Hobbes|Hobbes]]:'' One strange thing that can happen when there's already too much smoke on the map and an object with [54]=1 explodes is that the alien dies and in the dying animation there's smoke on that square. ''Just in the dying animation, not after he's down? -MTR'' - ''I can't remember right now if the smoke remains afterward. Next time it happens I will check it [[User:Hobbes|Hobbes]] 12:00, 18 Nov 2005 (PST)''
#There are no "naturally occurring" HE explosives tiles in UFO. All explosive objects are MCD[54]=1.
#The game show values of 0=not explosive, 1=normal (which I assume is HE), 2=gas (again, unused feature).
#TFTD uses both values for [54], 0 (more common, like the barrels on Port) and 1 (the Synomium device on Grunge/Artifact Site).
|- valign="top"
!55
!0x37
|Strength of explosion when tile is destroyed.
|- valign="top"
!56
!0x38
|?????? This is set to 0 for all UFO tiles!
Called "gasblock" by OpenXCom and SmokeBlock by MCDEditor. Note that the actual game seems to ignore this value.
|- valign="top"
!57
!0x39
|Fuel. The amount of turns this tile will burn for.
|- valign="top"
!58
!0x3A
|Brightness of tile. Amount of light produced.

11 MCDs produce light: 7 alien base objects (several pulsing fuel pods and several 4-part round "museum containers"), 2 XCOM base ground tiles, and 2 city objects (street lamp and large standing room lamp). See [[Night_Missions#Artificial_Lighting|Night Missions]] for pictures. Oddly, values range from 1 for the street lamp to 16 for the alien base museum containers, so lower values must be brighter. The [[Night Missions|distances]] of projected light have yet to be determined, but note that flares and personal lighting ignore vertical distance... at night, a soldier can see aliens on the ground exactly 9 tiles away, regardless of whether the soldier is at ground level or 4 levels high.

''In practise, it seems if this is not zero then the tile will be fully illuminated regardless of the value. - [[User:Bomb Bloke|Bomb Bloke]] 06:48, 20 June 2008 (PDT)''
|- valign="top"
!59
!0x3B
|Special properties of tile. Determines what is salvaged at end of mission. Note that some are not actually used within their respective games:

UFO TFTD TFTD (per MapView)
0: ''No Special Properties'' 0: ''No Special Properties'' 0: ''No Special Properties''
1: Entry Point 1: Entry Point 1: Entry Point
2: [[UFO Power Source]] 2: [[Ion-Beam Accelerators]] 2: [[Ion-Beam Accelerators]]
3: [[UFO Navigation]] 3: [[Magnetic Navigation]] 3: "Destroy Objective"
4: [[UFO Construction]] 4: [[Alien Sub Construction]] 4: [[Magnetic Navigation]]
5: [[Alien Food]] 5: [[Alien Cryogenics]] 5: [[Alien Cryogenics]]
6: [[Alien Reproduction]] 6: [[Alien Cloning]] 6: [[Alien Cloning]]
7: [[Alien Entertainment]] 7: [[Alien Learning Arrays]] 7: [[Alien Learning Arrays]]
8: [[Alien Surgery]] 8: [[Alien Implanter]] 8: [[Alien Implanter]]
9: [[Examination Room]] 9: [[Examination Room (TFTD)|Examination Room]] 9: "Unknown9"
10: [[Alien Alloys]] 10: [[Aqua Plastics]] 10: [[Aqua Plastics]]
11: [[Alien Habitat]] 11: [[Alien Re-animation Zone]] 11: [[Examination Room (TFTD)|Examination Room]]
12: Dead Tile 12: Dead Tile 12: Dead Tile
13: Exit Point 13: Exit Point 13: Exit Point
14: Alien Brain 14: T'leth Power Cylinders 14: T'leth Power Cylinders

Notes:
* The images in the TFTD in-game UFOpedia do NOT match the tile-types you'll recover from the battlescape. For example, the [[Dreadnought]] has tiles which match the UFOpedia entries for the [[Magnetic Navigation]] systems - but they're really [[Alien Sub Construction]] units, or so your Alien Sub recovery team will tell you! Daishiva's [[MapView]] presents tiles according to the UFOpedia, hence the additional column.
* The "entry points" are where your troopers spawn at the start of the map. If you wish to safely abort, your solders must return to those tiles first.
* The "exit points" are where soldiers must be if you wish to proceed to the next stage of a [[Two Part Missions|two-part mission]] without killing all aliens (by aborting instead).
* The Brain and Power Cylinder tiles must be destroyed in the final mission, in order to win ''UFO:EU'' and ''TFTD'' respectively.
* In ''UFO:EU'', [[Alien Reproduction]] and [[Alien Habitat]] tiles never appear. [[Alien Reproduction]] tiles do have a UFOpedia entry that can be accessed by hacking those units into your stores, but [[Alien Habitat]] tiles do not.
* In ''TFTD'', [[Examination Room (TFTD)|Examination Room]] tiles never appear. They do have a UFOpedia entry that can be accessed by hacking those units into your stores, however. [[Alien Re-animation Zone]] tiles can be found naturally, but have no research entry.
|- valign="top"
!60
!0x3C
|Set to 1 for [[Base_Defence#Destruction_Of_Base_Facilities|some]] X-COM base tiles, 0 otherwise. At the end of the battle, the game tallies up the amount of these existing within each "module" of the base (the results are stored in [[MISSION2.DAT]], offsets 80-151) - if the end result for any given module is 0, [[Base_Defence#Destruction_Of_Base_Facilities|it may be destroyed]].

If an alien patrols to a route node which has [[ROUTES.DAT#21|offset [21]]] flagged as anything other then 0, it will intentionally shoot at any tiles with ''this'' offset likewise flagged. If you're playing a CE version of UFO/TFTD the game will then crash immediately afterwards... either way, best not to let them go up the stairs to where these objects can be found. ;)
|- valign="top"
!61
!0x3D
|Unused. Almost half (560 of 1317) MCD records have widely varying values here, from 1 to 255 with no apparent pattern or preferred value. The remaining MCD records are 0. Called "VPs" by the game, this was supposed to be a victory point value for recovery/destruction. It's not actually used.
|-
|}

==List of MCD Files==
Here are the MCD files in Enemy Unknown and Terror From The Deep along with a list of the number of records in each one. Refer to [[TERRAIN]] for more info on their usage in-game (load orders etc):
<table cellpadding="10">
<tr><td valign="top">
<table {{StdCenterTable}} class="sortable">
<caption>X-COM MCD Files</caption>
<tr {{StdDescTable_Heading}}><th width="100" align="left">File</th><th>Terrain</th><th>Records</th></tr>
<tr><td align="left">avenger</td><td>Avenger</td><td>59</td></tr>
<tr><td align="left">barn</td><td>Farm</td><td>29</td></tr>
<tr><td align="left">blanks</td><td>All</td><td>2</td></tr>
<tr><td align="left">brain</td><td>Alien Base</td><td>4</td></tr>
<tr><td align="left">cultivat</td><td>Farm</td><td>37</td></tr>
<tr><td align="left">desert</td><td>Desert</td><td>66</td></tr>
<tr><td align="left">forest</td><td>Forest</td><td>83</td></tr>
<tr><td align="left">frniture</td><td>City</td><td>26</td></tr>
<tr><td align="left">jungle</td><td>Jungle</td><td>82</td></tr>
<tr><td align="left">lightnin</td><td>Lightning</td><td>42</td></tr>
<tr><td align="left">mars</td><td>Cydonia</td><td>36</td></tr>
<tr><td align="left">mount</td><td>Mountain</td><td>78</td></tr>
<tr><td align="left">plane</td><td>Skyranger</td><td>65</td></tr>
<tr><td align="left">polar</td><td>Polar</td><td>81</td></tr>
<tr><td align="left">roads</td><td>City</td><td>23</td></tr>
<tr><td align="left">ufo1</td><td>Small Scout</td><td>20</td></tr>
<tr><td align="left">urban</td><td>City</td><td>112</td></tr>
<tr><td align="left">urbits</td><td>City</td><td>25</td></tr>
<tr><td align="left">u_base</td><td>Alien Base</td><td>67</td></tr>
<tr><td align="left">u_bits</td><td>UFOs</td><td>8</td></tr>
<tr><td align="left">u_disec2</td><td>UFOs</td><td>17</td></tr>
<tr><td align="left">u_ext02</td><td>UFOs</td><td>34</td></tr>
<tr><td align="left">u_oper2</td><td>UFOs</td><td>15</td></tr>
<tr><td align="left">u_pods</td><td>UFO/Alien Base</td><td>11</td></tr>
<tr><td align="left">u_wall02</td><td>UFO/Alien Base/Cydonia</td><td>47</td></tr>
<tr><td align="left">xbase1</td><td>X-COM Base</td><td>97</td></tr>
<tr><td align="left">xbase2</td><td>X-COM Base</td><td>62</td></tr></table>
</td>
<td>
<table {{StdCenterTable}} class="sortable">
<caption>TFTD MCD Files</caption>
<tr {{StdDescTable_Heading}}><th width="100" align="left">File</th><th>Terrain</th><th>Records</th></tr>
<tr><td align="left">asunk</td><td>Sunken Galleon</td><td>50</td></tr>
<tr><td align="left">atlantis</td><td>Atlantis</td><td>77</td></tr>
<tr><td align="left">barracud</td><td>Barracuda</td><td>46</td></tr>
<tr><td align="left">blanks</td><td>All</td><td>2</td></tr>
<tr><td align="left">cargo1</td><td>Cargo Ship</td><td>103</td></tr>
<tr><td align="left">cargo2</td><td>Cargo Ship</td><td>13</td></tr>
<tr><td align="left">cargo3</td><td>Cargo Ship</td><td>6</td></tr>
<tr><td align="left">coral</td><td>Coral</td><td>28</td></tr>
<tr><td align="left">crypt1</td><td>Crypt</td><td>45</td></tr>
<tr><td align="left">crypt2</td><td>Crypt</td><td>49</td></tr>
<tr><td align="left">crypt3</td><td>Crypt</td><td>12</td></tr>
<tr><td align="left">crypt4</td><td>Crypt</td><td>7</td></tr>
<tr><td align="left">debris</td><td>Seabed</td><td>50</td></tr>
<tr><td align="left">deckc</td><td>Liner Ship (Top)</td><td>18</td></tr>
<tr><td align="left">entry</td><td>Entry</td><td>12</td></tr>
<tr><td align="left">grunge1</td><td>Artifact Site</td><td>38</td></tr>
<tr><td align="left">grunge2</td><td>Artifact Site</td><td>8</td></tr>
<tr><td align="left">grunge3</td><td>Artifact Site</td><td>10</td></tr>
<tr><td align="left">grunge4</td><td>Artifact Site</td><td>37</td></tr>
<tr><td align="left">hammer</td><td>Hammerhead</td><td>44</td></tr>
<tr><td align="left">island1</td><td>Island</td><td>50</td></tr>
<tr><td align="left">island2</td><td>Island</td><td>50</td></tr>
<tr><td align="left">island3</td><td>Island</td><td>35</td></tr>
<tr><td align="left">leviath</td><td>Leviathan</td><td>47</td></tr>
<tr><td align="left">linera</td><td>Liner Ship</td><td>99</td></tr>
<tr><td align="left">linerb</td><td>Liner Ship</td><td>24</td></tr>
<tr><td align="left">linerc</td><td>Liner Ship</td><td>40</td></tr>
<tr><td align="left">linerd</td><td>Liner Ship</td><td>23</td></tr>
<tr><td align="left">manta</td><td>Manta</td><td>44</td></tr>
<tr><td align="left">msunk1</td><td>Sunken Ship</td><td>50</td></tr>
<tr><td align="left">msunk2</td><td>Sunken Ship</td><td>29</td></tr>
<tr><td align="left">mu</td><td>Mu</td><td>80</td></tr>
<tr><td align="left">organic1</td><td>Alien Base/Level/Entry</td><td>96</td></tr>
<tr><td align="left">organic2</td><td>Alien Base/Level</td><td>10</td></tr>
<tr><td align="left">organic3</td><td>Alien Base/Level</td><td>4</td></tr>
<tr><td align="left">pipes</td><td>Pipes</td><td>55</td></tr>
<tr><td align="left">planes</td><td>Sunken Plane</td><td>79</td></tr>
<tr><td align="left">port01</td><td>Port</td><td>95</td></tr>
<tr><td align="left">port02</td><td>Port</td><td>78</td></tr>
<tr><td align="left">psynom</td><td>Alien Base/Level</td><td>2</td></tr>
<tr><td align="left">pyramid</td><td>Artifact</td><td>24</td></tr>
<tr><td align="left">rocks</td><td>Artifact/Seabed/Galleon</td><td>15</td></tr>
<tr><td align="left">sand</td><td>several</td><td>20</td></tr>
<tr><td align="left">sea</td><td>several</td><td>18</td></tr>
<tr><td align="left">triton</td><td>Triton</td><td>46</td></tr>
<tr><td align="left">uext1</td><td>?</td><td>4</td></tr>
<tr><td align="left">uext2</td><td>Alien Sub/Entry</td><td>9</td></tr>
<tr><td align="left">uext3</td><td>Alien Sub/Entry</td><td>25</td></tr>
<tr><td align="left">ufobits</td><td>several</td><td>5</td></tr>
<tr><td align="left">uint1</td><td>Alien Sub</td><td>41</td></tr>
<tr><td align="left">uint2</td><td>Alien Sub</td><td>11</td></tr>
<tr><td align="left">uint3</td><td>Alien Sub</td><td>14</td></tr>
<tr><td align="left">volc</td><td>Volcanic</td><td>80</td></tr>
<tr><td align="left">weeds</td><td>Artifact/Coral/Seabed</td><td>10</td></tr>
<tr><td align="left">xbases1</td><td>X-COM Base</td><td>87</td></tr>
<tr><td align="left">xbases2</td><td>X-COM Base</td><td>42</td></tr>
<tr><td align="left">xbases3</td><td>X-COM Base</td><td>37</td></tr>
<tr><td align="left">xbases4</td><td>X-COM Base</td><td>43</td></tr>
<tr><td align="left">xbases5</td><td>X-COM Base</td><td>42</td></tr>
<tr><td align="left">xbits</td><td>Cargo Ship</td><td>39</td></tr></table>
</td></tr></table>

==Additional Information==

===MikeTheRed's MCD Database===
An Access 2000 copy of all MCD data is [[Media:XcomMCD.zip|here]]. It's from X-COM DOS 1.4, but AFAIK, all X-COM versions use the same data (even down to the buggy [[Explosions#Mile-High_Madness|Mile-High Madness]] MCD record). You will need to use this wiki page to understand it; I did not name the fields. They're just called by their offset address (see above). This Access database can be readily exported to Excel if you want. Or contact me. There are also a few files giving overall stats; the "Exclude" field for tblFileTypes only means, I excluded them for most counts I've made. There are also a few queries that might or might not be helpful.

===BladeFireLight's MCD Info===
Another in-depth look at MCD (and more) can be found on [http://www.strategycore.co.uk/forums/lofiversion/index.php?t1468.html this] message by BladeFireLight. His post also contains a [http://www.HexWorkshop.com HexWorkshop] template for viewing MCD files in a logical manner.

===MCD Editor===
Koralt's MCDEdit can view or modify MCD files. Find it here: [http://mypage.bluewin.ch/xcom/mcdedit.zip mcdedit.zip]. To see a screencap, scroll to the very bottom of BladeFireLight's MCD posting (above). MCDEdit needs [http://mypage.bluewin.ch/xcom/vbrun200.zip vbrun200] to run!

There's also [[MCDEdit|MCDEdit made by volutar]]. It doesn't need of any extra library and works in windows x64.

===MapView===
DaiShiva has an excellent utility called [http://www.daishiva.com/phpBB2/generic.php?page=progLinks.shtml MapView] for viewing or editing maps. However, it does not allow editing of MCD terrain items per se, AFAIK; just moving/placement of them. Caution: You must install the extensive Microsoft .NET platform to use MapView; see DaiShiva's site.

===BombBloke's Hacked Desert Terrain===
[[User:Bomb Bloke|Bomb Bloke]] has a numerical (ground) tileset which makes weapon damage blast testing easy as pie. It also has a little applet that lets you edit MCD variables Armor [[#42|[42]]], HE Block [[#43|[43]]], and Explosion Strength [[#55|[55]]] (but not type, [[#55|[54]]]), and it includes all four types of terrain item. Find his hacked terrain
[http://www.strategycore.co.uk/forums/index.php?showtopic=746&st=195&# here] or bundled with a savegame [http://www.xcomufo.com/forums/index.php?showtopic=8701&st=114&# here]. To see a screencap of the tiles in action, see [http://www.xcomufo.com/forums/index.php?showtopic=8701&st=112&# this] message.

[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]
[[Category:TFTD]]

Talk:Innate Weapons (TFTD)

2020-08-03T07:29:15Z

Warboy1982:

== Snap accuracy of the sonic turret ==

The sonic turret's snap accuracy is listed here as 86, but the articles [[Displacer /Sonic]], [[Bio-Drone]] and [[Triscene]] all say that the snap accuracy is 85. Does anyone know what the correct value is, 86 or 85? [[User:Player701|Player701]] ([[User talk:Player701|talk]]) 07:29, 18 April 2020 (UTC)
: it's 86 -- [[User:Warboy1982|Warboy1982]]

== Accuracy validation for waypoint weapon ==
The used accuracy for waypoint weapons is 60, not 50 (xc_BF_Missile_Waypoint_Mode():line 115: v_BF_accuracy = 60;) -- [[User:Warboy1982|Warboy1982]]

Talk:Innate Weapons (TFTD)

2020-08-02T15:31:39Z

Warboy1982: /* Snap accuracy of the sonic turret */

== Snap accuracy of the sonic turret ==

The sonic turret's snap accuracy is listed here as 86, but the articles [[Displacer /Sonic]], [[Bio-Drone]] and [[Triscene]] all say that the snap accuracy is 85. Does anyone know what the correct value is, 86 or 85? [[User:Player701|Player701]] ([[User talk:Player701|talk]]) 07:29, 18 April 2020 (UTC)
: it's 86 -- [[Warboy1982|Warboy1982]]

== Accuracy validation for waypoint weapon ==
The used accuracy for waypoint weapons is 60, not 50 (xc_BF_Missile_Waypoint_Mode():line 115: v_BF_accuracy = 60;) -- [[Warboy1982|Warboy1982]]

Innate Weapons (TFTD)

2020-08-02T15:31:27Z

Warboy1982: Undo revision 95047 by Warboy1982 (talk)

== Innate Weapons ==

Innate weapons, or built-in weapons are attached to X-Com SWS and Alien Terror Units. This section lists the data for all of the innate weapons found in the Terror From The Deep game executables.

'''Note:''' All accuracy values are the base value before they are modified by the unit attributes and difficulty level modifiers.

{| {{stdTable}} width="90%" border="1" cellpadding="3"
|- {{stdTable Sub_Heading}}
| colspan="10" | Innate Weapons (TFTD)
|-
! BigObs Index
! Used by
! Damage
! Snap Acc%
! Snap TU%
! Auto Acc%
! Auto TU%
! Aimed Acc%
! Aimed TU%
! Waypoint
|-
| 4 / 0x04
| [[Coelacanth/G. Cannon|Coelacanth/Gas Cannon]]
| 60 AP1
| 60
| 30
| 0
| 0
| 90
| 80
| No
|-
| 12 / 0x0C
| [[Coelacanth/Aqua Jet]]
| 85 HE1
| 55
| 45
| 0
| 0
| 115
| 75
| No
|-
| 17 / 0x11
| [[Coelacanth/Gauss]]
| 110 Gauss
| 50
| 33
| 0
| 0
| 85
| 75
| No
|-
| 36 / 0x24
| [[Displacer /Sonic|Displacer/Sonic]] 
[[Bio-Drone]] 
[[Triscene]]
| 110 Sonic1
| 86
| 30
| 0
| 0
| 100
| 60
| No
|-
| 40 / 0x28
| [[Displacer /P. W. T.|Displacer/PWT]]
| 140 HE
| 0
| 0
| 0
| 0
| 1202
| 802
| Yes
|-
| 38 / 0x26
| Unused3
| 140 Electric Shock
| 75
| 30
| 0
| 0
| 110
| 60
| No
|-
| 34 / 0x22
| [[Xarquid]]
| 130 Sonic
| 75
| 30
| 0
| 0
| 110
| 60
| No
|-
| 34 / 0x22
| [[Deep One]]4
| 100 Gauss5
| 75
| 30
| 50
| 35
| 110
| 60
| No
|}

:1 These values do not agree with their numbers reported in the Ufopedia.

:2: These values are not used by the Displacer/PWT. Instead the costs for waypoint weapons are used. 66% TUs and 60% accuracy respectively.

:3: This weapon slot formerly belonged to the [[Celatid]]. It is not attached to any aliens.

:4: When controlled by the AI and if the selected unit is a Deep One, thrown weapon physics will be applied to this weapon's projectile, treating the projectile as an object with a weight of 10. This allows the projectile to be fired over obstacles like a grenade. Under player control, the standard straight-line targeting will be used.

:5: This damage type is correct.

== See Also ==
{{Equipment (TFTD) Navbar}}

{{Aliens (TFTD)}}

[[Category:TFTD]] [[Category:Data tables]]

Innate Weapons (TFTD)

2020-08-02T15:29:42Z

Warboy1982:

== Innate Weapons ==

Innate weapons, or built-in weapons are attached to X-Com SWS and Alien Terror Units. This section lists the data for all of the innate weapons found in the Terror From The Deep game executables.

'''Note:''' All accuracy values are the base value before they are modified by the unit attributes and difficulty level modifiers.

{| {{stdTable}} width="90%" border="1" cellpadding="3"
|- {{stdTable Sub_Heading}}
| colspan="10" | Innate Weapons (TFTD)
|-
! BigObs Index
! Used by
! Damage
! Snap Acc%
! Snap TU%
! Auto Acc%
! Auto TU%
! Aimed Acc%
! Aimed TU%
! Waypoint
|-
| 4 / 0x04
| [[Coelacanth/G. Cannon|Coelacanth/Gas Cannon]]
| 60 AP1
| 60
| 30
| 0
| 0
| 90
| 80
| No
|-
| 12 / 0x0C
| [[Coelacanth/Aqua Jet]]
| 85 HE1
| 55
| 45
| 0
| 0
| 115
| 75
| No
|-
| 17 / 0x11
| [[Coelacanth/Gauss]]
| 110 Gauss
| 50
| 33
| 0
| 0
| 85
| 75
| No
|-
| 36 / 0x24
| [[Displacer /Sonic|Displacer/Sonic]] 
[[Bio-Drone]] 
[[Triscene]]
| 110 Sonic1
| 85
| 30
| 0
| 0
| 100
| 60
| No
|-
| 40 / 0x28
| [[Displacer /P. W. T.|Displacer/PWT]]
| 140 HE
| 0
| 0
| 0
| 0
| 1202
| 802
| Yes
|-
| 38 / 0x26
| Unused3
| 140 Electric Shock
| 75
| 30
| 0
| 0
| 110
| 60
| No
|-
| 34 / 0x22
| [[Xarquid]]
| 130 Sonic
| 75
| 30
| 0
| 0
| 110
| 60
| No
|-
| 34 / 0x22
| [[Deep One]]4
| 100 Gauss5
| 75
| 30
| 50
| 35
| 110
| 60
| No
|}

:1 These values do not agree with their numbers reported in the Ufopedia.

:2: These values are not used by the Displacer/PWT. Instead the costs for waypoint weapons are used. 66% TUs and 60% accuracy respectively.

:3: This weapon slot formerly belonged to the [[Celatid]]. It is not attached to any aliens.

:4: When controlled by the AI and if the selected unit is a Deep One, thrown weapon physics will be applied to this weapon's projectile, treating the projectile as an object with a weight of 10. This allows the projectile to be fired over obstacles like a grenade. Under player control, the standard straight-line targeting will be used.

:5: This damage type is correct.

== See Also ==
{{Equipment (TFTD) Navbar}}

{{Aliens (TFTD)}}

[[Category:TFTD]] [[Category:Data tables]]

Innate Weapons (TFTD)

2020-08-02T15:28:27Z

Warboy1982:

Talk:Innate Weapons (TFTD)

2020-08-02T15:17:38Z

Warboy1982: /* Snap accuracy of the sonic turret */

== Snap accuracy of the sonic turret ==

The sonic turret's snap accuracy is listed here as 86, but the articles [[Displacer /Sonic]], [[Bio-Drone]] and [[Triscene]] all say that the snap accuracy is 85. Does anyone know what the correct value is, 86 or 85? [[User:Player701|Player701]] ([[User talk:Player701|talk]]) 07:29, 18 April 2020 (UTC)
: it's 85 -- [[Warboy1982|Warboy1982]]

== Accuracy validation for waypoint weapon ==
The used accuracy for waypoint weapons is 60, not 50 (xc_BF_Missile_Waypoint_Mode():line 115: v_BF_accuracy = 60;) -- [[Warboy1982|Warboy1982]]

Zombie (TFTD)

2020-07-31T13:16:41Z

Warboy1982:

Once a [[Tentaculat]] attacks, the victim will turn into a '''zombie''' that becomes a new Tentaculat if it's killed. Zombies cannot be stunned or captured, nor do they ever leave Zombie corpses.

==Statistics==
'''TUs:''' 40
'''Health:''' 84
'''Energy:''' 110
'''Reactions:''' 40
'''Strength:''' 84
'''Bravery:''' 110
'''MC Skill:''' N/A
'''MC Strength:''' 80
'''Armor (all sides):''' 4
'''Energy Recharge:''' 20
'''Victory Points:''' 18
'''Aggression:''' 2
'''Intelligence:''' 3

'''Damage:''' 84
'''Melee:''' 80%
'''TUs:''' 15

==Notes==
[[File:TFTD ZOMBIE24.PNG|200px|right]]

The following are some miscellaneous notes. Zombies:
* Take 0.9x damage from AP, Phosphor, High Explosive, and Sonic ammunitions, and 0.8x damage from Gauss weapons.
* 1.1x damage from melee drills.
* Hit does 1.6x damage to un-armoured Aquanauts and 0.8x damage to SWSs.
* Are not affected by stun weapons. However, they still receive a small portion of [[Stun]] damage from conventional weapons.
* Have a melee attack equal to its strength (strong).
* Are very slow, so they can be outrun.
* Can be mind-controlled.
* Have constant stats regardless of the original human's skills or difficulty level.
* If the killing shot is of an [[Incendiary]] nature, the Tentaculat does not hatch. The corpse generated from killing a Zombie will look like a Tentaculat and the death scream will sound like that of a human.
* Research seems to indicate (in X-COM EU) that if you ''don't'' shoot the zombies, they will never hatch on their own. This, however, is contrary to many eye-witness accounts.
* When you eventually kill it, make sure to have enough soldiers and TUs to kill the resulting Tentaculat too.
* An exploit exists whereby it is possible to gain permanent control of a Tentaculat (see below).
* There is no in game UFOPedia entry for the Zombie, as it can neither be killed nor captured. [[Data corruption]] can provide a Zombie research topic, but this crashes the game.

Note: Not to be confused with [[User:Zombie|Zombie]], the user, Longtime X-COM community member, tactician and number cruncher.

==See Also==
*[[Gaining permanent control of a Chryssalid/Tentaculat]]
*[[Tentaculat]]

{{Aliens (TFTD)}}
[[Category:Alien Life Forms (TFTD)]]
[[Category:TFTD]]

Damage Modifiers (TFTD)

2020-07-31T13:10:32Z

Warboy1982:

Damage modifiers, synonymous with resistances or vulnerabilities, are a percentage that alter the base damage of any particular damage type. Every unit in the game has a table with different percentages assigned to all of the possible damage types. These values make the units vulnerable to or strong against different damage types.

<table width="80%" {{StdCenterTable}}>
<tr {{StdDescTable_Heading}}><th rowspan="2">Ammo Type</th>
<th colspan="14">Damage Modifier Category</th></tr>
<tr {{StdDescTable_Heading}}><th>Ter</th>
<th>Hu+</th>
<th>PAA*</th>
<th>IA</th>
<th>Tnk</th>
<th>DpO</th>
<th>Gil</th>
<th>Tas</th>
<th>Cal</th>
<th>Tnt</th>
<th>Lob</th>
<th>Xar/Bio</th>
<th>Hal</th>
<th>Tri/Zom</th>
<tr><th align="left" {{StdDescTable_Heading}}>Armour Piercing</th><td>100</td><td>100</td><td>90</td><td>80</td><td>95</td><td>90</td><td>100</td><td>80</td><td>100</td><td>80</td><td>20</td><td>100</td><td>60</td><td>90</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Incendiary</th><td>100</td><td>100</td><td>80</td><td>0</td><td>40</td><td>90</td><td>100</td><td>40</td><td>90</td><td>100</td><td>30</td><td>60</td><td>170</td><td>90</tr>
<tr><th align="left" {{StdDescTable_Heading}}>High-Explosive</th><td>100</td><td>100</td><td>100</td><td>80</td><td>80</td><td>80</td><td>100</td><td>90</td><td>100</td><td>150</td><td>30</td><td>60</td><td>70</td><td>90</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Gauss</th><td>100</td><td>100</td><td>80</td><td>70</td><td>60</td><td>90</td><td>100</td><td>70</td><td>90</td><td>90</td><td>30</td><td>70</td><td>80</td><td>80</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Sonic</th><td>100</td><td>100</td><td>100</td><td>90</td><td>100</td><td>110</td><td>110</td><td>120</td><td>110</td><td>110</td><td>50</td><td>90</td><td>100</td><td>90</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Stun(Freeze)</th><td>100</td><td>100</td><td>100</td><td>100</td><td>100</td><td>100</td><td>100</td><td>110</td><td>100</td><td>110</td><td>110</td><td>90</td><td>100</td><td>90</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Drill</th><td>100</td><td>160</td><td>120</td><td>110</td><td>80</td><td>120</td><td>120</td><td>90</td><td>80</td><td>110</td><td>200</td><td>145</td><td>60</td><td>110</tr>
<tr><th align="left" {{StdDescTable_Heading}}>Electric Shock**</th><td>100</td><td>150</td><td>110</td><td>100</td><td>120</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0 </tr></table>

<nowiki>*</nowiki>Due to a bug in the unit spawn routine, Plastic Aqua Armour is instead assigned the modifiers for Ion Armour.

<nowiki>**</nowiki>Nothing in vanilla TFTD actually inflicts Electric Shock damage.

Please note that these are the actual numbers taken directly from the executable, which the game uses. The numbers from the Official Strategy Guide are incorrect.

(For those interested in changing/hacking the creature damage modifiers, they are located in the Tactical.exe near the end of the file, preceded directly by the decimal variable "26" (offset 781F4 in the CE version). They are listed in left to right order as two byte integers, using the table above as a reference - in groups of 14 variables for each ammo type.)

The Numbers listed below are a reference to the damage chart above (there are 14 sets of damage modifiers, numbered 0-13). The creature entries listed in the Geoscape.exe have a variable which points to which set of damage modifiers the creature uses.

{| {{StdDescTable}}
|- {{StdDescTable_Heading}}
! Column !! Unit Type(s)
|-
| '''Ter''' || Terrain
|-
| '''Hu+''' || Unarmored Soldiers, Civilians, Aquatoids
|-
| '''PAA''' || Plastic Aqua Armor
|-
| '''IA''' || Ion Armor and Magnetic Ion Armor
|-
| '''Tnk''' || Coelacanths and Displacers
|-
| '''DpO''' || Deep Ones
|-
| '''Gil''' || Gill Men
|-
| '''Tas''' || Tasoths
|-
| '''Cal''' || Calcinites
|-
| '''Tnt''' || Tentaculats
|-
| '''Lob''' || Lobstermen
|-
| '''Xar/Bio''' || Xarquids and Bio-Drones
|-
| '''Hal''' || Hallucinoids
|-
| '''Tri/Zom''' || Triscenes and Zombies
|}

Note: Coelacanth and Displacer damage modifiers are not shown in the Official Strategy Guide.

==See Also==

{{Aliens (TFTD)}}

[[Category:data tables]]

Ruleset Reference Nightly (OpenXcom)

2018-08-09T14:35:59Z

Warboy1982: /* Armor */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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

=== Starting Base ===

Defines the content of the base at the start of game.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''randomSoldiers'''
| Determines number and type of starting X-Com soldiers.
If a mod contains more than one type of soldiers, this can also be specified with:
randomSoldiers:
STR_SOLDIER: 3
STR_ANOTHER_SOLDIER: 7
| 0
|-
| '''scientists'''
| Determines number of starting scientists.
| 0
|-
| '''engineers'''
| Determines number of starting engineers.
| 0
|-
| '''facilities'''
| List of starting base facilities and their position (x and y coordinates being 0-5).
| ?
|-
| '''items'''
| List of starting items in the base, excluding items on crafts.
| -
|-
| '''crafts'''
| List of starting crafts in the base and items on board.
| -
|}

=== 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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|-
| '''deployments'''
| List of alienDeployments that correspond to each [[TEXTURE.DAT|Geoscape texture]].
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions.
| -
|-
| '''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 taken from '''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 detection chance dependent on its '''radarChance'''.
| 600
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''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 hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''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 the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images.
| 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. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon. Use clipsize -1 for melee weapons. If clipsize is 0 for a melee weapon, the game will crash if an AI unit attacks with it.
| 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
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| -
|-
| '''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
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.
| -
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''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''
|-
| '''missionScore'''
| Negative points awarded each half hour the UFO is airborne, and twice this value when landed
| 1
|-
| '''terrains'''
| Optional flag - any terrains listed here will override the Geoscape terrains normally used when generating maps with UFOs present
| -
|-
|}

=== 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''
|-
| '''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 - adds a mapblock can be combined with size, group, executions and blocks (for a weighted list)
* addLine - adds a line of mapblocks from groups (roads for example)
* addCraft - adds X-Com craft towards map
* addUFO - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions.
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''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, representing y/x/width/height.
| full map [y,x,mapSize_width,mapSize_heigth]
|-
| '''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
|-
| '''UFOName'''
| TO define the UFO to be placed as a string (STR_).
| 0
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Mission Scripts ===
MissionScripts determines how many missions are spawned each month.
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Name of the script used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''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. For example, [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.
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (ie: terror) with regular missions. They are generated too differently. Using executionOdds and conditionals instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base instead of random.
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base.
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the ultimate threat.
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched Tleth.
Several research triggers can be combined and for the mission to appear all must be fulfilled.
| 0
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking maxruns and avoidRepeats.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there?
| true
|}

==== Guidelines/Tips ====
Relevant ruleset files for editing missions are for a terror type mission:

* missionScripts.rul
* alienMissions.rul
* alienDeployments.rul
* ufoTrajectories.rul
* regions.rul
* globe.rul

alienDeployments.rul defines the mission site details the globe defines the terrain (id:-3) which references the deployment directly, because this is a terror site terrain. The region defines a number of city-style "points" (meaning the min/max values are the same for lat/lon) which use that terrain/texture. The trajectory points to these "points" as the mission site targets.
The alienMission provides the link between the trajectory and the region in its waves, which spawn the site directly instead of an actual UFO/USO and finally the missionScript invokes the AlienMission.

=== 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 soldiers 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
| 0
|-
| '''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]] (identical to routine 0 except for the placement of a single arm frame while walking in a specific direction, use routine 0 instead)
* 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]]
* 22 = Inverted [[Cyberdisc]] (propulsion animation on top)
| 0
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''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:"''.

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

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|-
| '''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.
| -
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|-
| '''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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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. No value means no sound at death.
| -
|-
| '''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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. it will pick one set at random, and as above, these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''markerIcon'''
| What icon should be used to represent this base/site (taken from GlobeMarkers section on Extrasprites)
| -
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (see below).
| -
|-
| '''genMissionType'''
| Which mission should this base generate? (usually supply missions - can be used to generate any mission, with the exception of Terror Sites where the UFO will be generated but the site will never appear)
| -
|-
| '''genMissionFreq'''
| Daily chance for the base mission to be generated.
| -
|-
| '''alienBase'''
| Used only for New Battle mode
| true
|-
| '''points'''
| Negative score applied for each day this mission is active (applied daily for bases, or every half hour for mission sites)
| -
|}

==== 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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

==== Objectives Data ====

Used to define tile types towards objectives. Used for Alien Base Control Modules (UFO & TFTD), Synomium Devices (TFTD) and Alien Brain/T'Leth (UFO/TFTD).
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -
|-
| '''objectivesRequired'''
| How many of the previous tile types must be destroyed in order for the mission to be considered a success.
| -
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| -
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Can have three settings: 0 = Lose, 1 = Abort, 2 = Win
| 0
|-
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (on vanilla it was after turn 20)
| 20
|-
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining.
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units.
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

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

|-
| '''destroyItem'''
| Will this item be destroyed (removed from stores) after research is finished?
| 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).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
| 0
|-
| '''spawnZone'''
| mission zone to use when spawning mission sites / alien bases.
| -
|-
| '''siteType'''
| mission type to use when spawning mission sites / alien bases.
| -
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''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''
|-
| '''retaliationOdds'''
| Probability that a UFO shot down while performing this mission will generate a Retaliation mission.
| -
|-
|}

==== 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 minutes - actual value used is spawnTimer/4 or 3*spawnTimer/4)
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| -
|-
|}

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 48) + 400) minutes, or between 8.33 and 9.3 days

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

Further example: (takes advantage of the ability to drop numerous images into a single folder that will then behave as a sprite sheet)

- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/sprite/
(The folder "/sprite/" is required to make this work. Files within will be numbered sequential from the number defined above. "0" in this case.)

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

Warning for adding .wav files: the game works with low bitrate, uncompressed mono PCM wav. Any other format is likely to not work.

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

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2018-08-09T14:32:21Z

Warboy1982: /* Armor */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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

=== Starting Base ===

Defines the content of the base at the start of game.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''randomSoldiers'''
| Determines number and type of starting X-Com soldiers.
If a mod contains more than one type of soldiers, this can also be specified with:
randomSoldiers:
STR_SOLDIER: 3
STR_ANOTHER_SOLDIER: 7
| 0
|-
| '''scientists'''
| Determines number of starting scientists.
| 0
|-
| '''engineers'''
| Determines number of starting engineers.
| 0
|-
| '''facilities'''
| List of starting base facilities and their position (x and y coordinates being 0-5).
| ?
|-
| '''items'''
| List of starting items in the base, excluding items on crafts.
| -
|-
| '''crafts'''
| List of starting crafts in the base and items on board.
| -
|}

=== 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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|-
| '''deployments'''
| List of alienDeployments that correspond to each [[TEXTURE.DAT|Geoscape texture]].
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions.
| -
|-
| '''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 taken from '''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 detection chance dependent on its '''radarChance'''.
| 600
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''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 hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''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 the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images.
| 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. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon. Use clipsize -1 for melee weapons. If clipsize is 0 for a melee weapon, the game will crash if an AI unit attacks with it.
| 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
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| -
|-
| '''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
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.
| -
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''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''
|-
| '''missionScore'''
| Negative points awarded each half hour the UFO is airborne, and twice this value when landed
| 1
|-
| '''terrains'''
| Optional flag - any terrains listed here will override the Geoscape terrains normally used when generating maps with UFOs present
| -
|-
|}

=== 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''
|-
| '''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 - adds a mapblock can be combined with size, group, executions and blocks (for a weighted list)
* addLine - adds a line of mapblocks from groups (roads for example)
* addCraft - adds X-Com craft towards map
* addUFO - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions.
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''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, representing y/x/width/height.
| full map [y,x,mapSize_width,mapSize_heigth]
|-
| '''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
|-
| '''UFOName'''
| TO define the UFO to be placed as a string (STR_).
| 0
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Mission Scripts ===
MissionScripts determines how many missions are spawned each month.
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Name of the script used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''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. For example, [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.
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (ie: terror) with regular missions. They are generated too differently. Using executionOdds and conditionals instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base instead of random.
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base.
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the ultimate threat.
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched Tleth.
Several research triggers can be combined and for the mission to appear all must be fulfilled.
| 0
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking maxruns and avoidRepeats.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there?
| true
|}

==== Guidelines/Tips ====
Relevant ruleset files for editing missions are for a terror type mission:

* missionScripts.rul
* alienMissions.rul
* alienDeployments.rul
* ufoTrajectories.rul
* regions.rul
* globe.rul

alienDeployments.rul defines the mission site details the globe defines the terrain (id:-3) which references the deployment directly, because this is a terror site terrain. The region defines a number of city-style "points" (meaning the min/max values are the same for lat/lon) which use that terrain/texture. The trajectory points to these "points" as the mission site targets.
The alienMission provides the link between the trajectory and the region in its waves, which spawn the site directly instead of an actual UFO/USO and finally the missionScript invokes the AlienMission.

=== 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 soldiers 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
| 0
|-
| '''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]] (identical to routine 0 except for the placement of a single arm frame while walking)
* 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]]
* 22 = Inverted [[Cyberdisc]] (propulsion animation on top)
| 0
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''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:"''.

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

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|-
| '''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.
| -
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|-
| '''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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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. No value means no sound at death.
| -
|-
| '''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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. it will pick one set at random, and as above, these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''markerIcon'''
| What icon should be used to represent this base/site (taken from GlobeMarkers section on Extrasprites)
| -
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (see below).
| -
|-
| '''genMissionType'''
| Which mission should this base generate? (usually supply missions - can be used to generate any mission, with the exception of Terror Sites where the UFO will be generated but the site will never appear)
| -
|-
| '''genMissionFreq'''
| Daily chance for the base mission to be generated.
| -
|-
| '''alienBase'''
| Used only for New Battle mode
| true
|-
| '''points'''
| Negative score applied for each day this mission is active (applied daily for bases, or every half hour for mission sites)
| -
|}

==== 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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

==== Objectives Data ====

Used to define tile types towards objectives. Used for Alien Base Control Modules (UFO & TFTD), Synomium Devices (TFTD) and Alien Brain/T'Leth (UFO/TFTD).
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -
|-
| '''objectivesRequired'''
| How many of the previous tile types must be destroyed in order for the mission to be considered a success.
| -
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| -
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Can have three settings: 0 = Lose, 1 = Abort, 2 = Win
| 0
|-
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (on vanilla it was after turn 20)
| 20
|-
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining.
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units.
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

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

|-
| '''destroyItem'''
| Will this item be destroyed (removed from stores) after research is finished?
| 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).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
| 0
|-
| '''spawnZone'''
| mission zone to use when spawning mission sites / alien bases.
| -
|-
| '''siteType'''
| mission type to use when spawning mission sites / alien bases.
| -
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''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''
|-
| '''retaliationOdds'''
| Probability that a UFO shot down while performing this mission will generate a Retaliation mission.
| -
|-
|}

==== 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 minutes - actual value used is spawnTimer/4 or 3*spawnTimer/4)
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| -
|-
|}

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 48) + 400) minutes, or between 8.33 and 9.3 days

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

Further example: (takes advantage of the ability to drop numerous images into a single folder that will then behave as a sprite sheet)

- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/sprite/
(The folder "/sprite/" is required to make this work. Files within will be numbered sequential from the number defined above. "0" in this case.)

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

Warning for adding .wav files: the game works with low bitrate, uncompressed mono PCM wav. Any other format is likely to not work.

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

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2017-07-18T05:17:14Z

Warboy1982: /* Armor */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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

=== Starting Base ===

Defines the content of the base at the start of game.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''randomSoldiers'''
| Determines number and type of starting X-Com soldiers.
If a mod contains more than one type of soldiers, this can also be specified with:
randomSoldiers:
STR_SOLDIER: 3
STR_ANOTHER_SOLDIER: 7
| 0
|-
| '''scientists'''
| Determines number of starting scientists.
| 0
|-
| '''engineers'''
| Determines number of starting engineers.
| 0
|-
| '''facilities'''
| List of starting base facilities and their position (x and y coordinates being 0-5).
| ?
|-
| '''items'''
| List of starting items in the base, excluding items on crafts.
| -
|-
| '''crafts'''
| List of starting crafts in the base and items on board.
| -
|}

=== 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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|-
| '''deployments'''
| List of alienDeployments that correspond to each [[TEXTURE.DAT|Geoscape texture]].
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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 taken from '''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 detection chance dependent on its '''radarChance'''.
| 600
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''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 hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''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 the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images.
| 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. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon. Use clipsize -1 for melee weapons. If clipsize is 0 for a melee weapon, the game will crash if an AI unit attacks with it.
| 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
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| -
|-
| '''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
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.
| -
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''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''
|-

| '''missionScore'''
| Negative points awarded each half hour the UFO is airborne, and twice this value when landed
| 1
|-
|}

=== 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''
|-
| '''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 - adds a mapblock can be combined with size, group, executions and blocks (for a weighted list)
* addLine - adds a line of mapblocks from groups (roads for example)
* addCraft - adds X-Com craft towards map
* addUFO - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions.
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''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, representing y/x/width/height.
| full map [y,x,mapSize_width,mapSize_heigth]
|-
| '''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
|-
| '''UFOName'''
| TO define the UFO to be placed as a string (STR_).
| 0
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Mission Scripts ===
MissionScripts determines how many missions are spawned each month.
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Name of the script used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''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. For example, [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.
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (ie: terror) with regular missions. They are generated too differently. Using executionOdds and conditionals instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base instead of random.
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base.
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the ultimate threat.
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched Tleth.
Several research triggers can be combined and for the mission to appear all must be fulfilled.
| 0
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking maxruns and avoidRepeats.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there?
| true
|}

==== Guidelines/Tips ====
Relevant ruleset files for editing missions are for a terror type mission:

* missionScripts.rul
* alienMissions.rul
* alienDeployments.rul
* ufoTrajectories.rul
* regions.rul
* globe.rul

alienDeployments.rul defines the mission site details the globe defines the terrain (id:-3) which references the deployment directly, because this is a terror site terrain. The region defines a number of city-style "points" (meaning the min/max values are the same for lat/lon) which use that terrain/texture. The trajectory points to these "points" as the mission site targets.
The alienMission provides the link between the trajectory and the region in its waves, which spawn the site directly instead of an actual UFO/USO and finally the missionScript invokes the AlienMission.

=== 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 soldiers 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
| 0
|-
| '''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]]
* 22 = Inverted [[Cyberdisc]] (propulsion animation on top)
| 0
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''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:"''.

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

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|-
| '''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.
| -
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|-
| '''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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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. No value means no sound at death.
| -
|-
| '''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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. it will pick one set at random, and as above, these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''markerIcon'''
| What icon should be used to represent this base/site (taken from GlobeMarkers section on Extrasprites)
| -
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (see below).
| -
|-
| '''genMissionType'''
| Which mission should this base generate? (usually supply missions)
| -
|-
| '''genMissionFreq'''
| Daily chance for the base mission to be generated.
| -
|-
| '''alienBase'''
| Used only for New Battle mode
| true
|-
| '''points'''
| Negative score applied for each day this mission is active (applied daily for bases, or every half hour for mission sites)
| -
|}

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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

==== Objectives Data ====

Used to define tile types towards objectives. Used for Alien Base Control Modules (UFO & TFTD), Synomium Devices (TFTD) and Alien Brain/T'Leth (UFO/TFTD).
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -
|-
| '''objectivesRequired'''
| How many of the previous tile types must be destroyed in order for the mission to be considered a success.
| -
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| -
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Can have three settings: 0 = Lose, 1 = Abort, 2 = Win
| 0
|-
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (on vanilla it was after turn 20)
| 20
|-
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining.
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units.
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

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

|-
| '''destroyItem'''
| Will this item be destroyed (removed from stores) after research is finished?
| 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).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
| 0
|-
| '''spawnZone'''
| mission zone to use when spawning mission sites / alien bases.
| -
|-
| '''siteType'''
| mission type to use when spawning mission sites / alien bases.
| -
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''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 minutes - actual value used is spawnTimer/4 or 3*spawnTimer/4)
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| -
|-
|}

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 48) + 400) minutes, or between 8.33 and 9.3 days

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

Further example: (takes advantage of the ability to drop numerous images into a single folder that will then behave as a sprite sheet)

- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/sprite/
(The folder "/sprite/" is required to make this work. Files within will be numbered sequential from the number defined above. "0" in this case.)

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

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2017-07-18T05:16:25Z

Warboy1982: /* Armor */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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

=== Starting Base ===

Defines the content of the base at the start of game.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''randomSoldiers'''
| Determines number and type of starting X-Com soldiers.
If a mod contains more than one type of soldiers, this can also be specified with:
randomSoldiers:
STR_SOLDIER: 3
STR_ANOTHER_SOLDIER: 7
| 0
|-
| '''scientists'''
| Determines number of starting scientists.
| 0
|-
| '''engineers'''
| Determines number of starting engineers.
| 0
|-
| '''facilities'''
| List of starting base facilities and their position (x and y coordinates being 0-5).
| ?
|-
| '''items'''
| List of starting items in the base, excluding items on crafts.
| -
|-
| '''crafts'''
| List of starting crafts in the base and items on board.
| -
|}

=== 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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|-
| '''deployments'''
| List of alienDeployments that correspond to each [[TEXTURE.DAT|Geoscape texture]].
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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 taken from '''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 detection chance dependent on its '''radarChance'''.
| 600
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''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 hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''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 the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images.
| 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. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon. Use clipsize -1 for melee weapons. If clipsize is 0 for a melee weapon, the game will crash if an AI unit attacks with it.
| 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
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| -
|-
| '''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
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.
| -
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''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''
|-

| '''missionScore'''
| Negative points awarded each half hour the UFO is airborne, and twice this value when landed
| 1
|-
|}

=== 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''
|-
| '''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 - adds a mapblock can be combined with size, group, executions and blocks (for a weighted list)
* addLine - adds a line of mapblocks from groups (roads for example)
* addCraft - adds X-Com craft towards map
* addUFO - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions.
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''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, representing y/x/width/height.
| full map [y,x,mapSize_width,mapSize_heigth]
|-
| '''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
|-
| '''UFOName'''
| TO define the UFO to be placed as a string (STR_).
| 0
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Mission Scripts ===
MissionScripts determines how many missions are spawned each month.
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Name of the script used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''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. For example, [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.
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (ie: terror) with regular missions. They are generated too differently. Using executionOdds and conditionals instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base instead of random.
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base.
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the ultimate threat.
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched Tleth.
Several research triggers can be combined and for the mission to appear all must be fulfilled.
| 0
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking maxruns and avoidRepeats.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there?
| true
|}

==== Guidelines/Tips ====
Relevant ruleset files for editing missions are for a terror type mission:

* missionScripts.rul
* alienMissions.rul
* alienDeployments.rul
* ufoTrajectories.rul
* regions.rul
* globe.rul

alienDeployments.rul defines the mission site details the globe defines the terrain (id:-3) which references the deployment directly, because this is a terror site terrain. The region defines a number of city-style "points" (meaning the min/max values are the same for lat/lon) which use that terrain/texture. The trajectory points to these "points" as the mission site targets.
The alienMission provides the link between the trajectory and the region in its waves, which spawn the site directly instead of an actual UFO/USO and finally the missionScript invokes the AlienMission.

=== 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 soldiers 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
| 0
|-
| '''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]]
* 22 = [[Inverted Cyberdisc (propulsion animation on top)]]
| 0
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''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:"''.

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

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|-
| '''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.
| -
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|-
| '''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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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. No value means no sound at death.
| -
|-
| '''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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. it will pick one set at random, and as above, these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''markerIcon'''
| What icon should be used to represent this base/site (taken from GlobeMarkers section on Extrasprites)
| -
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (see below).
| -
|-
| '''genMissionType'''
| Which mission should this base generate? (usually supply missions)
| -
|-
| '''genMissionFreq'''
| Daily chance for the base mission to be generated.
| -
|-
| '''alienBase'''
| Used only for New Battle mode
| true
|-
| '''points'''
| Negative score applied for each day this mission is active (applied daily for bases, or every half hour for mission sites)
| -
|}

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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

==== Objectives Data ====

Used to define tile types towards objectives. Used for Alien Base Control Modules (UFO & TFTD), Synomium Devices (TFTD) and Alien Brain/T'Leth (UFO/TFTD).
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -
|-
| '''objectivesRequired'''
| How many of the previous tile types must be destroyed in order for the mission to be considered a success.
| -
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| -
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Can have three settings: 0 = Lose, 1 = Abort, 2 = Win
| 0
|-
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (on vanilla it was after turn 20)
| 20
|-
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining.
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units.
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

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

|-
| '''destroyItem'''
| Will this item be destroyed (removed from stores) after research is finished?
| 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).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
| 0
|-
| '''spawnZone'''
| mission zone to use when spawning mission sites / alien bases.
| -
|-
| '''siteType'''
| mission type to use when spawning mission sites / alien bases.
| -
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''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 minutes - actual value used is spawnTimer/4 or 3*spawnTimer/4)
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| -
|-
|}

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 48) + 400) minutes, or between 8.33 and 9.3 days

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

Further example: (takes advantage of the ability to drop numerous images into a single folder that will then behave as a sprite sheet)

- type: GIANTBUNNY.PCK
width: 32
height: 40
files:
0: Resources/Bunny/sprite/
(The folder "/sprite/" is required to make this work. Files within will be numbered sequential from the number defined above. "0" in this case.)

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

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Hidden Features (OpenXcom)

2017-07-18T02:22:13Z

Warboy1982: /* Debug mode */

There are many little interface extras hidden in OpenXcom that aren't really mentioned anywhere ingame. This page is dedicated to them.

See [[Options (OpenXcom)|Options]] for settings and keyboard shortcuts.

== General ==
* Use the mouse wheel to scroll lists and right-click the arrow buttons to scroll to the top/bottom.
* Use the mouse cursor and keyboard keys to move the caret on text fields.
* ''ALT-ENTER'' will toggle fullscreen mode.
* ''Ctrl-G'' will toggle mouse cursor lock behaviour (when enabled, the mouse pointer will be unable to exit the window).

== Geoscape ==
* Right-click on arrows to set a value to minimum/maximum.
* Use the mouse wheel to zoom the globe and right-click to center it on a location.
* Click on a weapon during a dogfight to disable/enable it. ([http://imgur.com/a/Rwhqe Screenshot Album Demonstrating this feature Here])
* Right-click a craft in the interception screen to center on its location.
* Right-click a base facility to bring up the associated management screen.
* Right-click on a soldier in a craft's Soldiers screen to open up their stats page.
* Right-click on a soldier in a craft's Armour screen assigns the last selected Armour to the soldier (if possible).

== Battlescape ==

* Use the mouse wheel to move the camera up/down a level.
* Right-click to leave most screens.
* Click a soldier's rank to bring up their stats.
* Right-click while holding an inventory item to cancel the move.
* Ctrl-click an item in the inventory to have the soldier pick it up or drop it on the ground.
* Right-click a grenade during pre-battle inventory to prime it.
* Right-click the Zero TUs button to reset a soldier's time units (so they can't reaction fire).
* Right-click while a soldier is moving to abort the move.
* Right-click while a projectile is moving to skip to the projectile hit.
* Use the mouse Previous/Next buttons to switch between soldiers.
* Hold Ctrl while firing to ignore "No Line Of Fire" errors.
* Ctrl-click a location makes a soldier run; Running Units move at 75% Time Unit Cost for 150% Energy cost.

== 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 (OpenXcom)#Options File|Options File]], you can enable it by pressing ''Ctrl-D'' in-game to access a variety of features:

'''Geoscape''': Unlocks all research and shows globe country and region borders. Clicking on the globe returns the point coordinates.
This option can be toggled, and toggles between showing country borders, regional borders, and mission zones.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs. Clicking the map returns the point coordinates. With traceAI enabled in the config, AI behavior is revealed and logged. '''Please note''', in debug mode QuickSave/QuickLoad feature in Battlescape are completely disabled.

''Ctrl-V'' will reset visibility on all tiles, useful for observing LOS behaviour.

''Ctrl-K'' will kill all live aliens in the mission (nothing will be recovered).

''Ctrl-J'' will stun all live aliens in the mission (useful for testing recovery).

''Ctrl-W'' will warp the selected unit to the mouse cursor's current position.

''F8'' will cycle through various engine processing speeds, useful for debugging animation errors.

You can also press ''Ctrl-U'' or set "debugUi: true" to reveal the borders of the interface text, to debug translation errors.

If the Commendations Mod is being played, ''Ctrl-C'' will wipe all earned commendations while retaining statistics, useful for debugging how they're awarded.

[[Category:OpenXcom]]

Hidden Features (OpenXcom)

2017-07-18T02:19:41Z

Warboy1982: /* Debug mode */

There are many little interface extras hidden in OpenXcom that aren't really mentioned anywhere ingame. This page is dedicated to them.

See [[Options (OpenXcom)|Options]] for settings and keyboard shortcuts.

== General ==
* Use the mouse wheel to scroll lists and right-click the arrow buttons to scroll to the top/bottom.
* Use the mouse cursor and keyboard keys to move the caret on text fields.
* ''ALT-ENTER'' will toggle fullscreen mode.
* ''Ctrl-G'' will toggle mouse cursor lock behaviour (when enabled, the mouse pointer will be unable to exit the window).

== Geoscape ==
* Right-click on arrows to set a value to minimum/maximum.
* Use the mouse wheel to zoom the globe and right-click to center it on a location.
* Click on a weapon during a dogfight to disable/enable it. ([http://imgur.com/a/Rwhqe Screenshot Album Demonstrating this feature Here])
* Right-click a craft in the interception screen to center on its location.
* Right-click a base facility to bring up the associated management screen.
* Right-click on a soldier in a craft's Soldiers screen to open up their stats page.
* Right-click on a soldier in a craft's Armour screen assigns the last selected Armour to the soldier (if possible).

== Battlescape ==

* Use the mouse wheel to move the camera up/down a level.
* Right-click to leave most screens.
* Click a soldier's rank to bring up their stats.
* Right-click while holding an inventory item to cancel the move.
* Ctrl-click an item in the inventory to have the soldier pick it up or drop it on the ground.
* Right-click a grenade during pre-battle inventory to prime it.
* Right-click the Zero TUs button to reset a soldier's time units (so they can't reaction fire).
* Right-click while a soldier is moving to abort the move.
* Right-click while a projectile is moving to skip to the projectile hit.
* Use the mouse Previous/Next buttons to switch between soldiers.
* Hold Ctrl while firing to ignore "No Line Of Fire" errors.
* Ctrl-click a location makes a soldier run; Running Units move at 75% Time Unit Cost for 150% Energy cost.

== 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 (OpenXcom)#Options File|Options File]], you can enable it by pressing ''Ctrl-D'' in-game to access a variety of features:

'''Geoscape''': Unlocks all research and shows globe country and region borders. Clicking on the globe returns the point coordinates.
This option can be toggled, and toggles between showing country borders, regional borders, and mission zones.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs. Clicking the map returns the point coordinates. With traceAI enabled in the config, AI behavior is revealed and logged. '''Please note''', in debug mode QuickSave/QuickLoad feature in Battlescape are completely disabled.

''Ctrl-V'' will reset visibility on all tiles, useful for observing LOS behaviour.

''Ctrl-K'' will kill all live aliens in the mission (nothing will be recovered).

''Ctrl-J'' will stun all live aliens in the mission (useful for testing recovery).

''F8'' will cycle through various engine processing speeds, useful for debugging animation errors.

You can also press ''Ctrl-U'' or set "debugUi: true" to reveal the borders of the interface text, to debug translation errors.

If the Commendations Mod is being played, ''Ctrl-C'' will wipe all earned commendations while retaining statistics, useful for debugging how they're awarded.

[[Category:OpenXcom]]

Installation FAQ (OpenXcom)

2017-03-17T00:08:56Z

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

'''For the sake of clarity, the current milestone (stable) release is v1.0. Nightly builds offer features not available in 1.0 and will eventually become the v2.0 milestone release. Though mentioned in this document, the 2.0 version doesn't exist yet!'''

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

== What are milestones and nightlies? ==

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

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

For example, the latest nightly builds offer limited support for TFTD as well as other features, while the 1.0 stable release does not.

== What are the Data and User folders? ==

Assuming you installed the game in a ''OpenXcom'' folder:

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

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

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

== How do I manually install OpenXcom? ==

Just extract the ZIP to your install location and copy the original X-COM resources to the appropriate folders:

=== v1.0 ===

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

Your installation structure should look like this:
* OpenXcom
** data
*** GEODATA
*** GEOGRAPH
*** Language
*** MAPS
*** Resources
*** ROUTES
*** Ruleset
*** Shaders
*** SoldierName
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** ''UFOINTRO*''
*** UNITS

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

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

Terror from the Deep is not required, but if you want to include it:

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

Your installation structure should look like this if you have both games:
* OpenXcom
** common
*** Language
*** Resources
*** Shaders
*** SoldierName
** standard
*** xcom1
*** xcom2
*** ...
** TFTD
*** ''ANIMS*''
*** ''FLOP_INT*''
*** GEODATA
*** GEOGRAPH
*** MAPS
*** ROUTES
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** UNITS
** UFO
*** GEODATA
*** GEOGRAPH
*** MAPS
*** ROUTES
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** ''UFOINTRO*''
*** UNITS

''*optional''

== How do I install mods? ==

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

When in doubt, always check the mod installation instructions carefully.

=== v1.0 ===

Extract the mod to your ''data'' subfolder.

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

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

* mods
** Mod1
** Mod2
** Mod3

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

* mods
** OldMod
*** Resources
*** Ruleset

== How do I use mods? ==
== How do I switch between UFO and TFTD? ==

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

== How do I update OpenXcom? ==

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

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

Nightly saves and mods are not compatible with 1.0 unless otherwise stated. Always check the mod readme and installation instructions.

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

== How do I update mods? ==

Delete the old mod folder and replace it with the new version. Don't install the new version on top of the old one.

== Can I make a portable installation? ==

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

== Can I have multiple installations/versions? ==

Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.

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

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

If you downloaded the nightly from our website, the nightly build date should be shown on the Main Menu. However this will not be shown if you compiled it yourself, even though it's equivalent to a nightly.

== How do I reset my options when my game won't start? ==

Delete the ''options.cfg'' file from your User folder.

== How do I reinstall OpenXcom from scratch? ==

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

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

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

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

[[Category:OpenXcom]]

Installation FAQ (OpenXcom)

2017-03-17T00:04:13Z

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

'''For the sake of clarity, the current milestone (stable) release is v1.0. Nightly builds offer features not available in 1.0 and will eventually become the v2.0 milestone release. Though mentioned in this document, the 2.0 version doesn't exist yet!'''

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

== What are milestones and nightlies? ==

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

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

For example, the latest nightly builds offer limited support for TFTD as well as other features, while the 1.0 stable release does not.

== What are the Data and User folders? ==

Assuming you installed the game in a ''OpenXcom'' folder:

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

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

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

== How do I manually install OpenXcom? ==

Just extract the ZIP to your install location and copy the original X-COM resources to the appropriate folders:

=== v1.0 ===

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

Your installation structure should look like this:
* OpenXcom
** data
*** GEODATA
*** GEOGRAPH
*** Language
*** MAPS
*** Resources
*** ROUTES
*** Ruleset
*** Shaders
*** SoldierName
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** ''UFOINTRO*''
*** UNITS

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

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

Terror from the Deep is not required, but if you want to include it:

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

Your installation structure should look like this if you have both games:
* OpenXcom
** common
*** Language
*** Resources
*** Shaders
*** SoldierName
** standard
*** xcom1
*** xcom2
*** ...
** TFTD
*** ''ANIMS*''
*** ''FLOP_INT*''
*** GEODATA
*** GEOGRAPH
*** MAPS
*** ROUTES
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** UNITS
** UFO
*** GEODATA
*** GEOGRAPH
*** MAPS
*** ROUTES
*** SOUND
*** TERRAIN
*** UFOGRAPH
*** ''UFOINTRO*''
*** UNITS

''*optional''

== How do I install mods? ==

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

When in doubt, always check the mod installation instructions carefully.

=== v1.0 ===

Extract the mod to your ''data'' subfolder.

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

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

* mods
** Mod1
** Mod2
** Mod3

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

* mods
** OldMod
*** Resources
*** Ruleset

== How do I use mods? ==
== How do I switch between UFO and TFTD? ==

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

== How do I update OpenXcom? ==

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

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

Nightly saves and mods are not compatible with 1.0 unless otherwise stated. Always check the mod readme and installation instructions.

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

== How do I update mods? ==

Delete the old mod folder and replace it with the new version. Don't install the new version on top of the old one.

== Can I make a portable installation? ==

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

== Can I have multiple installations/versions? ==

Yes, all installations have their own Data folder but share the same User folder. If you want multiple independent installations, give them their own User folder like you would for a portable installation.

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

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

If you downloaded the nightly from our website, the nightly build date should be shown on the Main Menu. However this will not be shown if you compiled it yourself, even though it's equivalent to a nightly.

== How do I reset my options when my game won't start? ==

Delete the ''options.cfg'' file from your User folder.

== How do I reinstall OpenXcom from scratch? ==

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

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

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

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

[[Category:OpenXcom]]

Installing (OpenXcom)

2017-03-17T00:02:29Z

Warboy1982: /* All platforms */

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

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

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

In the instructions below, we refer to three different folders a lot: the "data" folder, the "user" folder, and the "config" folder. See [https://github.com/SupSuper/OpenXcom#directory-locations here] for directory definitions and where they are located on your operating system.

=== All platforms ===

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

For version 1.0 it should end up like this:

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

and for the nightly it should look like this:

* '''UFO'''
** '''GEODATA'''
** '''GEOGRAPH'''
** '''MAPS'''
** '''ROUTES'''
** '''SOUND'''
** '''TERRAIN'''
** '''UFOGRAPH'''
** '''UFOINTRO'''
** '''UNITS'''

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

==== Video tutorial ====

A video tutorial that covers the installation of milestone version 1.0 [http://www.youtube.com/watch?v=rNneKAwvjoU is available here] (courtesy of [http://www.youtube.com/channel/UCHymw9FSZqharCpMW-WiiHg Ivan Dogovich]). Though recorded for the Windows platform, check it out if you have doubts about a particular step during the installation.

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

=== Windows ===

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

=== Mac OS X ===

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

=== Unix-like ===

OpenXcom requires the following libraries:

* [http://www.libsdl.org/ SDL] (libsdl1.2)
* [http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] (libsdl-mixer1.2)
* [http://www.ferzkopp.net/joomla/content/view/19/14/ SDL_gfx] (libsdl-gfx1.2), version 2.0.22 or later
* [http://www.libsdl.org/projects/SDL_image/ SDL_image] (libsdl-image1.2)
* [http://code.google.com/p/yaml-cpp/ yaml-cpp] (libyaml-cpp), version 0.5.1 or later (please note that 0.5.2 has issues, use 0.5.3)

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

Copy game resources to the appropriate [https://github.com/SupSuper/OpenXcom#linux folder locations].

=== Portable ===

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

== Log file ==

In case you experience any problems or errors during the initial game loading/startup, these will be shown and logged in ''openxcom.log'' in the [https://github.com/SupSuper/OpenXcom#directory-locations User Folder]. Make sure you installed everything correctly as instructed, and if you still experience problems, check the [http://openxcom.org/forum/ forums].

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2016-05-12T01:38:32Z

Warboy1982: /* AI Units (Aliens/Civilians) */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|-
| '''deployments'''
| List of alienDeployments that correspond to each [[TEXTURE.DAT|Geoscape texture]].
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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 taken from '''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 detection chance dependent on its '''radarChance'''.
| 600
|-
| '''radarChance'''
| Chance (0-100%) of this craft radar detecting a UFO that enters its range.
| 100
|-
| '''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 hour while the craft is [[Rearming]] in base. If specified, '''clip'''s are spent depending on their '''clipSize''', and '''reamRate''' should be a multiple of '''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 the first ''above water'' sprite (spriteID for UFO, spriteID + 8 for TFTD). TFTD spritesheet should start with 8 underwater images, followed by 8 above water images.
| 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. If specified for a HWP, clipSize determines the maximum amount of shots which can be loaded into the HWP weapon.
| 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
|-
| '''waypoints'''
| Gives the integer number of waypoints the weapon can use. (eg. [[Blaster Launcher]]). Can also be used to make ammo items use the waypoint system. "-1" means unlimited waypoints.
| -
|-
| '''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
|-
| '''specialType'''
| MCD value in map files to which this item corresponds for mission recovery.
| -
|-
| '''recover'''
| Is this item recoverable? (gets transported to the X-COM base on mission success)
| true
|-
| '''armor'''
| How much damage is needed to destroy this item on the ground.
| 20
|-
| '''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''
|-
| '''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 - can also be used to place 'UFO' maps (or any other single map) on missionSite (objective 3) missions.
* digTunnel
* fillArea
* checkBlock
* removeBlock
* resize
| ''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, representing x/y/height/width.
| full map [0,0,mapSize_X,mapSize_Y]
|-
| '''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
|-
| '''UFOName'''
| TO define the UFO to be placed as a string (STR_).
| 0
|}

==== Guidelines/Tips ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

=== Mission Scripts ===
MissionScripts determines how many missions are spawned each month.
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| Name of the script the is used for overwriting or deleting purposes.
| ''required''
|-
| '''firstMonth'''
| Months this command runs on, 0 runs on startup of a new game
| 0
|-
| '''lastMonth'''
| Do not run after this month. In this context we mean "run once". -1 denotes no limit.
| -1
|-
| '''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. For example, [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.
| -
|-
| '''missionWeights'''
| The type of mission to spawn (omit to pick one from the mission table). These are split into monthly chunks, and can contain multiple entries including weighted odds, but there is a caveat here: You cannot mix and match missions with mission site objectives (ie: terror) with regular missions. They are generated too differently. Using executionOdds and conditionals instead can achieve exactly the same thing. Similarly, terror missions should not appear in regional mission weights (regions.rul).
| -
|-
| '''executionOdds'''
| % chances of this command executing.
| 100
|-
| '''targetBaseOdds'''
| % chances of this mission targeting a region containing an xcom base instead of random.
| 0
|-
| '''startDelay'''
| Number of minutes to delay the start of the mission (rounded down to the nearest 30). For 0 the wave timer from the mission itself is used.
| 0
|-
| '''raceWeights'''
| List which can override established monthly race weights if desired.
| -
|-
| '''regionWeights'''
| List which can override established monthly region weights if desired. This will come into play only if the mission doesn't target an xcom base.
If the list is omitted: for a terror type mission, all regions that meet the criteria will be weighed equally. For regular missions the normal regional distribution weights will be applied.
| -
|-
| '''minDifficulty'''
| This command only applies to difficulty levels of this or above.
| 0
|-
| '''researchTriggers'''
| A list of research topics that can influence the execution of this mission. For example
* "''STR_THE_ULTIMATE_THREAT: true''" means the mission would only run if the player has researched the ultimate threat.
* "''STR_TLETH_TH_ALIEN_CITY: false''" means the mission would only run if the player has not researched Tleth.
Several research triggers can be combined and for the mission to appear all must be fulfilled.
| 0
|-
| '''maxRuns'''
| This mission type can only execute this number of times, -1 for infinite.
| -1
|-
| '''avoidRepeats'''
| This is used to ensure different coordinates for this mission. It means "store an array of ''x'' previous coordinates, and don't use them again".
| 0
|-
| '''varName'''
| This is an internal variable name, used for tracking maxruns and avoidRepeats.
| -
|-
| '''useTable'''
| Check if this mission type appears in the mission tables. If ''true'' remove it from there?
| true
|}

==== Guidelines/Tips ====
Relevant ruleset files for editing missions are for a terror type mission:

* missionScripts.rul
* alienMissions.rul
* alienDeployments.rul
* ufoTrajectories.rul
* regions.rul
* globe.rul

alienDeployments.rul defines the mission site details the globe defines the terrain (id:-3) which references the deployment directly, because this is a terror site terrain. The region defines a number of city-style "points" (meaning the min/max values are the same for lat/lon) which use that terrain/texture. The trajectory points to these "points" as the mission site targets.
The alienMission provides the link between the trajectory and the region in its waves, which spawn the site directly instead of an actual UFO/USO and finally the missionScript invokes the AlienMission.

=== 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 soldiers 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
| 0
|-
| '''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
|-
| '''constantAnimation'''
| Set it to "true" for units that constantly show an animation, such as: Biodrone, Celatid, Silacoid.
| false
|-
| '''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:"''.

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

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the soldier type.
| ''required''
|-
| '''requires'''
| List of [[#Research|topics]] (string IDs) that must be researched to unlock this soldier type. If none are specified, this soldier type is unlocked from the start.
| -
|-
| '''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.
| -
|-
| '''costBuy'''
| Amount of money spent for hiring this soldier type. If set to 0, the soldier type will not be available in the Purchase/Recruit screen.
| 0
|-
| '''costSalary'''
| Amount of money spent monthly for employing this soldier type.
| 0
|-
| '''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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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. No value means no sound at death.
| -
|-
| '''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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
| '''builtInWeaponSets'''
| A set of lists of weapons this unit can come pre-equipped with. it will pick one set at random, and as above, these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''durationMin'''
'''durationMax'''
| Minimum and maximum duration of this mission on the Geoscape (in hours).
I think these are deprecated; you should use '''duration'''.
| -
|-
| '''duration'''
| [''min'', ''max''] -- Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

==== Objectives Data ====

Used to define tile types towards objectives. Used for Alien Base Control Modules (UFO & TFTD), Synomium Devices (TFTD) and Alien Brain/T'Leth (UFO/TFTD).
{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''objectiveType'''
| Defines which type of MCD to check for when tallying mission objectives.
| -
|-
| '''objectivesRequired'''
| How many of the previous tile types must be destroyed in order for the mission to be considered a success.
| -
|-
| '''objectivePopup'''
| Defines the message that will appear between turns, after the objective requirements have been fulfilled.
| -
|-
| '''objectiveComplete'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''objectiveFailed'''
| The string and score adjustment to be shown on the mission debriefing.
| [string, int]
|-
| '''despawnPenalty'''
| How many points the aliens will receive when this site despawns due to XCom negligence.
| -
|-
| '''turnLimit'''
| The amount of turns before the mission ends automatically.
| 0 (no limit)
|-
|-
| '''chronoTrigger'''
| What happens when the timer reaches 0. Can have three settings: 0 = Lose, 1 = Abort, 2 = Win
| 0
|-
|-
| '''cheatTurn'''
| When the aliens became aware of all your units (on vanilla it was after turn 20)
| 20
|-
|}

Notes:
* turnLimit is used to define the turn where the game ends, default is 0 (no limit). If the value is changed from default then the game will display the number of turns on the 'Hidden Movement' screens as '1/20', '2/20', etc., and the numbers will switch to red when there's less than 3 turns remaining.
* chronoTrigger is used with turnLimit and defines what happens when the turn limit is reached. There are 3 possible settings:
** 0 (default) = forces a Loss, meaning that the player loses everything if the mission isn't completed by the time the turn limit is reached. All units are declared dead or MIA when the game ends. This is ideal for bomb defusal type missions.
** 1 = forces a Abort, this is almost the same as above, with the exception that there must be at least 1 soldier on an exit-only area (like the green room on the 1st stage of Cydonia) to win at the end of the turn limit. This setting is better used for multi-stage missions where you'll need to bring at least 1 soldier to the next stage.
** 2 = forces a Win, where if you have at least 1 live unit at the end of the turn limit you'll win the mission, regardless of where the soldiers are. This is meant for Survival scenarios.
** Regardless of the setting, the player can always still win by eliminating all alien units before the turn limit, or fail the mission by losing all units.
* cheatTurn allows to define the turn where the AI becomes aware of all your units (default is 20) for individual missions. Once this turn is reached the aliens will be forced to go into attack mode and engage your units. This is effectively a cheat for the AI which was present on the original game.

=== 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).
| -
|-
| '''unlockFinalMission'''
| If true, this research topic allows to send a spacecraft to the final mission.
| false
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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
|-
| '''objective'''
| Missions are split by objective:
* 0 = score (default if omitted)
* 1 = infiltration
* 2 = alien base
* 3 = mission site (terror etc)
* 4 = retaliation
* 5 = supply
| 0
|-
| '''spawnZone'''
| mission zone to use when spawning mission sites / alien bases.
| -
|-
| '''siteType'''
| mission type to use when spawning mission sites / alien bases.
| -
|-
| '''spawnUfo'''
| UFO to spawn for retaliation.
| -
|-
| '''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 minutes - actual value used is spawnTimer/4 or 3*spawnTimer/4)
| 0
|-
| '''objective'''
| ''true'' Marks this wave as the one that carries out the mission objective. Only for mission site / supply missions.
| -
|-
|}

Notes:
* The timer can vary between 50-150% of the stated value, so a UFO with a 9000 value will be spawned between 4500-13500 minutes (each day has 1440 minutes)
* If the UFO is crashed/destroyed the timer of the next UFO on the wave will be delayed by (30 * (RNG::generate(0, 48) + 400) minutes, or between 8.33 and 9.3 days

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

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Alien Missions in Enemy Unknown (OpenXcom)

2015-08-30T15:06:45Z

Warboy1982: /* Alien Missions Generation */

UFOs are sent out periodically to conduct a number of types of '''Alien Missions''', some of which the purpose is fairly inscrutable, others are fairly obvious in their reasoning. Especially once the [[Hyper-wave Decoder]] is deployed, knowing the mission of the aliens can help make strategic plans for further actions that the aliens may attempt in the near future.

The information presented below describes how Alien Missions work in the original Enemy Unknown game, based upon [[OpenXcom]]'s XCom1 ruleset file and other sources, namely posts at OpenXcom's forums and pages about the original game files.

Keep in mind that there are massive spoilers involved, so read at your own risk.

==List of Alien Missions==

* [[Alien Research]]
* [[Alien Harvest]]
* [[Alien Abduction]]
* [[Alien Infiltration]]
* [[Alien Base]]
* [[Alien Terror]]
* [[Alien Retaliation]]
* [[Alien Supply]]

==Alien Missions Generation==
===Missions Frequency===
The aliens will generate new missions each month according to the following pattern:
* January, 1999: 1 Alien Research, 1 Alien Terror, shooting down UFOs may trigger an Alien Retaliation mission.
* February to May, 1999: 1 random mission, 1 Alien Terror, shooting down UFOs may trigger an Alien Retaliation mission.
* June, 1999: 2 random missions, 1 Alien Terror, shooting down UFOs may trigger an Alien Retaliation mission.
* After [[The Martian Solution]] is researched OR depending the difficulty level (March 2000 on Easy or November 1999 on Superhuman): 1 Alien Retaliation mission is added, in addition to the above.
* There is a 6% chance for a supply mission to be generated each day, for each alien base.

===Missions Selection===
The game will create an array of possible missions for each region of the world to be used when randomly selecting missions for each month. The random missions assigned to each region can be of 5 kinds: Alien Research, Base, Abductions, Harvest and Infiltration. Alien Terror, Retaliation and Supply missions are special cases and are not present in this array since those missions are automatically generated.

Once a particular mission is selected it will be removed from the array and won't appear again for that region. If all of the missions in the array are used then the game will restart this process and refill the mission array, usually somewhere around 2000. (this is unique to openxcom, and didn't occur in the original)

First the game will randomly choose a region for the mission, using weighted factors (defined on the [[ZONAL.DAT]] file in the original game and in [[Ruleset Reference (OpenXcom)#Regions|Regions]] on the XCom1Ruleset.rul file) to influence the probability of each region being selected:
* North America: 18
* Arctic: 4
* Antarctic: 4
* South America: 10
* Europe: 16
* North Africa: 12
* South Africa: 8
* Central Asia: 12
* Southeast Asia: 15
* Siberia: 10
* Australia: 10
* Pacific: 5
* North Atlantic: 5
* South Atlantic: 5
* Indian Ocean: 5

The 3 last regions don't have any random missions assigned and they won't see any Alien Terror missions since they have no cities present. However, it will be possible to see Alien Retaliation missions if any UFOs are shot down over those areas. This is because the target region for the retaliation is randomly picked between the UFO's mission region and the intercepting craft's point of origin. In the event that the interceptor's point of origin was one of these regions, a nearby region may be substituted in. Original handling would default the region to North America.

As said above, each region has several missions assigned. The mission will be randomly selected also based on weighted factors (defined on [[ACTS.DAT]] and in [[Ruleset Reference (OpenXcom)#Regions|Regions]] on the XCom1Ruleset.rul file), which are shown on the table below.

{|class="wikitable" width="70%"
| align="center" style="background:#f0f0f0;"|'''Region'''
| align="center" style="background:#f0f0f0;"|'''Research'''
| align="center" style="background:#f0f0f0;"|'''Harvest'''
| align="center" style="background:#f0f0f0;"|'''Abduction'''
| align="center" style="background:#f0f0f0;"|'''Infiltration'''
| align="center" style="background:#f0f0f0;"|'''Base'''
|- align="center"
| North America||14||17||20||20||20
|- align="center"
| Arctic||25||NA||NA||NA||35
|- align="center"
| Antarctic||25||NA||NA||NA||35
|- align="center"
| South America||10||24||12||18||22
|- align="center"
| Europe||10||10||15||20||6
|- align="center"
| North Africa||8||8||8||8||19
|- align="center"
| South Africa||7||8||8||8||9
|- align="center"
| Central Asia||5||5||6||10||8
|- align="center"
| Southeast Asia||8||13||21||13||8
|- align="center"
| Siberia||6||NA||4||NA||9
|- align="center"
| Australia||15||11||4||8||16
|- align="center"
| Pacific||15||NA||NA||NA||27
|-
|}

The information on the table can be used together with any Alien Activity shown on the game's Graphs to make an educated guess on what the aliens are up to in certain areas. For instance, alien activity in Northern Africa, Arctic, Antarctic or the Pacific have a higher chance of an Alien Base being established on those regions.

Finally, the race of the aliens present for each mission will be randomly selected according to their [[Alien Appearance Ratios]]. In the XCom1Ruleset.rul this can be changed under [[Ruleset Reference (OpenXcom)#Alien Missions|Alien Missions]], on the raceWeights subsection.

===Missions & UFOs===
Each alien mission will consist of a wave of several UFOs, each of a specific type and with a particular flight pattern. The type and number of UFOs and the time interval between them are defined on the [[MISSIONS.DAT]] file (original game) or under the [[Ruleset Reference (OpenXcom)#Waves|Waves]] subsection of the AlienMissions section of the XCom1Ruleset.rul file.

{| class="wikitable" width="70%"
| align="center" style="background:#f0f0f0;"|'''Alien Mission'''
| align="center" style="background:#f0f0f0;"|'''UFO Type'''
| align="center" style="background:#f0f0f0;"|'''UFO Count'''
| align="center" style="background:#f0f0f0;"|'''Timer (minutes)'''
| align="center" style="background:#f0f0f0;"|'''UFO Trajectory'''
|- align="center"
| rowspan="4"| Alien Research
|- align="center"
| Small Scout||1||9000||P0
|- align="center"
| Medium Scout||1||7800||P2
|- align="center"
| Large Scout||2||9000||P4
|- align="center"
| rowspan="9"| Alien Harvest
|- align="center"
| Small Scout||1||7800||P0
|- align="center"
| Small Scout||1||7800||P2
|- align="center"
| Medium Scout||1||6000||P2
|- align="center"
| Large Scout||1||7800||P0
|- align="center"
| Large Scout||1||9000||P3
|- align="center"
| Harvester||1||3000||P4
|- align="center"
| Harvester||1||750||P4
|- align="center"
| Battleship||1||1500||P2
|- align="center"
| rowspan="6"| Alien Abduction
|- align="center"
| Small Scout||1||15000||P0
|- align="center"
| Medium Scout||1||18000||P1
|- align="center"
| Large Scout||1||9000||P3
|- align="center"
| Abductor||1||9000||P3
|- align="center"
| Abductor||2||60||P4
|- align="center"
| rowspan="9"| Alien Infiltration
|- align="center"
| Small Scout||1||16500||P0
|- align="center"
| Medium Scout||1||15000||P1
|- align="center"
| Medium Scout||1||13800||P6
|- align="center"
| Large Scout||1||9000||P7
|- align="center"
| Large Scout||1||60||P7
|- align="center"
| Terror Ship||1||60||P7
|- align="center"
| Supply Ship||1||60||P7
|- align="center"
| Battleship||2||60||P7
|- align="center"
| rowspan="6"| Alien Base
|- align="center"
| Small Scout||1||13500||P1
|- align="center"
| Medium Scout||1||15000||P5
|- align="center"
| Large Scout||1||60||P5
|- align="center"
| Supply Ship||2||60||P5
|- align="center"
| Battleship||1||60||P6
|- align="center"
| rowspan="5"| Alien Terror
|- align="center"
| Medium Scout||1||15000||P1
|- align="center"
| Large Scout||1||9600||P1
|- align="center"
| Terror Ship||1||12000||P0
|- align="center"
| Terror Ship||1||9000||P7
|- align="center"
| rowspan="5"| Alien Retaliation
|- align="center"
| Small Scout||1||3000||P8
|- align="center"
| Medium Scout||2||3000||P8
|- align="center"
| Large Scout||3||3000||P8
|- align="center"
| Battleship||2||3000||P8
|- align="center"
| rowspan="2"| Alien Supply
|- align="center"
| Supply Ship||1||6000||P9
|-
|}

The actual value of the timer between missions will be set between 50-150% of the value above displayed above. Shooting down a UFO will add 1-9 days (1440 - 12960 min.) to the next timer. {{Template:Verify}} For more details check the [[MISSIONS.DAT]] page. Those delays from shooting down UFOs can postpone Alien missions to the next month, which can result in situations such as 2 Terror Sites in the same month.

===UFO Trajectories===
The [[Ruleset Reference (OpenXcom)#UFO Trajectories|UFO trajectories]] are used by the game to determine the actual flight path of the UFO, as well as their speed/altitude and any possible landings and time spent on the ground. Each UFO trajectory has the following attributes:
* Trajectory ID
* Ground Timer (minutes spend on ground before taking-off)
* List of Waypoints. Each trajectory will have several waypoints, including entry/exit of Earth's atmosphere and patrol/landing areas. Those areas are called Misson Zones and each region has several defined zones. Each waypoint is used to determine the next destination of the UFO, along with the altitude and speed while flying.
** MissionZone
** Altitude (5 = Very High, 0 = Ground). If the altitude of the next waypoint is 0, the UFO will land up reaching the waypoint it is currently heading towards.
** Speed (% of the UFO's maximum speed)
{|class="wikitable" width="100%"
| align="center" style="background:#f0f0f0;"|'''Trajectory ID''' ''(Ground Timer)''
| align="center" style="background:#f0f0f0;"|'''Mission Zones'''
| align="center" style="background:#f0f0f0;"|'''Altitude'''
| align="center" style="background:#f0f0f0;"|'''Speed (% of UFO Max)'''
| align="center" style="background:#f0f0f0;"|'''Notes'''
|- align="center"
| rowspan="5"| P0 ''3000''
|5||4||100|| rowspan="5"| P0 is the only trajectory where UFOs don't land. It is used mainly by Small Scouts assigned as the 1st UFO on the Abductions, Harvest, Research and Infiltration missions.
|- align="center"
|0||3||74
|- align="center"
|0||1||28
|- align="center"
|1||1||47
|- align="center"
|5||2||100
|- align="center"
| rowspan="8"|P1 ''4000''
|5||4||100|| rowspan="8"|
|- align="center"
|0||2||76
|- align="center"
|0||2||20
|- align="center"
|1||1||44
|- align="center"
|0||0||20
|- align="center"
|0||2||32
|- align="center"
|2||1||65
|- align="center"
|5||0||100
|- align="center"
| rowspan="5"|P2 ''5000''
|5||4||100|| rowspan="5"|
|- align="center"
|0||3||57
|- align="center"
|0||2||26
|- align="center"
|1||1||50
|- align="center"
|5||0||100
|- align="center"
|rowspan="5"|P3 ''6000''
|5||4||100|| rowspan="5"|
|- align="center"
|0||3||30
|- align="center"
|0||2||25
|- align="center"
|2||1||20
|- align="center"
|5||0||100
|- align="center"
| rowspan="8"|P4 ''7000''
|5||4||100|| rowspan="8"|
|- align="center"
|0||2||67
|- align="center"
|0||2||52
|- align="center"
|2||1||40
|- align="center"
|0||0||30
|- align="center"
|0||2||20
|- align="center"
|2||1||30
|- align="center"
|5||0||100
|- align="center"
|rowspan="8"| P5 ''4000''
|5||4||100|| rowspan="8"|
|- align="center"
|0||2||50
|- align="center"
|0||2||20
|- align="center"
|4||1||15
|- align="center"
|0||0||20
|- align="center"
|0||2||29
|- align="center"
|4||1||42
|- align="center"
|5||0||90
|- align="center"
|rowspan="5"|P6 ''5000''
|5||4||100|| rowspan="5"|
|- align="center"
|0||3||50
|- align="center"
|0||2||25
|- align="center"
|4||1||16
|- align="center"
|5||0||100
|- align="center"
|rowspan="5"| P7 ''9000''
|5||4||100|| rowspan="5"| P7 trajectories are only used by UFOs that land on cities, namely the Terror Ship that triggers the appearance of a Terror Site, and the last phase of the Alien Infiltration mission, where several UFOs descend on cities.
|- align="center"
|0||3||60
|- align="center"
|0||2||30
|- align="center"
|3||1||20
|- align="center"
|5||0||100
|- align="center"
|rowspan="8"| P8 ''6000''
|5||4||100|| rowspan="8"| P8 trajectories are exclusive to UFOs on Retaliation missions. However, the Battleship that conducts the actual assault on the XCom base will use instead the RETALIATION trajectory.
|- align="center"
|1||1||60
|- align="center"
|2||1||20
|- align="center"
|3||1||30
|- align="center"
|4||1||20
|- align="center"
|0||1||42
|- align="center"
|2||1||56
|- align="center"
|5||4||100
|- align="center"
|rowspan="2"| P9 ''2000''
|5||4||80|| rowspan="2"| P9 trajectories are only used for Alien Supply missions.
|- align="center"
|5||0||100
|- align="center"
|rowspan="2"| RETALIATION ''1000''
|5||4||100|| rowspan="2"|
|- align="center"
|5||0||100
|-
|}

The following sequence of images shows a Large Scout on a Terror mission with a P1 trajectory as it moves from one waypoint to the other.

[[File:Large Scout P0 Trajectory (EU).png]]

===Mission Zones===
Finally, each region can have up to 6 types of Mission Zones, defined under [[Ruleset Reference (OpenXcom)#Regions|Regions]], corresponding to different areas on the map. Mission Zones 5 are used exclusively as UFO entry/exit areas from the globe, while the others can be used either for travel or landings, depending on the UFO's trajectory and mission. Mission Zones 3 are the cities that appear on Geoscape and they are used by Alien Infiltration and Alien Terror missions for landings.

As an example, this image displays the Mission Zones for Europe.

[[Image: Mission Zones Europe (EU).png|1000px]]

It is possible to see the Mission Zones for all regions using Falko's [http://falkooxc2.pythonanywhere.com/worldeditor WorldEditor].

==See Also==
*[[Ruleset Reference (OpenXcom)]]

[[Category:OpenXcom]]

Talk:Alien Appearance Ratios (TFTD)

2015-08-30T14:41:51Z

Warboy1982:

In these tables there is only one column for "Mixed Crew", but there are two different sorts of Mixed Crew. What's going on here? [[User:Magic9mushroom|Magic9mushroom]] 07:34, 7 February 2012 (EST)

: That's because there's only one column of probabilities available in the table that is taken directly from the game executable. I think where the mixed crew types 1 and 2 come from is the equipment and rank makeup tables. [[User:NKF|NKF]] 01:08, 8 February 2012 (EST)

So a single Alien Surface Attacks mission with a Mixed Crew (according to this table, the only Mixed Crew mission that should ever occur) could have different (ie Tasoth-based vs. Lobsterman-based) crews on different subs? This sounds like it needs to be checked. [[User:Magic9mushroom|Magic9mushroom]] 02:35, 8 February 2012 (EST)

: I had a re-read of the relevant articles, and I see the game specifically marks them as a type 4 and type 5, yet the probability table only has one column for both. If this is the case, then the game must do a toss between the two main races at the time it decides on creating the surface attack scouting wave or instant surface attack mission. [[User:NKF|NKF]] 02:52, 8 February 2012 (EST)

The choice between the two types of Mixed Crew appears to be not the only one the game makes. Tasoths on land missions can be accompanied by either Bio-Drones or Triscenes (not by both). I have saved a game just before a Shipping Lane Attack mission, and tried to start playing from it several times. And I have always got Tasoths + Bio-Drones on a Cargo Ship Terror mission. So, the "racial" contents of the alien crew as well as the type of the attacked ship must be fixed before the start of the mission. The only thing that changes is the number of the aliens.

As a result, in the observed alien appearance ratios some sub-types are distinguished:

1. Tasoths on land missions
(a) Tasoths + Bio-Drones
(b) Tasoths + Triscenes

2. Mixed Crew on land missions
2.1.
(a) Tasoths + Bio-drones + Aquatoids + Xarquids (or Calcinites?)
(b) Tasoths + Triscenes + Aquatoids + Calcinites (or Xarquids?)
2.2.
(c) Lobster Men + Bio-Drones (or Calcinites???) + Aquatoids + Deep Ones

(Details on Mixed Crew are quite a mystery for me; here I am relying on the contents of [[Mixed Crew]] article rather than on my own observations from the game.)

Do you know how and where the sub-types are coded in the game exe or/and data files?

[[User:Sherlock|Sherlock]] 09:12, 19 January 2013 (EST)

Addition: if to believe what has been said in [[Talk:Mixed_Crew]], Bio-drones and Triscenes are possible in one mission side by side - only with the mixed crew of Tasoths and Aquatoids? Telling the truth, I have not spot one yet (even if played TFTD many times). Any way,

Tasoths + Triscenes + Bio-Drones + Aquatoids + Calcinites on the 1st stage

Tasoths + Triscenes + Bio-Drones + Aquatoids + Xarquids on the 2nd stage

of a ship terror mission have been reported.

Perhaps yet more types of Mixed Crew are possible then. It is hard for me to check it: mixed crew may not happen is some campaigns at all.

[[User:Sherlock|Sherlock]] 09:49, 19 January 2013 (EST)

== a) Sonic research encouraging tougher aliens b) Tasoth appearance time error? ==

I've seen this referred to elsewhere, but I can't find it now: someone wanting to "bust the myth" that lobstermen appear later if you delay research on sonics.
I'm just playing a superhuman game, and have researched all sonics pretty much as late as possible, and lobsters haven't appeared until June. It definitely feels like a very late showing, and it came just after I got my first few sonics.

I had the same occur in UFO with late appearing snakemen (& mutons and ethereals) when I delayed plasma research.

If the new appearance percentages come in on the 1st of every other month, and don't ramp up gradually, then this data supports the tentative theory for me: it has been quite marked. How well understood is the code about this?

As a second, related point, something appears to be wrong somewhere with these charts: Playing TFTD on steam, with Xcomutil being used to catch bugs and having an otherwise "classic" game, I had a Tasoth and Bio-drone cargo ship terror mission on May 1st, which should be flat-out impossible according to these tables. It's now June 16th and I still haven't seen them since.

:Even though the aliens start to get the probability of appearing, that doesn't always guarantee that they'll appear. I had one game in UFO where I never even met the Mutons. Once they get a probability of appearing, missions for these races will start to get scheduled from the 1st and will not necessarily show up right away. What you'll get initially will be the leftovers from the last month.

:I'm not sure about the slightly earlier Tasoth mission, unless these probabilities only affect the normal sub waves that go out searching for a terror site and the monthly instant terror missions follow slightly different rules (Or suffer a fencepost error). XComutil doesn't touch the probabilities, and I doubt the probabilities will have changed when the Dos version was ported to the CE version. -[[User:NKF|NKF]] 03:55, 19 June 2012 (EDT)

Tasoths + Bio-Drone shipping route attacks in May may be a rule in the game, or an result of a bug. I have just got one as well. And I have checked missions.dat - there is no trace of any Tasoth activity there, only 0 (Aquatoids) and 1 (Gill Men) missions. Which is more, there is not a single Alien Surface Attack active mission recorded in there as well. I have checked saved games before the attack (of April 2040) and after the mission, and still no trace of any Tasoth alien mission at all.

In addition: the place of the attack is not very far from a base of mine. There is a Wide Array Sonar in the base, so the chance of detecting a battleship heading for the attack was not very low - but I did not detect anything, and such an event is not the first time. It looks like the aliens emerged from beneath the waves just to the attacked ship.

Some interesting questions arise then:

(1) Shouldn't any alien active mission be recorded in missions.dat?

(2) Is there a possibility that some kind of alien activities are hard recorded (in the exe) and are thus basic events of the game timeline (or its milestones)?

(3) Or perhaps the-first-day-of-the-month alien surface attacks are not scheduled in the same way like other alien missions?

And, as a consequence, tasoths may appear on them even if they should not have appeared yet, as it is too early for it according to the game alien appearance ratios?

[[User:Sherlock|Sherlock]] 09:35, 19 January 2013 (EST)

I'll just chip in and say I've seen a Tasoth shipping route terror mission as early as 1st April (it wasn't an April fools, sadly). In fact, in that game they showed up before the Lobster Men. I was playing on Superhuman.
--[[User:Darkpast|Darkpast]] 10:32, 30 July 2013 (EDT)
:Update: I think I may have found the answer to the Tasoth mission in April. According to the tables here, it seems that a Lobsterman terror mission has a 50% chance of spawning in April. However, I remember that every single time I played the game, there was a Shipping Route mission with either Lobster Men or (rarely) Tasoths in the first few days of April. Therefore, Sherlock's point #3 seems correct: the missions at the beginning of the month are recorded somewhere else... And I have a hunch it's the same place that Artifact Site missions are recorded, because Artifact Sites aren't "normal" missions either; they simply pop out of nowhere. Furthermore, later in the game there will (almost?) always be either an Artifact Site or Shipping Route mission at the beginning of the month - if you try re-loading the game you'll see they're interchangeable; you can get either one (seems the chance is 50-50). --[[User:Darkpast|Darkpast]] ([[User talk:Darkpast|talk]]) 17:22, 3 July 2014 (EDT)

== Alien Missions and Attacks ==

Perhaps I have found a solution of the April Tasoth problem, and by the way, of the problem of alien appearance ratios for Floating Base Attack, said to be superfluous and not used by the game.

It seems that the aliens take a part in both missions and attacks which are not part of any mission (and thus are not recorded). Single attacks (not being part of a mission) mean shipping route, port and island terror attacks, not scheduled before, not preceded by an appearance of any USO (the aliens attack immediately) and not in agreement with the tables presented in the current article. Hence Tasoths may appear in April, and hence aliens may terrorize land as early as in the first days of the campaign.

Note that an Alien Surface Attacks mission, unlike a single attack, contains of several phases. It begins from smaller USOs, and only in the last phase a Battleship appears and attacks a ship, a port or an island. It is in total agreement with the appearence charts discussed here. Unlike this, single attacks are not preceded by smaller USO's, and are not in agreement with the charts.

Single terror attacks are frequent in first months, then they seem to cease. Aliens can still terrorize ships, ports and islands but during their Alien Surface Attacks missions rather than single attacks.

As it seems to me, a similar mechanism lies behind attacks on XCom bases. Some of the attacks are a result of an alien response to downing a USO (with a chance which depends on the game difficulty level). Contrary to single terror attacks, a Dreadnought always appears then. The aliens know exactly where the XCom base is located. Appearance ratios are of no use then - it is the same race which responds, as the race whose USO was downed by XCom.

These single attacks in response to USO downing seem to have nothing to do with Floating Base Attack missions. Like other of the 7 mission types altogether, Floating Base Attacks are scheduled and consist of several phases. Alien Appearence Ratios are applied. It is only a chance that the aliens will find the XCom base location.

[[User:Sherlock|Sherlock]] ([[User talk:Sherlock|talk]]) 07:40, 14 September 2014 (EDT)

: You would be right there. The tables only really apply to the scheduling of UFOs that show up in chained scouting waves. The more regular appearances. The one-offs are a bit of an exception.

: I don't recall getting into this situation myself, but if the aliens were persistent enough to create a colony very early into the game, and you were eager enough to tackle it with the good old harpoons and gauss, then you would quite likely meet the Tasoth well before they are scheduled to start appearing. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 01:39, 15 September 2014 (EDT)

:I've noticed this discussion on the OpenXCom forums about the Single Attacks, as called by Sherlock and my question here is what proof there is (code/setting in the game files, etc.) that they exist and if this isn't a misinterpretation of the UFO wave system. NKF already mentioned that Tasoths can appear in the early game if the RNG spawns an alien colony in the first months, or if an Artifact Site is activated, although the latter only appears after a certain game stage IIRC. So let's take a few of the claims here and try to examine them in the light of the current theory.
*"It seems that the aliens take a part in both missions and attacks which are not part of any mission (and thus are not recorded)." - by not being recorded I assume that it means that it doesn't appear on the graphs. But what is the point of not recording the attacks, since they will not score points for the aliens?
*"Single terror attacks are frequent in first months, then they seem to cease." - Could this be that in the first months the sonars don't automatically detect all the UFOs (only the Transmission Resolver does so), so they have failed to pick any UFO scouts send as a wave?
:All this being said, it is quite possible that some missions (Artifact Site) don't have any scout UFOs being generated (or simply any UFOs) but to me the real proof lies on the [[MISSIONS.DAT]] equivalent of TFTD rather than ingame observations that might be flawed. Warboy1982 should be checking this for OpenTFTD so we should have some light after he finishes the conversion. [[User:Hobbes|Hobbes]] ([[User talk:Hobbes|talk]]) 10:01, 15 September 2014 (EDT)

To settle the confusion over this, i've made a small adjustment to the tables to reflect what actually happens in the function that spawns the shipping route missions. It doesn't take the progression of time into account, it simply references the fourth racial distribution table for alien surface attacks. In short: tasoth shipping route terror missions are a very real possibility, even as early as april 1st (as supported by all the anecdotal evidence above) --[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 09:29, 30 August 2015 (EDT)

Talk:Alien Appearance Ratios (TFTD)

2015-08-30T13:29:53Z

Warboy1982: /* a) Sonic research encouraging tougher aliens b) Tasoth appearance time error? */

In these tables there is only one column for "Mixed Crew", but there are two different sorts of Mixed Crew. What's going on here? [[User:Magic9mushroom|Magic9mushroom]] 07:34, 7 February 2012 (EST)

: That's because there's only one column of probabilities available in the table that is taken directly from the game executable. I think where the mixed crew types 1 and 2 come from is the equipment and rank makeup tables. [[User:NKF|NKF]] 01:08, 8 February 2012 (EST)

So a single Alien Surface Attacks mission with a Mixed Crew (according to this table, the only Mixed Crew mission that should ever occur) could have different (ie Tasoth-based vs. Lobsterman-based) crews on different subs? This sounds like it needs to be checked. [[User:Magic9mushroom|Magic9mushroom]] 02:35, 8 February 2012 (EST)

: I had a re-read of the relevant articles, and I see the game specifically marks them as a type 4 and type 5, yet the probability table only has one column for both. If this is the case, then the game must do a toss between the two main races at the time it decides on creating the surface attack scouting wave or instant surface attack mission. [[User:NKF|NKF]] 02:52, 8 February 2012 (EST)

The choice between the two types of Mixed Crew appears to be not the only one the game makes. Tasoths on land missions can be accompanied by either Bio-Drones or Triscenes (not by both). I have saved a game just before a Shipping Lane Attack mission, and tried to start playing from it several times. And I have always got Tasoths + Bio-Drones on a Cargo Ship Terror mission. So, the "racial" contents of the alien crew as well as the type of the attacked ship must be fixed before the start of the mission. The only thing that changes is the number of the aliens.

As a result, in the observed alien appearance ratios some sub-types are distinguished:

1. Tasoths on land missions
(a) Tasoths + Bio-Drones
(b) Tasoths + Triscenes

2. Mixed Crew on land missions
2.1.
(a) Tasoths + Bio-drones + Aquatoids + Xarquids (or Calcinites?)
(b) Tasoths + Triscenes + Aquatoids + Calcinites (or Xarquids?)
2.2.
(c) Lobster Men + Bio-Drones (or Calcinites???) + Aquatoids + Deep Ones

(Details on Mixed Crew are quite a mystery for me; here I am relying on the contents of [[Mixed Crew]] article rather than on my own observations from the game.)

Do you know how and where the sub-types are coded in the game exe or/and data files?

[[User:Sherlock|Sherlock]] 09:12, 19 January 2013 (EST)

Addition: if to believe what has been said in [[Talk:Mixed_Crew]], Bio-drones and Triscenes are possible in one mission side by side - only with the mixed crew of Tasoths and Aquatoids? Telling the truth, I have not spot one yet (even if played TFTD many times). Any way,

Tasoths + Triscenes + Bio-Drones + Aquatoids + Calcinites on the 1st stage

Tasoths + Triscenes + Bio-Drones + Aquatoids + Xarquids on the 2nd stage

of a ship terror mission have been reported.

Perhaps yet more types of Mixed Crew are possible then. It is hard for me to check it: mixed crew may not happen is some campaigns at all.

[[User:Sherlock|Sherlock]] 09:49, 19 January 2013 (EST)

== a) Sonic research encouraging tougher aliens b) Tasoth appearance time error? ==

I've seen this referred to elsewhere, but I can't find it now: someone wanting to "bust the myth" that lobstermen appear later if you delay research on sonics.
I'm just playing a superhuman game, and have researched all sonics pretty much as late as possible, and lobsters haven't appeared until June. It definitely feels like a very late showing, and it came just after I got my first few sonics.

I had the same occur in UFO with late appearing snakemen (& mutons and ethereals) when I delayed plasma research.

If the new appearance percentages come in on the 1st of every other month, and don't ramp up gradually, then this data supports the tentative theory for me: it has been quite marked. How well understood is the code about this?

As a second, related point, something appears to be wrong somewhere with these charts: Playing TFTD on steam, with Xcomutil being used to catch bugs and having an otherwise "classic" game, I had a Tasoth and Bio-drone cargo ship terror mission on May 1st, which should be flat-out impossible according to these tables. It's now June 16th and I still haven't seen them since.

:Even though the aliens start to get the probability of appearing, that doesn't always guarantee that they'll appear. I had one game in UFO where I never even met the Mutons. Once they get a probability of appearing, missions for these races will start to get scheduled from the 1st and will not necessarily show up right away. What you'll get initially will be the leftovers from the last month.

:I'm not sure about the slightly earlier Tasoth mission, unless these probabilities only affect the normal sub waves that go out searching for a terror site and the monthly instant terror missions follow slightly different rules (Or suffer a fencepost error). XComutil doesn't touch the probabilities, and I doubt the probabilities will have changed when the Dos version was ported to the CE version. -[[User:NKF|NKF]] 03:55, 19 June 2012 (EDT)

Tasoths + Bio-Drone shipping route attacks in May may be a rule in the game, or an result of a bug. I have just got one as well. And I have checked missions.dat - there is no trace of any Tasoth activity there, only 0 (Aquatoids) and 1 (Gill Men) missions. Which is more, there is not a single Alien Surface Attack active mission recorded in there as well. I have checked saved games before the attack (of April 2040) and after the mission, and still no trace of any Tasoth alien mission at all.

In addition: the place of the attack is not very far from a base of mine. There is a Wide Array Sonar in the base, so the chance of detecting a battleship heading for the attack was not very low - but I did not detect anything, and such an event is not the first time. It looks like the aliens emerged from beneath the waves just to the attacked ship.

Some interesting questions arise then:

(1) Shouldn't any alien active mission be recorded in missions.dat?

(2) Is there a possibility that some kind of alien activities are hard recorded (in the exe) and are thus basic events of the game timeline (or its milestones)?

(3) Or perhaps the-first-day-of-the-month alien surface attacks are not scheduled in the same way like other alien missions?

And, as a consequence, tasoths may appear on them even if they should not have appeared yet, as it is too early for it according to the game alien appearance ratios?

[[User:Sherlock|Sherlock]] 09:35, 19 January 2013 (EST)

I'll just chip in and say I've seen a Tasoth shipping route terror mission as early as 1st April (it wasn't an April fools, sadly). In fact, in that game they showed up before the Lobster Men. I was playing on Superhuman.
--[[User:Darkpast|Darkpast]] 10:32, 30 July 2013 (EDT)
:Update: I think I may have found the answer to the Tasoth mission in April. According to the tables here, it seems that a Lobsterman terror mission has a 50% chance of spawning in April. However, I remember that every single time I played the game, there was a Shipping Route mission with either Lobster Men or (rarely) Tasoths in the first few days of April. Therefore, Sherlock's point #3 seems correct: the missions at the beginning of the month are recorded somewhere else... And I have a hunch it's the same place that Artifact Site missions are recorded, because Artifact Sites aren't "normal" missions either; they simply pop out of nowhere. Furthermore, later in the game there will (almost?) always be either an Artifact Site or Shipping Route mission at the beginning of the month - if you try re-loading the game you'll see they're interchangeable; you can get either one (seems the chance is 50-50). --[[User:Darkpast|Darkpast]] ([[User talk:Darkpast|talk]]) 17:22, 3 July 2014 (EDT)

To settle the confusion over this, i've made a small adjustment to the tables to reflect what actually happens. In the function that spawns the shipping route missions, it doesn't take the progression of time into account, it simply references a the fourth racial distribution table for alien surface attacks. In short: tasoth shipping route terror missions are a very real possibility, even as early as april 1st (as supported by all the anecdotal evidence above) --[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 09:29, 30 August 2015 (EDT)

== Alien Missions and Attacks ==

Perhaps I have found a solution of the April Tasoth problem, and by the way, of the problem of alien appearance ratios for Floating Base Attack, said to be superfluous and not used by the game.

It seems that the aliens take a part in both missions and attacks which are not part of any mission (and thus are not recorded). Single attacks (not being part of a mission) mean shipping route, port and island terror attacks, not scheduled before, not preceded by an appearance of any USO (the aliens attack immediately) and not in agreement with the tables presented in the current article. Hence Tasoths may appear in April, and hence aliens may terrorize land as early as in the first days of the campaign.

Note that an Alien Surface Attacks mission, unlike a single attack, contains of several phases. It begins from smaller USOs, and only in the last phase a Battleship appears and attacks a ship, a port or an island. It is in total agreement with the appearence charts discussed here. Unlike this, single attacks are not preceded by smaller USO's, and are not in agreement with the charts.

Single terror attacks are frequent in first months, then they seem to cease. Aliens can still terrorize ships, ports and islands but during their Alien Surface Attacks missions rather than single attacks.

As it seems to me, a similar mechanism lies behind attacks on XCom bases. Some of the attacks are a result of an alien response to downing a USO (with a chance which depends on the game difficulty level). Contrary to single terror attacks, a Dreadnought always appears then. The aliens know exactly where the XCom base is located. Appearance ratios are of no use then - it is the same race which responds, as the race whose USO was downed by XCom.

These single attacks in response to USO downing seem to have nothing to do with Floating Base Attack missions. Like other of the 7 mission types altogether, Floating Base Attacks are scheduled and consist of several phases. Alien Appearence Ratios are applied. It is only a chance that the aliens will find the XCom base location.

[[User:Sherlock|Sherlock]] ([[User talk:Sherlock|talk]]) 07:40, 14 September 2014 (EDT)

: You would be right there. The tables only really apply to the scheduling of UFOs that show up in chained scouting waves. The more regular appearances. The one-offs are a bit of an exception.

: I don't recall getting into this situation myself, but if the aliens were persistent enough to create a colony very early into the game, and you were eager enough to tackle it with the good old harpoons and gauss, then you would quite likely meet the Tasoth well before they are scheduled to start appearing. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 01:39, 15 September 2014 (EDT)

:I've noticed this discussion on the OpenXCom forums about the Single Attacks, as called by Sherlock and my question here is what proof there is (code/setting in the game files, etc.) that they exist and if this isn't a misinterpretation of the UFO wave system. NKF already mentioned that Tasoths can appear in the early game if the RNG spawns an alien colony in the first months, or if an Artifact Site is activated, although the latter only appears after a certain game stage IIRC. So let's take a few of the claims here and try to examine them in the light of the current theory.
*"It seems that the aliens take a part in both missions and attacks which are not part of any mission (and thus are not recorded)." - by not being recorded I assume that it means that it doesn't appear on the graphs. But what is the point of not recording the attacks, since they will not score points for the aliens?
*"Single terror attacks are frequent in first months, then they seem to cease." - Could this be that in the first months the sonars don't automatically detect all the UFOs (only the Transmission Resolver does so), so they have failed to pick any UFO scouts send as a wave?
:All this being said, it is quite possible that some missions (Artifact Site) don't have any scout UFOs being generated (or simply any UFOs) but to me the real proof lies on the [[MISSIONS.DAT]] equivalent of TFTD rather than ingame observations that might be flawed. Warboy1982 should be checking this for OpenTFTD so we should have some light after he finishes the conversion. [[User:Hobbes|Hobbes]] ([[User talk:Hobbes|talk]]) 10:01, 15 September 2014 (EDT)

Alien Appearance Ratios (TFTD)

2015-08-30T13:16:01Z

Warboy1982:

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | December (2039) - January
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 70%
| 30%
| -
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 60%
| 40%
| -
| -
| -
|-
| Alien Infiltration
| 60%
| 40%
| -
| -
| -
|-
| Alien Colony Expansion
| 30%
| 70%
| -
| -
| -
|-
| Alien Surface Attacks
| -
| 100%
| -
| -
| -
|-
| Floating Base Attack
| 60%
| 40%
| -
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | February - March
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 60%
| 30%
| 10%
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 40%
| 60%
| -
| -
| -
|-
| Alien Infiltration
| 50%
| 30%
| 20%
| -
| -
|-
| Alien Colony Expansion
| 40%
| 40%
| 20%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 80%
| -
| -
| -
|-
| Floating Base Attack
| 30%
| 40%
| 30%
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | April - May
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 30%
| 40%
| 30%
| -
| -
|-
| Alien Interdiction
| 30%
| 50%
| 20%
| -
| -
|-
| Alien Resource Raid
| 50%
| 50%
| -
| -
| -
|-
| Alien Infiltration
| 20%
| 50%
| 30%
| -
| -
|-
| Alien Colony Expansion
| 10%
| 30%
| 60%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 30%
| 50%
| -
| -
|-
| Floating Base Attack
| 20%
| 60%
| 20%
| -
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | June - July
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 10%
| 40%
| 30%
| -
|-
| Alien Interdiction
| 10%
| -
| 40%
| 50%
| -
|-
| Alien Resource Raid
| 30%
| -
| -
| 70%
| -
|-
| Alien Infiltration
| 10%
| 30%
| 20%
| 40%
| -
|-
| Alien Colony Expansion
| 10%
| 40%
| 30%
| 20%
| -
|-
| Alien Surface Attacks
| 10%
| 30%
| 20%
| 20%
| 20%
|-
| Floating Base Attack
| 20%
| 30%
| 30%
| 20%
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | August and Beyond
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 20%
| 20%
| 40%
| -
|-
| Alien Interdiction
| 30%
| -
| 30%
| 40%
| -
|-
| Alien Resource Raid
| 50%
| -
| -
| 50%
| -
|-
| Alien Infiltration
| 30%
| 10%
| 50%
| 10%
| -
|-
| Alien Colony Expansion
| 10%
| 20%
| 60%
| 10%
| -
|-
| Alien Surface Attacks
| 20%
| 20%
| 20%
| 10%
| 30%
|-
| Floating Base Attack
| 10%
| 10%
| 60%
| 20%
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%
|}

<noinclude>
== Notes ==
* December 2039 is included in the first table, but the game begins in January 2040. Each table covers two month blocks.

* All months beyond August 2040 use the August table.

* All values listed above are interpreted off probability tables obtained directly from TFTD's [[GEOSCAPE.EXE]].

* Established Alien Colonies, Artefact Sites and the final mission [[T'Leth]] have fixed crew types.

* Alien subs on Colony Supply Missions will be crewed by the same species that established the Colony, and ignore the monthly tables.

* Port Attack and Island Attack missions fall under the category '''Alien Surface Attack'''.

* Cruise Ship and Cargo Ship missions fall under the category '''Shipping Route Attack'''.

== See Also ==
* [[Alien Appearance Ratios]] - For Enemy Unknown/UFO Defense

{{Aliens (TFTD)}}

[[Category:Data tables]]
[[Category:TFTD]]
</noinclude>

Alien Appearance Ratios (TFTD)

2015-08-30T13:15:05Z

Warboy1982:

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | December (2039) - January
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 70%
| 30%
| -
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 60%
| 40%
| -
| -
| -
|-
| Alien Infiltration
| 60%
| 40%
| -
| -
| -
|-
| Alien Colony Expansion
| 30%
| 70%
| -
| -
| -
|-
| Alien Surface Attacks
| -
| 100%
| -
| -
| -
|-
| Floating Base Attack
| 60%
| 40%
| -
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | February - March
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 60%
| 30%
| 10%
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 40%
| 60%
| -
| -
| -
|-
| Alien Infiltration
| 50%
| 30%
| 20%
| -
| -
|-
| Alien Colony Expansion
| 40%
| 40%
| 20%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 80%
| -
| -
| -
|-
| Floating Base Attack
| 30%
| 40%
| 30%
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | April - May
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 30%
| 40%
| 30%
| -
| -
|-
| Alien Interdiction
| 30%
| 50%
| 20%
| -
| -
|-
| Alien Resource Raid
| 50%
| 50%
| -
| -
| -
|-
| Alien Infiltration
| 20%
| 50%
| 30%
| -
| -
|-
| Alien Colony Expansion
| 10%
| 30%
| 60%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 30%
| 50%
| -
| -
|-
| Floating Base Attack
| 20%
| 60%
| 20%
| -
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | June - July
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 10%
| 40%
| 30%
| -
|-
| Alien Interdiction
| 10%
| -
| 40%
| 50%
| -
|-
| Alien Resource Raid
| 30%
| -
| -
| 70%
| -
|-
| Alien Infiltration
| 10%
| 30%
| 20%
| 40%
| -
|-
| Alien Colony Expansion
| 10%
| 40%
| 30%
| 20%
| -
|-
| Alien Surface Attacks
| 10%
| 30%
| 20%
| 20%
| 20%
|-
| Floating Base Attack
| 20%
| 30%
| 30%
| 20%
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | August and Beyond
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 20%
| 20%
| 40%
| -
|-
| Alien Interdiction
| 30%
| -
| 30%
| 40%
| -
|-
| Alien Resource Raid
| 50%
| -
| -
| 50%
| -
|-
| Alien Infiltration
| 30%
| 10%
| 50%
| 10%
| -
|-
| Alien Colony Expansion
| 10%
| 20%
| 60%
| 10%
| -
|-
| Alien Surface Attacks
| 20%
| 20%
| 20%
| 10%
| 30%
|-
| Floating Base Attack
| 10%
| 10%
| 60%
| 20%
| -
|-
| Shipping Route Attack
| 10%
| 30%
| 20%
| 20%
| 20%
|}

<noinclude>
== Notes ==
* December 2039 is included in the first table, but the game begins in January 2040. Each table covers two month blocks.

* All months beyond August 2040 use the August table.

* All values listed above are interpreted off probability tables obtained directly from TFTD's [[GEOSCAPE.EXE]].

* Established Alien Colonies, Artefact Sites and the final mission [[T'Leth]] have fixed crew types.

* Alien subs on Colony Supply Missions will be crewed by the same species that established the Colony, and ignore the monthly tables.

* Port Attack and Island Attack missions fall under the category '''Alien Surface Attack'''.

* Cruise Ship and Cargo Ship missions fall under the category '''Shipping Route Attack'''.

== See Also ==
* [[Alien Appearance Ratios]] - For Enemy Unknown/UFO Defense

{{Aliens (TFTD)}}

[[Category:Data tables]]
[[Category:TFTD]]
</noinclude>

Alien Appearance Ratios (TFTD)

2015-08-30T13:10:59Z

Warboy1982: /* Notes */

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | December (2039) - January
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 70%
| 30%
| -
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 60%
| 40%
| -
| -
| -
|-
| Alien Infiltration
| 60%
| 40%
| -
| -
| -
|-
| Alien Colony Expansion
| 30%
| 70%
| -
| -
| -
|-
| Alien Surface Attacks
| -
| 100%
| -
| -
| -
|-
| Floating Base Attack
| 60%
| 40%
| -
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | February - March
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 60%
| 30%
| 10%
| -
| -
|-
| Alien Interdiction
| 50%
| 50%
| -
| -
| -
|-
| Alien Resource Raid
| 40%
| 60%
| -
| -
| -
|-
| Alien Infiltration
| 50%
| 30%
| 20%
| -
| -
|-
| Alien Colony Expansion
| 40%
| 40%
| 20%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 80%
| -
| -
| -
|-
| Floating Base Attack
| 30%
| 40%
| 30%
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | April - May
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 30%
| 40%
| 30%
| -
| -
|-
| Alien Interdiction
| 30%
| 50%
| 20%
| -
| -
|-
| Alien Resource Raid
| 50%
| 50%
| -
| -
| -
|-
| Alien Infiltration
| 20%
| 50%
| 30%
| -
| -
|-
| Alien Colony Expansion
| 10%
| 30%
| 60%
| -
| -
|-
| Alien Surface Attacks
| 20%
| 30%
| 50%
| -
| -
|-
| Floating Base Attack
| 20%
| 60%
| 20%
| -
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | June - July
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 10%
| 40%
| 30%
| -
|-
| Alien Interdiction
| 10%
| -
| 40%
| 50%
| -
|-
| Alien Resource Raid
| 30%
| -
| -
| 70%
| -
|-
| Alien Infiltration
| 10%
| 30%
| 20%
| 40%
| -
|-
| Alien Colony Expansion
| 10%
| 40%
| 30%
| 20%
| -
|-
| Alien Surface Attacks
| 10%
| 30%
| 20%
| 20%
| 20%
|-
| Floating Base Attack
| 20%
| 30%
| 30%
| 20%
| -
|}

{| {{StdTable}} border = "1"
|-
! Colspan = "6" {{StdDescTable Heading}} align = "left" | August and Beyond
|- {{StdTable Sub Heading}}
| Mission/Race
| [[Aquatoid]]
| [[Gillman]]
| [[Lobsterman]]
| [[Tasoth]]
| [[Mixed Crew]]
|-
| Alien Probe Mission
| 20%
| 20%
| 20%
| 40%
| -
|-
| Alien Interdiction
| 30%
| -
| 30%
| 40%
| -
|-
| Alien Resource Raid
| 50%
| -
| -
| 50%
| -
|-
| Alien Infiltration
| 30%
| 10%
| 50%
| 10%
| -
|-
| Alien Colony Expansion
| 10%
| 20%
| 60%
| 10%
| -
|-
| Alien Surface Attacks
| 20%
| 20%
| 20%
| 10%
| 30%
|-
| Floating Base Attack
| 10%
| 10%
| 60%
| 20%
| -
|}

<noinclude>
== Notes ==
* December 2039 is included in the first table, but the game begins in January 2040. Each table covers two month blocks.

* All months beyond August 2040 use the August table.

* All values listed above are interpreted off probability tables obtained directly from TFTD's [[GEOSCAPE.EXE]].

* Established Alien Colonies, Artefact Sites and the final mission [[T'Leth]] have fixed crew types.

* Alien subs on Colony Supply Missions will be crewed by the same species that established the Colony, and ignore the monthly tables.

* Port Attack and Island Attack missions fall under the category '''Alien Surface Attack'''.

* Cruise Ship and Cargo Ship missions fall under the category '''Shipping Route Attack'''.

== See Also ==
* [[Alien Appearance Ratios]] - For Enemy Unknown/UFO Defense

{{Aliens (TFTD)}}

[[Category:Data tables]]
[[Category:TFTD]]
</noinclude>

Zrbite

2015-08-14T12:23:29Z

Warboy1982: /* General Information */

==General Information==

{{Ref Open | title = Zrbite}}
[[Image:Zrbite.png|64px|right]]
This is an alloy of Alien origin, part gold part Alien Bio-material. When utilised as a power source, small quantities will generate more power than a nuclear unit of 10 times the size. It is beyond our technical ability to replicate this material as most of its constituents are Alien in origin.
{{Ref Close | source = Terror From The Deep Ufopaedia}}

{{Infobox open}}
{{Infobox module/itemcommon
| item = Zrbite
| height = 1
| width = 2
| weight = 3
| damagethreshold = 20
| image = [[Image:BigZrbite.png|64px|center]]
| saleprice = 5000
| research =
}}
{{Infobox close}}

Zrbite is the aliens' power source and is a near-equivalent to the [[Elerium-115]] used in the previous alien war.

Although constructed from different materials, its usage is identical in that it powers all alien weapons and craft. X-COM can use Zrbite to manufacture advanced equipment as well as to fuel hybrid submarines.

Zrbite cannot be manufactured and can only be recovered from [[Alien Submarine Assault]]s or [[Colony Assault]]s. Selling Zrbite is therefore not recommended unless a reasonable stockpile is available or a regular source of Zrbite has been found.

In the Battlescape, Zrbite appears as a small yellow bar; if an object occupies the same tile, the yellow bar will be superimposed over that object. In the inventory view, Zrbite appears as a 1 × 2 crystal. Each of these crystals is converted into 50 Zrbite if recovered intact; it bears noting that they are quite fragile and will be destroyed by nearby explosions. Zrbite can be picked up by an Aquanaut standing over it; this is not a preferred method of recovery, however, as Zrbite is usually found inside an object and some of these objects will explode - destroying the Zrbite - if blasted open during a mission in an attempt to retrieve their contents.

This item only appears in ''[[TFTD|Terror from the Deep]]''. For the ''[[X-COM|UFO: Enemy Unknown]]'' equivalent, refer to [[Elerium-115]].

== Obtaining Zrbite ==

[[image: Zrbite engines.png | 256px | right | Ion Beam Accelerators with Zrbite]]

The best way to accumulate Zrbite is to assault intact [[Alien Submarines]] rather than submarines that have been shot down. When shot down, the detonations of the Ion Beam Accelerators have a tendency to destroy the Zrbite. However, unlike Enemy Unknown/UFO Defense, Zrbite is not exclusively stored in the sub's power source and may be found in different locations around the ship. This means that some of the Zrbite on certain vessels may remain intact even if the Ion Beam Accelerators explode.

One example of this is the [[Cruiser]]. As the Zrbite is stored in the tail of the ship, well away from the Ion Beam Accelerators, it will not be destroyed no matter how badly the Cruiser is damaged. As this alien sub appears on all [[Alien Missions (TFTD)|Alien Missions]], it provides a reasonably reliable and low-risk way to obtain Zrbite.

Another method of reliably obtaining Zrbite is to find an intact Alien Colony and perform [[Alien Submarine Assault]]s on the [[Fleet Supply Cruiser]]s that land there. Note that these alien subs are challenging as the enemy crew will be supplemented with [[Disrupter Pulse Launcher]]s. The high risk does provide a suitably high reward in the form of 150 Zrbite and a lot of gear and experience.

== Notes ==

* Researching Zrbite will open up the Research for the Disrupter Pulse Launcher and its ammunition. If you collected the weapon or ammunition samples after you researched Zrbite, they will automatically become available on the completion of the current research project.

==See Also==
{{Equipment (TFTD) Navbar}}

{{Alien Sub Navbar}}

[[Category:New Submersible Technologies]][[Category:Research (TFTD)]][[Category:Equipment (TFTD)]]
[[Category:TFTD]]

File:BigZrbite.png

2015-08-14T12:21:54Z

Warboy1982: Picture of Zrbite as found in bigobs.pck

Picture of Zrbite as found in bigobs.pck

User talk:Warboy1982

2015-08-09T08:01:04Z

Warboy1982:

Warboy,
Does OpenXcom use the same coordinate system for the globe as the original game or did you all remap it in order to make navigation plotting easier? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:20, 6 August 2015 (EDT)

:we converted them in most cases from xcom units into degrees, the in-game coordinate values are actually the same as the ones used on google maps, which makes it pretty easy to locate cities/etc. and add them in to the rulesets.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 05:32, 8 August 2015 (EDT)

::Thanks for the info. For a while, I was investigating the navigation code to eventually fix the Great Circle issue in the original game. I got a working formula but the output for the degrees of heading were never as expected. I looked at what formula OpenXCOM used but it seemed fundamentally the same, so I wondered if you all were using your own map data. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 08:28, 8 August 2015 (EDT)

:::we actually wrote some code to convert all the original data into our format, and we use the world.dat file for the polygons. the only thing we really took liberties with were the region zones. we closed the hole near australia in UFO and 99% of the holes in TFTD (i'm still working on those). you can use debug mode to project all the zones/countries/mission zones on the geoscape in real-time if you wanna make comparisons, or one of our forum members, Falko, made a python script [http://falkooxc2.pythonanywhere.com/worldeditor] to parse it all and give you a cartesian perspective.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:59, 9 August 2015 (EDT)

User talk:Warboy1982

2015-08-09T07:59:20Z

Warboy1982:

Warboy,
Does OpenXcom use the same coordinate system for the globe as the original game or did you all remap it in order to make navigation plotting easier? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:20, 6 August 2015 (EDT)

:we converted them in most cases from xcom units into degrees, the in-game coordinate values are actually the same as the ones used on google maps, which makes it pretty easy to locate cities/etc. and add them in to the rulesets.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 05:32, 8 August 2015 (EDT)

::Thanks for the info. For a while, I was investigating the navigation code to eventually fix the Great Circle issue in the original game. I got a working formula but the output for the degrees of heading were never as expected. I looked at what formula OpenXCOM used but it seemed fundamentally the same, so I wondered if you all were using your own map data. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 08:28, 8 August 2015 (EDT)

:::we actually wrote some code to convert all the original data into our format, and we use the world.dat file for the polygons. the only thing we really took liberties with were the region zones. we closed the hole near australia in UFO and 99% of the holes in TFTD (i'm still working on those). you can use debug mode to project all the zones/countries/mission zones on the geoscape in real-time if you wanna make comparisons, or one of our forum members, Falko, made a python script to parse it all and give you a cartesian perspective. [http://falkooxc2.pythonanywhere.com/worldeditor]--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:59, 9 August 2015 (EDT)

User talk:Warboy1982

2015-08-08T09:32:27Z

Warboy1982:

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

Warboy,

Does OpenXcom use the same coordinate system for the globe as the original game or did you all remap it in order to make navigation plotting easier? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:20, 6 August 2015 (EDT)

we converted them in most cases from xcom units into degrees, the in-game coordinate values are actually the same as the ones used on google maps, which makes it pretty easy to locate cities/etc. and add them in to the rulesets.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 05:32, 8 August 2015 (EDT)

User talk:Warboy1982

2015-08-08T09:32:14Z

Warboy1982:

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

Warboy,

Does OpenXcom use the same coordinate system for the globe as the original game or did you all remap it in order to make navigation plotting easier? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:20, 6 August 2015 (EDT)

we converted them in most cases from xcom units into either degrees, the in-game coordinate values are actually the same as the ones used on google maps, which makes it pretty easy to locate cities/etc. and add them in to the rulesets.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 05:32, 8 August 2015 (EDT)

Talk:Hallucinoid

2015-08-07T07:45:14Z

Warboy1982: /* Clearing this up */

The comments in [[Overviews of Aliens (TFTD)#Hallucinoid - Terror Unit]] say that this unit just attacks

: ''"with its tentacles which do precicely [sic] nothing, while completely ignoring its built-in Thermal Shok Launcher"''

I did some testing on this and I could not reproduce that result. My results were:

# The Hallucinoid does seem to have a preference to close for short range attacks
# Its melee attack seems to be lethal against unarmoured Aquanauts
# Its long range attack is definitely used (though perhaps melee is preferred if there are targets nearby)
# The long range attack is also lethal against unarmoured Aquanauts
# Neither of these attacks do stun damage - or if they do, they still contain enough lethal damage to be fatal

Does anyone know the basis for these comments in the Overview? If not I propose to remove them.
[[User:Spike|Spike]] 14:13, 15 November 2008 (CST)

: It should be Melee type damage. The freeze bit is just fluff text in the ufopaedia, otherwise your units will just be knocked out rather than killed outright. To confirm if it's got a ranged attack, it's probably worth making a savegame with a hallucinoid present and check the unitref.dat entry to see if it has an associated turret attached to it. Otherwise it's effectively no more than a flying Reaper - a brutal one at that if it manages to catch you, plus it has fairly good protection to round it off. -[[User:NKF|NKF]] 14:36, 15 November 2008 (CST)

Thanks for your help NKF. It definitely has a ranged attack, I saw the 'freeze bolt' or whatever it is travelling six squares to hit and kill my (previously uninjured) Aquanaut. I'm not quite sure if its definitely using the tentacles at melee range, or just firing its ranged weapon at point blank. I don't believe the ranged attack is an area effect (as implied by "Built in Thermal Shok Launcher) but I'll check that by offering it multiple targets at once. [[User:Spike|Spike]] 14:56, 15 November 2008 (CST)

: The ranged attack is definitely not area effect. It uses an icon that looks similar to a plasma bolt from XCOM-EU. It looks like it has autofire capability - either that or it just likes to fire at corpses. I'm not sure if anyone knows where these alien built in weapon definitions are located in TFTD? [[User:Spike|Spike]] 15:32, 15 November 2008 (CST)

I've changed the Overview article to remove the claims about ineffectiveness. It's still possible that this alien is ineffective, IF your Aquanauts armour levels are sufficiently high. I was only testing with unarmoured Aquanauts and the Hallucinoid had no difficulty killing them at long range, at melee range, and pursuing them to attack them and finish them off. [[User:Spike|Spike]] 06:12, 14 December 2008 (CST)

UPDATE - as per Zombie's investigations, the ranged attack only works on land and not underwater. This is probably a programming error and was meant to be the other way round. [[User:Spike|Spike]] 15:49, 25 February 2009 (CST)
: Is it really not working at all or just as effective as the Bio-Drohne melee attack?--[[User:Tauon|Tauon]] 22:52, 25 November 2010 (UTC)

::It's "not working", as in, "it won't attempt to fire it". -  [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]]) 00:03, 26 November 2010 (UTC)

Is it possible to fix the unit that the ranged attack works as intended? That would make alien colony missions much more challenging - especially the first part. And artefact, battleship and dreadnought missions as well - right now the difference to gillman for the later is not too big for the two uso missions. --[[User:Tauon|Tauon]] 23:05, 25 November 2010 (UTC)

==Clearing this up==

Okay, so there's been an edit removing the reference to a land-only attack citing the Hallucinoid's lack of appearance on land in unhacked games.

As far as I know, we've got one set of "investigations" by Zombie saying the Hallucinoid has a ranged attack which doesn't work underwater, and IIRC another set by Morgan525 saying that the Hallucinoid doesn't have a ranged attack at all. This has left me, and presumably others, rather confused.

I do know that the question of whether the Hallucinoid has a land-only weapon is NOT related to whether it ordinarily appears on land (if it has a land-only weapon and never appears on land, then that's a bug, but the weapon still exists), but since I have no clue whether it actually has such a weapon I'm not going to revert the edit at this time. If someone could shed some light on this matter, it would be much appreciated. [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 22:01, 5 August 2015 (EDT)

: Yeah, ‎Warboy1982 is one of the lead dev coders for OpenXCOM/OpenTFTD... so I'd say the only other person more "knowledgeable"/qualified would be to ask one of the original designers/coders/programmers. And considering the in-depth work the OpenXCOM/TFTD dev team does, it's really really really difficult to dispute Warboy's findings. See: [http://openxcom.org/forum/index.php/topic,3578.msg49076.html#msg49076 His relevant post] --[[User:DracoGriffin|DracoGriffin]] ([[User talk:DracoGriffin|talk]]) 23:28, 5 August 2015 (EDT)

In the subroutine that writes each alien unit's data in the UNITREF.DAT file, the section that sets the turret weapon and ammo (starting at 0x457EC0 for the windows version) has no provision for Halluciniods: its starts by writing 0 in bytes 0x6F, 0x71, 0x72, 0x73, 0x74, and 0x76 and 0xFF in byte 0x75. Then it checks to see if the unit type is 9, 10, 12, or 14 and sets bytes 0x75 (turret type) and 0x76 (ammo amount) as appropriate - [[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:38, 5 August 2015 (EDT)

:Which unit type corresponds to Hallucinoids? Also, how do you explain Spike's results; would replacing other terrorists with Hallucinoids using XComUtil fail to remove the turret? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:08, 6 August 2015 (EDT)

:: A lot of my past misconceptions about the aliens in TFTD were due to old releases of XComutil, so I wouldn't rule it out. One other possible cause is a glitch turret caused by a bit of junk data that didn't get cleared properly. Otherwise, I agree that Hallucinoids do not get initialised with an innate weapon.

:: I'm not agreeing based on the extensive reverse engineering work that arrived at these findings. Rather, my source of information is a bit more rudimentary and predates it. I can't provide a citation of the exact text just yet, but it is incredibly reliable. If that sounds dubious - then I don't blame you in the least. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 04:51, 6 August 2015 (EDT)

:Hallucinoids are unit type 13 so there isn't a provision for turret weapons on a Hallucinoid. I don't know the inner workings of XComUtil but I agree with NKF that the confusion probably has something to do with early versions of it. It's impossible for the game to spawn a Hallucinoid on land: If the site depth is 0 (surface) and the subroutine that generates the alien data determines that it should create an entry for a Hallucinoid, it uses a Calcinite instead.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 09:58, 6 August 2015 (EDT)

:::NKF and Tycho's findings are consistent with my own, and if NKF's source on this is what i think it is, then you should really, really listen when he speaks.
:::But to elaborate on what i've managed to interpret, hacking in a hallucinoid on a land mission wouldn't necessarily overwrite any object data for the unit it was replacing. Assuming (for the sake of argument) the hallucinoid replaced a deep one, it may indeed have a ranged weapon residing in its inventory that may even be visible if the unit is mind controlled. However, the AI wouldn't be capable of making use of it, because many of the relevent checks actually compare the unit type as described above. As it is not possible for this unit to spawn on land with an unmodified executable, meaning the unit cannot pass through the default constructor - which, even if it did, doesn't specify a ranged weapon. Coupled with the fact that there is no such concept as a "land only weapon" because all of the relevant checks only test for underwater weapons being used on land. This seems like a highly dubious piece of information.(Sorry for so many edits here but text aligning is hard and i'm bad at hitting the preview button at 5am)--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 17:23, 6 August 2015 (EDT)
:I don't know what NKF is using for his source but I always doubt second-hand information until it can be verified by facts from the actual game code or direct testing with verified unmodified game files. (I am not doubting NKF's reputation.) Most of what Warboy says is correct. However, if someone has hacked the game file or game code to allow a unit to be replaced by a Hallucinoid, then the AI can indeed make use of it: When attacking the Alien AI code doesn't check by unit type to see if a unit can fire a turret. Instead it checks to see if a particular unit has a turret weapon and if that weapon has enough ammo to fire. In the case of the celatid/Deep One, it also checks to see if the target is within range of it weapon.
::I suspect that what is happening is that some modification is replacing a Triscene with a Hallucinoid. It would have to replace another large unit or there would be an obvious glitch because the whole unit would not be displayed. From the description of the range attack that this "hallucinoid" has been reported to use, it can't be replacing a Xarquid because its range attack is different from what is described.
::I did a test where I changed the race type of a port attack so that Triscene could be generated: by changing the craft race type to 4 (mixed Tasolth). After starting the mission and saving, I changed the Triscenes to Hallucinoids (by just changing the first byte of each entry from 12 to 13.) These "Hallucinoids" were indeed able to use their range weapons. In a further test, I made each one mind controlled and was able to use their range attack.
::It would be nice if someone had a saved file where Hallucinoids have appeared on land to see what the stats are for them and weather or not they have most of the Hallucinoid's proper stats or only the unit type has been changed. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 22:59, 6 August 2015 (EDT)

This discussion can probably be concluded. It seems that by group consensus:
* Hallucinoids cannot appear on land.
* Hallucinoids do not receive a turret weapon.
* Any other reported deviations can be attributed to modifications of the game code, game files, or possible data corruption.
::Would everyone agree with this summary? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 00:20, 7 August 2015 (EDT)

:Seems reasonable to me. I just wanted to get the whole mess straightened out in the open. I still think Warboy's edit summary is bad, but that's no real issue. My only remaining question is what NKF's super secret source is. Developer notes? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:40, 7 August 2015 (EDT)

:: Close - it certainly does have notes and comments from the TFTD dev team that has so far backed up all the findings from the reverse engineering that has been done up until now. Incidentally, I'll give credit to Zombie for finding it in his epic quest of obtaining all sorts of rare X-Com related materials and paraphernalia. I'm only assessing it.

::Unfortunately, unless we can get permission, we can't really publish it. To be honest, I'm finding it quite frustrating as I'd really like to see this go into the public domain. Both for its informative nature and historic significance. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 03:33, 7 August 2015 (EDT)

: It seems pretty clear that the Hallucinoids were intended to have a ranged weapon: their description specifically mentions they posses a ranged, freezing blast but either the developers overlooked this or never got around to including it, as it would have required modifying one of the turret entries to a stun weapon (or, they wanted to have a ranged stun weapon without the default explosion but didn't have time to change the various areas of code which that would have required.) Heck, the developers never added the code to allow the proper management of Tank/Gauss ammo. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 02:22, 7 August 2015 (EDT)

:yeah, i guess a deep one was a bad example, and i should have used looser wording regarding the AI, like "might not be able to" instead of "wouldn't be capable" since not ALL relevant checks are unit-type related, but if you've seen the AI, you can see where i was coming from on this. in any case, i agree completely with Tycho's summary. as for my edit summary being bad - if you've seen my code commit notes on openxcom, this would seem like an extremely detailed explanation by comparison. i've had to explain this to people so many times, that i got fed up and decided removing the section from the article would benefit everyone, by saving their time and my sanity. and curse you NKF for tantalizing me with these details, if what you're talking about is what i think it is, then you know what it represents to me, and how frustrating it is knowing that i can't have it--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:34, 7 August 2015 (EDT)

Talk:Hallucinoid

2015-08-07T07:43:55Z

Warboy1982: /* Clearing this up */

The comments in [[Overviews of Aliens (TFTD)#Hallucinoid - Terror Unit]] say that this unit just attacks

: ''"with its tentacles which do precicely [sic] nothing, while completely ignoring its built-in Thermal Shok Launcher"''

I did some testing on this and I could not reproduce that result. My results were:

# The Hallucinoid does seem to have a preference to close for short range attacks
# Its melee attack seems to be lethal against unarmoured Aquanauts
# Its long range attack is definitely used (though perhaps melee is preferred if there are targets nearby)
# The long range attack is also lethal against unarmoured Aquanauts
# Neither of these attacks do stun damage - or if they do, they still contain enough lethal damage to be fatal

Does anyone know the basis for these comments in the Overview? If not I propose to remove them.
[[User:Spike|Spike]] 14:13, 15 November 2008 (CST)

: It should be Melee type damage. The freeze bit is just fluff text in the ufopaedia, otherwise your units will just be knocked out rather than killed outright. To confirm if it's got a ranged attack, it's probably worth making a savegame with a hallucinoid present and check the unitref.dat entry to see if it has an associated turret attached to it. Otherwise it's effectively no more than a flying Reaper - a brutal one at that if it manages to catch you, plus it has fairly good protection to round it off. -[[User:NKF|NKF]] 14:36, 15 November 2008 (CST)

Thanks for your help NKF. It definitely has a ranged attack, I saw the 'freeze bolt' or whatever it is travelling six squares to hit and kill my (previously uninjured) Aquanaut. I'm not quite sure if its definitely using the tentacles at melee range, or just firing its ranged weapon at point blank. I don't believe the ranged attack is an area effect (as implied by "Built in Thermal Shok Launcher) but I'll check that by offering it multiple targets at once. [[User:Spike|Spike]] 14:56, 15 November 2008 (CST)

: The ranged attack is definitely not area effect. It uses an icon that looks similar to a plasma bolt from XCOM-EU. It looks like it has autofire capability - either that or it just likes to fire at corpses. I'm not sure if anyone knows where these alien built in weapon definitions are located in TFTD? [[User:Spike|Spike]] 15:32, 15 November 2008 (CST)

I've changed the Overview article to remove the claims about ineffectiveness. It's still possible that this alien is ineffective, IF your Aquanauts armour levels are sufficiently high. I was only testing with unarmoured Aquanauts and the Hallucinoid had no difficulty killing them at long range, at melee range, and pursuing them to attack them and finish them off. [[User:Spike|Spike]] 06:12, 14 December 2008 (CST)

UPDATE - as per Zombie's investigations, the ranged attack only works on land and not underwater. This is probably a programming error and was meant to be the other way round. [[User:Spike|Spike]] 15:49, 25 February 2009 (CST)
: Is it really not working at all or just as effective as the Bio-Drohne melee attack?--[[User:Tauon|Tauon]] 22:52, 25 November 2010 (UTC)

::It's "not working", as in, "it won't attempt to fire it". -  [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]]) 00:03, 26 November 2010 (UTC)

Is it possible to fix the unit that the ranged attack works as intended? That would make alien colony missions much more challenging - especially the first part. And artefact, battleship and dreadnought missions as well - right now the difference to gillman for the later is not too big for the two uso missions. --[[User:Tauon|Tauon]] 23:05, 25 November 2010 (UTC)

==Clearing this up==

Okay, so there's been an edit removing the reference to a land-only attack citing the Hallucinoid's lack of appearance on land in unhacked games.

As far as I know, we've got one set of "investigations" by Zombie saying the Hallucinoid has a ranged attack which doesn't work underwater, and IIRC another set by Morgan525 saying that the Hallucinoid doesn't have a ranged attack at all. This has left me, and presumably others, rather confused.

I do know that the question of whether the Hallucinoid has a land-only weapon is NOT related to whether it ordinarily appears on land (if it has a land-only weapon and never appears on land, then that's a bug, but the weapon still exists), but since I have no clue whether it actually has such a weapon I'm not going to revert the edit at this time. If someone could shed some light on this matter, it would be much appreciated. [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 22:01, 5 August 2015 (EDT)

: Yeah, ‎Warboy1982 is one of the lead dev coders for OpenXCOM/OpenTFTD... so I'd say the only other person more "knowledgeable"/qualified would be to ask one of the original designers/coders/programmers. And considering the in-depth work the OpenXCOM/TFTD dev team does, it's really really really difficult to dispute Warboy's findings. See: [http://openxcom.org/forum/index.php/topic,3578.msg49076.html#msg49076 His relevant post] --[[User:DracoGriffin|DracoGriffin]] ([[User talk:DracoGriffin|talk]]) 23:28, 5 August 2015 (EDT)

In the subroutine that writes each alien unit's data in the UNITREF.DAT file, the section that sets the turret weapon and ammo (starting at 0x457EC0 for the windows version) has no provision for Halluciniods: its starts by writing 0 in bytes 0x6F, 0x71, 0x72, 0x73, 0x74, and 0x76 and 0xFF in byte 0x75. Then it checks to see if the unit type is 9, 10, 12, or 14 and sets bytes 0x75 (turret type) and 0x76 (ammo amount) as appropriate - [[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:38, 5 August 2015 (EDT)

:Which unit type corresponds to Hallucinoids? Also, how do you explain Spike's results; would replacing other terrorists with Hallucinoids using XComUtil fail to remove the turret? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:08, 6 August 2015 (EDT)

:: A lot of my past misconceptions about the aliens in TFTD were due to old releases of XComutil, so I wouldn't rule it out. One other possible cause is a glitch turret caused by a bit of junk data that didn't get cleared properly. Otherwise, I agree that Hallucinoids do not get initialised with an innate weapon.

:: I'm not agreeing based on the extensive reverse engineering work that arrived at these findings. Rather, my source of information is a bit more rudimentary and predates it. I can't provide a citation of the exact text just yet, but it is incredibly reliable. If that sounds dubious - then I don't blame you in the least. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 04:51, 6 August 2015 (EDT)

:Hallucinoids are unit type 13 so there isn't a provision for turret weapons on a Hallucinoid. I don't know the inner workings of XComUtil but I agree with NKF that the confusion probably has something to do with early versions of it. It's impossible for the game to spawn a Hallucinoid on land: If the site depth is 0 (surface) and the subroutine that generates the alien data determines that it should create an entry for a Hallucinoid, it uses a Calcinite instead.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 09:58, 6 August 2015 (EDT)

:::NKF and Tycho's findings are consistent with my own, and if NKF's source on this is what i think it is, then you should really, really listen when he speaks.
:::But to elaborate on what i've managed to interpret, hacking in a hallucinoid on a land mission wouldn't necessarily overwrite any object data for the unit it was replacing. Assuming (for the sake of argument) the hallucinoid replaced a deep one, it may indeed have a ranged weapon residing in its inventory that may even be visible if the unit is mind controlled. However, the AI wouldn't be capable of making use of it, because many of the relevent checks actually compare the unit type as described above. As it is not possible for this unit to spawn on land with an unmodified executable, meaning the unit cannot pass through the default constructor - which, even if it did, doesn't specify a ranged weapon. Coupled with the fact that there is no such concept as a "land only weapon" because all of the relevant checks only test for underwater weapons being used on land. This seems like a highly dubious piece of information.(Sorry for so many edits here but text aligning is hard and i'm bad at hitting the preview button at 5am)--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 17:23, 6 August 2015 (EDT)
:I don't know what NKF is using for his source but I always doubt second-hand information until it can be verified by facts from the actual game code or direct testing with verified unmodified game files. (I am not doubting NKF's reputation.) Most of what Warboy says is correct. However, if someone has hacked the game file or game code to allow a unit to be replaced by a Hallucinoid, then the AI can indeed make use of it: When attacking the Alien AI code doesn't check by unit type to see if a unit can fire a turret. Instead it checks to see if a particular unit has a turret weapon and if that weapon has enough ammo to fire. In the case of the celatid/Deep One, it also checks to see if the target is within range of it weapon.
::I suspect that what is happening is that some modification is replacing a Triscene with a Hallucinoid. It would have to replace another large unit or there would be an obvious glitch because the whole unit would not be displayed. From the description of the range attack that this "hallucinoid" has been reported to use, it can't be replacing a Xarquid because its range attack is different from what is described.
::I did a test where I changed the race type of a port attack so that Triscene could be generated: by changing the craft race type to 4 (mixed Tasolth). After starting the mission and saving, I changed the Triscenes to Hallucinoids (by just changing the first byte of each entry from 12 to 13.) These "Hallucinoids" were indeed able to use their range weapons. In a further test, I made each one mind controlled and was able to use their range attack.
::It would be nice if someone had a saved file where Hallucinoids have appeared on land to see what the stats are for them and weather or not they have most of the Hallucinoid's proper stats or only the unit type has been changed. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 22:59, 6 August 2015 (EDT)

This discussion can probably be concluded. It seems that by group consensus:
* Hallucinoids cannot appear on land.
* Hallucinoids do not receive a turret weapon.
* Any other reported deviations can be attributed to modifications of the game code, game files, or possible data corruption.
::Would everyone agree with this summary? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 00:20, 7 August 2015 (EDT)

:Seems reasonable to me. I just wanted to get the whole mess straightened out in the open. I still think Warboy's edit summary is bad, but that's no real issue. My only remaining question is what NKF's super secret source is. Developer notes? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:40, 7 August 2015 (EDT)

:: Close - it certainly does have notes and comments from the TFTD dev team that has so far backed up all the findings from the reverse engineering that has been done up until now. Incidentally, I'll give credit to Zombie for finding it in his epic quest of obtaining all sorts of rare X-Com related materials and paraphernalia. I'm only assessing it.

::Unfortunately, unless we can get permission, we can't really publish it. To be honest, I'm finding it quite frustrating as I'd really like to see this go into the public domain. Both for its informative nature and historic significance. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 03:33, 7 August 2015 (EDT)

: It seems pretty clear that the Hallucinoids were intended to have a ranged weapon: their description specifically mentions they posses a ranged, freezing blast but either the developers overlooked this or never got around to including it, as it would have required modifying one of the turret entries to a stun weapon (or, they wanted to have a ranged stun weapon without the default explosion but didn't have time to change the various areas of code which that would have required.) Heck, the developers never added the code to allow the proper management of Tank/Gauss ammo. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 02:22, 7 August 2015 (EDT)

:yeah, i guess a deep one was a bad example, and i should have used looser wording regarding the AI, like "might not be able to" instead of "wouldn't be capable" since not ALL relevant checks are unit-type related, but if you've seen the AI, you can see where i was coming from on this. in any case, i agree completely with Tycho's summary. as for my edit summary being bad - if you've seen my code commit notes on openxcom, this would seem like an extremely detailed explanation by comparison. i've had to explain this to people so many times, that i got fed up and decided removing the section from the article would benefit everyone, by saving their time and my sanity. and curse you NKF for tantalizing me with these details, if what you're talking about is what i think it is, then you know how frustrated i am knowing that i can't have it--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:34, 7 August 2015 (EDT)

Talk:Hallucinoid

2015-08-07T07:38:30Z

Warboy1982: /* Clearing this up */

The comments in [[Overviews of Aliens (TFTD)#Hallucinoid - Terror Unit]] say that this unit just attacks

: ''"with its tentacles which do precicely [sic] nothing, while completely ignoring its built-in Thermal Shok Launcher"''

I did some testing on this and I could not reproduce that result. My results were:

# The Hallucinoid does seem to have a preference to close for short range attacks
# Its melee attack seems to be lethal against unarmoured Aquanauts
# Its long range attack is definitely used (though perhaps melee is preferred if there are targets nearby)
# The long range attack is also lethal against unarmoured Aquanauts
# Neither of these attacks do stun damage - or if they do, they still contain enough lethal damage to be fatal

Does anyone know the basis for these comments in the Overview? If not I propose to remove them.
[[User:Spike|Spike]] 14:13, 15 November 2008 (CST)

: It should be Melee type damage. The freeze bit is just fluff text in the ufopaedia, otherwise your units will just be knocked out rather than killed outright. To confirm if it's got a ranged attack, it's probably worth making a savegame with a hallucinoid present and check the unitref.dat entry to see if it has an associated turret attached to it. Otherwise it's effectively no more than a flying Reaper - a brutal one at that if it manages to catch you, plus it has fairly good protection to round it off. -[[User:NKF|NKF]] 14:36, 15 November 2008 (CST)

Thanks for your help NKF. It definitely has a ranged attack, I saw the 'freeze bolt' or whatever it is travelling six squares to hit and kill my (previously uninjured) Aquanaut. I'm not quite sure if its definitely using the tentacles at melee range, or just firing its ranged weapon at point blank. I don't believe the ranged attack is an area effect (as implied by "Built in Thermal Shok Launcher) but I'll check that by offering it multiple targets at once. [[User:Spike|Spike]] 14:56, 15 November 2008 (CST)

: The ranged attack is definitely not area effect. It uses an icon that looks similar to a plasma bolt from XCOM-EU. It looks like it has autofire capability - either that or it just likes to fire at corpses. I'm not sure if anyone knows where these alien built in weapon definitions are located in TFTD? [[User:Spike|Spike]] 15:32, 15 November 2008 (CST)

I've changed the Overview article to remove the claims about ineffectiveness. It's still possible that this alien is ineffective, IF your Aquanauts armour levels are sufficiently high. I was only testing with unarmoured Aquanauts and the Hallucinoid had no difficulty killing them at long range, at melee range, and pursuing them to attack them and finish them off. [[User:Spike|Spike]] 06:12, 14 December 2008 (CST)

UPDATE - as per Zombie's investigations, the ranged attack only works on land and not underwater. This is probably a programming error and was meant to be the other way round. [[User:Spike|Spike]] 15:49, 25 February 2009 (CST)
: Is it really not working at all or just as effective as the Bio-Drohne melee attack?--[[User:Tauon|Tauon]] 22:52, 25 November 2010 (UTC)

::It's "not working", as in, "it won't attempt to fire it". -  [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]]) 00:03, 26 November 2010 (UTC)

Is it possible to fix the unit that the ranged attack works as intended? That would make alien colony missions much more challenging - especially the first part. And artefact, battleship and dreadnought missions as well - right now the difference to gillman for the later is not too big for the two uso missions. --[[User:Tauon|Tauon]] 23:05, 25 November 2010 (UTC)

==Clearing this up==

Okay, so there's been an edit removing the reference to a land-only attack citing the Hallucinoid's lack of appearance on land in unhacked games.

As far as I know, we've got one set of "investigations" by Zombie saying the Hallucinoid has a ranged attack which doesn't work underwater, and IIRC another set by Morgan525 saying that the Hallucinoid doesn't have a ranged attack at all. This has left me, and presumably others, rather confused.

I do know that the question of whether the Hallucinoid has a land-only weapon is NOT related to whether it ordinarily appears on land (if it has a land-only weapon and never appears on land, then that's a bug, but the weapon still exists), but since I have no clue whether it actually has such a weapon I'm not going to revert the edit at this time. If someone could shed some light on this matter, it would be much appreciated. [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 22:01, 5 August 2015 (EDT)

: Yeah, ‎Warboy1982 is one of the lead dev coders for OpenXCOM/OpenTFTD... so I'd say the only other person more "knowledgeable"/qualified would be to ask one of the original designers/coders/programmers. And considering the in-depth work the OpenXCOM/TFTD dev team does, it's really really really difficult to dispute Warboy's findings. See: [http://openxcom.org/forum/index.php/topic,3578.msg49076.html#msg49076 His relevant post] --[[User:DracoGriffin|DracoGriffin]] ([[User talk:DracoGriffin|talk]]) 23:28, 5 August 2015 (EDT)

In the subroutine that writes each alien unit's data in the UNITREF.DAT file, the section that sets the turret weapon and ammo (starting at 0x457EC0 for the windows version) has no provision for Halluciniods: its starts by writing 0 in bytes 0x6F, 0x71, 0x72, 0x73, 0x74, and 0x76 and 0xFF in byte 0x75. Then it checks to see if the unit type is 9, 10, 12, or 14 and sets bytes 0x75 (turret type) and 0x76 (ammo amount) as appropriate - [[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:38, 5 August 2015 (EDT)

:Which unit type corresponds to Hallucinoids? Also, how do you explain Spike's results; would replacing other terrorists with Hallucinoids using XComUtil fail to remove the turret? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:08, 6 August 2015 (EDT)

:: A lot of my past misconceptions about the aliens in TFTD were due to old releases of XComutil, so I wouldn't rule it out. One other possible cause is a glitch turret caused by a bit of junk data that didn't get cleared properly. Otherwise, I agree that Hallucinoids do not get initialised with an innate weapon.

:: I'm not agreeing based on the extensive reverse engineering work that arrived at these findings. Rather, my source of information is a bit more rudimentary and predates it. I can't provide a citation of the exact text just yet, but it is incredibly reliable. If that sounds dubious - then I don't blame you in the least. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 04:51, 6 August 2015 (EDT)

:Hallucinoids are unit type 13 so there isn't a provision for turret weapons on a Hallucinoid. I don't know the inner workings of XComUtil but I agree with NKF that the confusion probably has something to do with early versions of it. It's impossible for the game to spawn a Hallucinoid on land: If the site depth is 0 (surface) and the subroutine that generates the alien data determines that it should create an entry for a Hallucinoid, it uses a Calcinite instead.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 09:58, 6 August 2015 (EDT)

:::NKF and Tycho's findings are consistent with my own, and if NKF's source on this is what i think it is, then you should really, really listen when he speaks.
:::But to elaborate on what i've managed to interpret, hacking in a hallucinoid on a land mission wouldn't necessarily overwrite any object data for the unit it was replacing. Assuming (for the sake of argument) the hallucinoid replaced a deep one, it may indeed have a ranged weapon residing in its inventory that may even be visible if the unit is mind controlled. However, the AI wouldn't be capable of making use of it, because many of the relevent checks actually compare the unit type as described above. As it is not possible for this unit to spawn on land with an unmodified executable, meaning the unit cannot pass through the default constructor - which, even if it did, doesn't specify a ranged weapon. Coupled with the fact that there is no such concept as a "land only weapon" because all of the relevant checks only test for underwater weapons being used on land. This seems like a highly dubious piece of information.(Sorry for so many edits here but text aligning is hard and i'm bad at hitting the preview button at 5am)--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 17:23, 6 August 2015 (EDT)
:I don't know what NKF is using for his source but I always doubt second-hand information until it can be verified by facts from the actual game code or direct testing with verified unmodified game files. (I am not doubting NKF's reputation.) Most of what Warboy says is correct. However, if someone has hacked the game file or game code to allow a unit to be replaced by a Hallucinoid, then the AI can indeed make use of it: When attacking the Alien AI code doesn't check by unit type to see if a unit can fire a turret. Instead it checks to see if a particular unit has a turret weapon and if that weapon has enough ammo to fire. In the case of the celatid/Deep One, it also checks to see if the target is within range of it weapon.
::I suspect that what is happening is that some modification is replacing a Triscene with a Hallucinoid. It would have to replace another large unit or there would be an obvious glitch because the whole unit would not be displayed. From the description of the range attack that this "hallucinoid" has been reported to use, it can't be replacing a Xarquid because its range attack is different from what is described.
::I did a test where I changed the race type of a port attack so that Triscene could be generated: by changing the craft race type to 4 (mixed Tasolth). After starting the mission and saving, I changed the Triscenes to Hallucinoids (by just changing the first byte of each entry from 12 to 13.) These "Hallucinoids" were indeed able to use their range weapons. In a further test, I made each one mind controlled and was able to use their range attack.
::It would be nice if someone had a saved file where Hallucinoids have appeared on land to see what the stats are for them and weather or not they have most of the Hallucinoid's proper stats or only the unit type has been changed. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 22:59, 6 August 2015 (EDT)

This discussion can probably be concluded. It seems that by group consensus:
* Hallucinoids cannot appear on land.
* Hallucinoids do not receive a turret weapon.
* Any other reported deviations can be attributed to modifications of the game code, game files, or possible data corruption.
::Would everyone agree with this summary? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 00:20, 7 August 2015 (EDT)

:Seems reasonable to me. I just wanted to get the whole mess straightened out in the open. I still think Warboy's edit summary is bad, but that's no real issue. My only remaining question is what NKF's super secret source is. Developer notes? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:40, 7 August 2015 (EDT)

:: Close - it certainly does have notes and comments from the TFTD dev team that has so far backed up all the findings from the reverse engineering that has been done up until now. Incidentally, I'll give credit to Zombie for finding it in his epic quest of obtaining all sorts of rare X-Com related materials and paraphernalia. I'm only assessing it.

::Unfortunately, unless we can get permission, we can't really publish it. To be honest, I'm finding it quite frustrating as I'd really like to see this go into the public domain. Both for its informative nature and historic significance. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 03:33, 7 August 2015 (EDT)

: It seems pretty clear that the Hallucinoids were intended to have a ranged weapon: their description specifically mentions they posses a ranged, freezing blast but either the developers overlooked this or never got around to including it, as it would have required modifying one of the turret entries to a stun weapon (or, they wanted to have a ranged stun weapon without the default explosion but didn't have time to change the various areas of code which that would have required.) Heck, the developers never added the code to allow the proper management of Tank/Gauss ammo. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 02:22, 7 August 2015 (EDT)

:yeah, i guess a deep one was a bad example, and i should have used looser wording regarding the AI, like "might not be able to" instead of "wouldn't be capable" since not ALL relevant checks are unit-type related, but if you've seen the AI, you can see where i was coming from on this. in any case, i agree completely with Tycho's summary. as for my edit summary being bad - if you've seen my code commit notes on openxcom, this would seem like an extremely detailed explanation by comparison. i've had to explain this to people so many times, that i got fed up and decided removing the section from the article would benefit everyone, by saving their time and my sanity.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:34, 7 August 2015 (EDT)

Talk:Hallucinoid

2015-08-07T07:34:24Z

Warboy1982: /* Clearing this up */

The comments in [[Overviews of Aliens (TFTD)#Hallucinoid - Terror Unit]] say that this unit just attacks

: ''"with its tentacles which do precicely [sic] nothing, while completely ignoring its built-in Thermal Shok Launcher"''

I did some testing on this and I could not reproduce that result. My results were:

# The Hallucinoid does seem to have a preference to close for short range attacks
# Its melee attack seems to be lethal against unarmoured Aquanauts
# Its long range attack is definitely used (though perhaps melee is preferred if there are targets nearby)
# The long range attack is also lethal against unarmoured Aquanauts
# Neither of these attacks do stun damage - or if they do, they still contain enough lethal damage to be fatal

Does anyone know the basis for these comments in the Overview? If not I propose to remove them.
[[User:Spike|Spike]] 14:13, 15 November 2008 (CST)

: It should be Melee type damage. The freeze bit is just fluff text in the ufopaedia, otherwise your units will just be knocked out rather than killed outright. To confirm if it's got a ranged attack, it's probably worth making a savegame with a hallucinoid present and check the unitref.dat entry to see if it has an associated turret attached to it. Otherwise it's effectively no more than a flying Reaper - a brutal one at that if it manages to catch you, plus it has fairly good protection to round it off. -[[User:NKF|NKF]] 14:36, 15 November 2008 (CST)

Thanks for your help NKF. It definitely has a ranged attack, I saw the 'freeze bolt' or whatever it is travelling six squares to hit and kill my (previously uninjured) Aquanaut. I'm not quite sure if its definitely using the tentacles at melee range, or just firing its ranged weapon at point blank. I don't believe the ranged attack is an area effect (as implied by "Built in Thermal Shok Launcher) but I'll check that by offering it multiple targets at once. [[User:Spike|Spike]] 14:56, 15 November 2008 (CST)

: The ranged attack is definitely not area effect. It uses an icon that looks similar to a plasma bolt from XCOM-EU. It looks like it has autofire capability - either that or it just likes to fire at corpses. I'm not sure if anyone knows where these alien built in weapon definitions are located in TFTD? [[User:Spike|Spike]] 15:32, 15 November 2008 (CST)

I've changed the Overview article to remove the claims about ineffectiveness. It's still possible that this alien is ineffective, IF your Aquanauts armour levels are sufficiently high. I was only testing with unarmoured Aquanauts and the Hallucinoid had no difficulty killing them at long range, at melee range, and pursuing them to attack them and finish them off. [[User:Spike|Spike]] 06:12, 14 December 2008 (CST)

UPDATE - as per Zombie's investigations, the ranged attack only works on land and not underwater. This is probably a programming error and was meant to be the other way round. [[User:Spike|Spike]] 15:49, 25 February 2009 (CST)
: Is it really not working at all or just as effective as the Bio-Drohne melee attack?--[[User:Tauon|Tauon]] 22:52, 25 November 2010 (UTC)

::It's "not working", as in, "it won't attempt to fire it". -  [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]]) 00:03, 26 November 2010 (UTC)

Is it possible to fix the unit that the ranged attack works as intended? That would make alien colony missions much more challenging - especially the first part. And artefact, battleship and dreadnought missions as well - right now the difference to gillman for the later is not too big for the two uso missions. --[[User:Tauon|Tauon]] 23:05, 25 November 2010 (UTC)

==Clearing this up==

Okay, so there's been an edit removing the reference to a land-only attack citing the Hallucinoid's lack of appearance on land in unhacked games.

As far as I know, we've got one set of "investigations" by Zombie saying the Hallucinoid has a ranged attack which doesn't work underwater, and IIRC another set by Morgan525 saying that the Hallucinoid doesn't have a ranged attack at all. This has left me, and presumably others, rather confused.

I do know that the question of whether the Hallucinoid has a land-only weapon is NOT related to whether it ordinarily appears on land (if it has a land-only weapon and never appears on land, then that's a bug, but the weapon still exists), but since I have no clue whether it actually has such a weapon I'm not going to revert the edit at this time. If someone could shed some light on this matter, it would be much appreciated. [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 22:01, 5 August 2015 (EDT)

: Yeah, ‎Warboy1982 is one of the lead dev coders for OpenXCOM/OpenTFTD... so I'd say the only other person more "knowledgeable"/qualified would be to ask one of the original designers/coders/programmers. And considering the in-depth work the OpenXCOM/TFTD dev team does, it's really really really difficult to dispute Warboy's findings. See: [http://openxcom.org/forum/index.php/topic,3578.msg49076.html#msg49076 His relevant post] --[[User:DracoGriffin|DracoGriffin]] ([[User talk:DracoGriffin|talk]]) 23:28, 5 August 2015 (EDT)

In the subroutine that writes each alien unit's data in the UNITREF.DAT file, the section that sets the turret weapon and ammo (starting at 0x457EC0 for the windows version) has no provision for Halluciniods: its starts by writing 0 in bytes 0x6F, 0x71, 0x72, 0x73, 0x74, and 0x76 and 0xFF in byte 0x75. Then it checks to see if the unit type is 9, 10, 12, or 14 and sets bytes 0x75 (turret type) and 0x76 (ammo amount) as appropriate - [[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:38, 5 August 2015 (EDT)

:Which unit type corresponds to Hallucinoids? Also, how do you explain Spike's results; would replacing other terrorists with Hallucinoids using XComUtil fail to remove the turret? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:08, 6 August 2015 (EDT)

:: A lot of my past misconceptions about the aliens in TFTD were due to old releases of XComutil, so I wouldn't rule it out. One other possible cause is a glitch turret caused by a bit of junk data that didn't get cleared properly. Otherwise, I agree that Hallucinoids do not get initialised with an innate weapon.

:: I'm not agreeing based on the extensive reverse engineering work that arrived at these findings. Rather, my source of information is a bit more rudimentary and predates it. I can't provide a citation of the exact text just yet, but it is incredibly reliable. If that sounds dubious - then I don't blame you in the least. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 04:51, 6 August 2015 (EDT)

:Hallucinoids are unit type 13 so there isn't a provision for turret weapons on a Hallucinoid. I don't know the inner workings of XComUtil but I agree with NKF that the confusion probably has something to do with early versions of it. It's impossible for the game to spawn a Hallucinoid on land: If the site depth is 0 (surface) and the subroutine that generates the alien data determines that it should create an entry for a Hallucinoid, it uses a Calcinite instead.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 09:58, 6 August 2015 (EDT)

:::NKF and Tycho's findings are consistent with my own, and if NKF's source on this is what i think it is, then you should really, really listen when he speaks.
:::But to elaborate on what i've managed to interpret, hacking in a hallucinoid on a land mission wouldn't necessarily overwrite any object data for the unit it was replacing. Assuming (for the sake of argument) the hallucinoid replaced a deep one, it may indeed have a ranged weapon residing in its inventory that may even be visible if the unit is mind controlled. However, the AI wouldn't be capable of making use of it, because many of the relevent checks actually compare the unit type as described above. As it is not possible for this unit to spawn on land with an unmodified executable, meaning the unit cannot pass through the default constructor - which, even if it did, doesn't specify a ranged weapon. Coupled with the fact that there is no such concept as a "land only weapon" because all of the relevant checks only test for underwater weapons being used on land. This seems like a highly dubious piece of information.(Sorry for so many edits here but text aligning is hard and i'm bad at hitting the preview button at 5am)--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 17:23, 6 August 2015 (EDT)
:I don't know what NKF is using for his source but I always doubt second-hand information until it can be verified by facts from the actual game code or direct testing with verified unmodified game files. (I am not doubting NKF's reputation.) Most of what Warboy says is correct. However, if someone has hacked the game file or game code to allow a unit to be replaced by a Hallucinoid, then the AI can indeed make use of it: When attacking the Alien AI code doesn't check by unit type to see if a unit can fire a turret. Instead it checks to see if a particular unit has a turret weapon and if that weapon has enough ammo to fire. In the case of the celatid/Deep One, it also checks to see if the target is within range of it weapon.
::I suspect that what is happening is that some modification is replacing a Triscene with a Hallucinoid. It would have to replace another large unit or there would be an obvious glitch because the whole unit would not be displayed. From the description of the range attack that this "hallucinoid" has been reported to use, it can't be replacing a Xarquid because its range attack is different from what is described.
::I did a test where I changed the race type of a port attack so that Triscene could be generated: by changing the craft race type to 4 (mixed Tasolth). After starting the mission and saving, I changed the Triscenes to Hallucinoids (by just changing the first byte of each entry from 12 to 13.) These "Hallucinoids" were indeed able to use their range weapons. In a further test, I made each one mind controlled and was able to use their range attack.
::It would be nice if someone had a saved file where Hallucinoids have appeared on land to see what the stats are for them and weather or not they have most of the Hallucinoid's proper stats or only the unit type has been changed. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 22:59, 6 August 2015 (EDT)

This discussion can probably be concluded. It seems that by group consensus:
* Hallucinoids cannot appear on land.
* Hallucinoids do not receive a turret weapon.
* Any other reported deviations can be attributed to modifications of the game code, game files, or possible data corruption.
::Would everyone agree with this summary? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 00:20, 7 August 2015 (EDT)

:Seems reasonable to me. I just wanted to get the whole mess straightened out in the open. I still think Warboy's edit summary is bad, but that's no real issue. My only remaining question is what NKF's super secret source is. Developer notes? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:40, 7 August 2015 (EDT)

:: Close - it certainly does have notes and comments from the TFTD dev team that has so far backed up all the findings from the reverse engineering that has been done up until now. Incidentally, I'll give credit to Zombie for finding it in his epic quest of obtaining all sorts of rare X-Com related materials and paraphernalia. I'm only assessing it.

::Unfortunately, unless we can get permission, we can't really publish it. To be honest, I'm finding it quite frustrating as I'd really like to see this go into the public domain. Both for its informative nature and historic significance. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 03:33, 7 August 2015 (EDT)

: It seems pretty clear that the Hallucinoids were intended to have a ranged weapon: their description specifically mentions they posses a ranged, freezing blast but either the developers overlooked this or never got around to including it, as it would have required modifying one of the turret entries to a stun weapon (or, they wanted to have a ranged stun weapon without the default explosion but didn't have time to change the various areas of code which that would have required.) Heck, the developers never added the code to allow the proper management of Tank/Gauss ammo. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 02:22, 7 August 2015 (EDT)

:yeah, i guess a deep one was a bad example, and i should have used looser wording regarding the AI, like "might not be able to" instead of "wouldn't be capable" since not ALL relevant checks are unit-type related, but if you've seen the AI, you can see where i was coming from on this. in any case, i agree completely with Tycho's summary. as for my edit summary being bad - if you've seen my code commit notes on openxcom, this would seem like an extremely detailed explanation by comparison. i've had to explain this to people so many times, that i got fed up and decided removing the section from the article would benefit everyone, by saving everyone's time and my sanity.--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 03:34, 7 August 2015 (EDT)

Talk:Hallucinoid

2015-08-07T07:32:49Z

Warboy1982: /* Clearing this up */

The comments in [[Overviews of Aliens (TFTD)#Hallucinoid - Terror Unit]] say that this unit just attacks

: ''"with its tentacles which do precicely [sic] nothing, while completely ignoring its built-in Thermal Shok Launcher"''

I did some testing on this and I could not reproduce that result. My results were:

# The Hallucinoid does seem to have a preference to close for short range attacks
# Its melee attack seems to be lethal against unarmoured Aquanauts
# Its long range attack is definitely used (though perhaps melee is preferred if there are targets nearby)
# The long range attack is also lethal against unarmoured Aquanauts
# Neither of these attacks do stun damage - or if they do, they still contain enough lethal damage to be fatal

Does anyone know the basis for these comments in the Overview? If not I propose to remove them.
[[User:Spike|Spike]] 14:13, 15 November 2008 (CST)

: It should be Melee type damage. The freeze bit is just fluff text in the ufopaedia, otherwise your units will just be knocked out rather than killed outright. To confirm if it's got a ranged attack, it's probably worth making a savegame with a hallucinoid present and check the unitref.dat entry to see if it has an associated turret attached to it. Otherwise it's effectively no more than a flying Reaper - a brutal one at that if it manages to catch you, plus it has fairly good protection to round it off. -[[User:NKF|NKF]] 14:36, 15 November 2008 (CST)

Thanks for your help NKF. It definitely has a ranged attack, I saw the 'freeze bolt' or whatever it is travelling six squares to hit and kill my (previously uninjured) Aquanaut. I'm not quite sure if its definitely using the tentacles at melee range, or just firing its ranged weapon at point blank. I don't believe the ranged attack is an area effect (as implied by "Built in Thermal Shok Launcher) but I'll check that by offering it multiple targets at once. [[User:Spike|Spike]] 14:56, 15 November 2008 (CST)

: The ranged attack is definitely not area effect. It uses an icon that looks similar to a plasma bolt from XCOM-EU. It looks like it has autofire capability - either that or it just likes to fire at corpses. I'm not sure if anyone knows where these alien built in weapon definitions are located in TFTD? [[User:Spike|Spike]] 15:32, 15 November 2008 (CST)

I've changed the Overview article to remove the claims about ineffectiveness. It's still possible that this alien is ineffective, IF your Aquanauts armour levels are sufficiently high. I was only testing with unarmoured Aquanauts and the Hallucinoid had no difficulty killing them at long range, at melee range, and pursuing them to attack them and finish them off. [[User:Spike|Spike]] 06:12, 14 December 2008 (CST)

UPDATE - as per Zombie's investigations, the ranged attack only works on land and not underwater. This is probably a programming error and was meant to be the other way round. [[User:Spike|Spike]] 15:49, 25 February 2009 (CST)
: Is it really not working at all or just as effective as the Bio-Drohne melee attack?--[[User:Tauon|Tauon]] 22:52, 25 November 2010 (UTC)

::It's "not working", as in, "it won't attempt to fire it". -  [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]]) 00:03, 26 November 2010 (UTC)

Is it possible to fix the unit that the ranged attack works as intended? That would make alien colony missions much more challenging - especially the first part. And artefact, battleship and dreadnought missions as well - right now the difference to gillman for the later is not too big for the two uso missions. --[[User:Tauon|Tauon]] 23:05, 25 November 2010 (UTC)

==Clearing this up==

Okay, so there's been an edit removing the reference to a land-only attack citing the Hallucinoid's lack of appearance on land in unhacked games.

As far as I know, we've got one set of "investigations" by Zombie saying the Hallucinoid has a ranged attack which doesn't work underwater, and IIRC another set by Morgan525 saying that the Hallucinoid doesn't have a ranged attack at all. This has left me, and presumably others, rather confused.

I do know that the question of whether the Hallucinoid has a land-only weapon is NOT related to whether it ordinarily appears on land (if it has a land-only weapon and never appears on land, then that's a bug, but the weapon still exists), but since I have no clue whether it actually has such a weapon I'm not going to revert the edit at this time. If someone could shed some light on this matter, it would be much appreciated. [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 22:01, 5 August 2015 (EDT)

: Yeah, ‎Warboy1982 is one of the lead dev coders for OpenXCOM/OpenTFTD... so I'd say the only other person more "knowledgeable"/qualified would be to ask one of the original designers/coders/programmers. And considering the in-depth work the OpenXCOM/TFTD dev team does, it's really really really difficult to dispute Warboy's findings. See: [http://openxcom.org/forum/index.php/topic,3578.msg49076.html#msg49076 His relevant post] --[[User:DracoGriffin|DracoGriffin]] ([[User talk:DracoGriffin|talk]]) 23:28, 5 August 2015 (EDT)

In the subroutine that writes each alien unit's data in the UNITREF.DAT file, the section that sets the turret weapon and ammo (starting at 0x457EC0 for the windows version) has no provision for Halluciniods: its starts by writing 0 in bytes 0x6F, 0x71, 0x72, 0x73, 0x74, and 0x76 and 0xFF in byte 0x75. Then it checks to see if the unit type is 9, 10, 12, or 14 and sets bytes 0x75 (turret type) and 0x76 (ammo amount) as appropriate - [[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:38, 5 August 2015 (EDT)

:Which unit type corresponds to Hallucinoids? Also, how do you explain Spike's results; would replacing other terrorists with Hallucinoids using XComUtil fail to remove the turret? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:08, 6 August 2015 (EDT)

:: A lot of my past misconceptions about the aliens in TFTD were due to old releases of XComutil, so I wouldn't rule it out. One other possible cause is a glitch turret caused by a bit of junk data that didn't get cleared properly. Otherwise, I agree that Hallucinoids do not get initialised with an innate weapon.

:: I'm not agreeing based on the extensive reverse engineering work that arrived at these findings. Rather, my source of information is a bit more rudimentary and predates it. I can't provide a citation of the exact text just yet, but it is incredibly reliable. If that sounds dubious - then I don't blame you in the least. [[User:NKF|NKF]] ([[User talk:NKF|talk]]) 04:51, 6 August 2015 (EDT)

:Hallucinoids are unit type 13 so there isn't a provision for turret weapons on a Hallucinoid. I don't know the inner workings of XComUtil but I agree with NKF that the confusion probably has something to do with early versions of it. It's impossible for the game to spawn a Hallucinoid on land: If the site depth is 0 (surface) and the subroutine that generates the alien data determines that it should create an entry for a Hallucinoid, it uses a Calcinite instead.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 09:58, 6 August 2015 (EDT)

:::NKF and Tycho's findings are consistent with my own, and if NKF's source on this is what i think it is, then you should really, really listen when he speaks.
:::But to elaborate on what i've managed to interpret, hacking in a hallucinoid on a land mission wouldn't necessarily overwrite any object data for the unit it was replacing. Assuming (for the sake of argument) the hallucinoid replaced a deep one, it may indeed have a ranged weapon residing in its inventory that may even be visible if the unit is mind controlled. However, the AI wouldn't be capable of making use of it, because many of the relevent checks actually compare the unit type as described above. As it is not possible for this unit to spawn on land with an unmodified executable, meaning the unit cannot pass through the default constructor - which, even if it did, doesn't specify a ranged weapon. Coupled with the fact that there is no such concept as a "land only weapon" because all of the relevant checks only test for underwater weapons being used on land. This seems like a highly dubious piece of information.(Sorry for so many edits here but text aligning is hard and i'm bad at hitting the preview button at 5am)--[[User:Warboy1982|Warboy1982]] ([[User talk:Warboy1982|talk]]) 17:23, 6 August 2015 (EDT)
:I don't know what NKF is using for his source but I always doubt second-hand information until it can be verified by facts from the actual game code or direct testing with verified unmodified game files. (I am not doubting NKF's reputation.) Most of what Warboy says is correct. However, if someone has hacked the game file or game code to allow a unit to be replaced by a Hallucinoid, then the AI can indeed make use of it: When attacking the Alien AI code doesn't check by unit type to see if a unit can fire a turret. Instead it checks to see if a particular unit has a turret weapon and if that weapon has enough ammo to fire. In the case of the celatid/Deep One, it also checks to see if the target is within range of it weapon.
::I suspect that what is happening is that some modification is replacing a Triscene with a Hallucinoid. It would have to replace another large unit or there would be an obvious glitch because the whole unit would not be displayed. From the description of the range attack that this "hallucinoid" has been reported to use, it can't be replacing a Xarquid because its range attack is different from what is described.
::I did a test where I changed the race type of a port attack so that Triscene could be generated: by changing the craft race type to 4 (mixed Tasolth). After starting the mission and saving, I changed the Triscenes to Hallucinoids (by just changing the first byte of each entry from 12 to 13.) These "Hallucinoids" were indeed able to use their range weapons. In a further test, I made each one mind controlled and was able to use their range attack.
::It would be nice if someone had a saved file where Hallucinoids have appeared on land to see what the stats are for them and weather or not they have most of the Hallucinoid's proper stats or only the unit type has been changed. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 22:59, 6 August 2015 (EDT)

This discussion can probably be concluded. It seems that by group consensus:
* Hallucinoids cannot appear on land.
* Hallucinoids do not receive a turret weapon.
* Any other reported deviations can be attributed to modifications of the game code, game files, or possible data corruption.
::Would everyone agree with this summary? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 00:20, 7 August 2015 (EDT)

:Seems reasonable to me. I just wanted to get the whole mess straightened out in the open. I still think Warboy's edit summary is bad, but that's no real issue. My only remaining question is what NKF's super secret source is. Developer notes? [[User:Magic9mushroom|Magic9mushroom]] ([[User talk:Magic9mushroom|talk]]) 01:40, 7 August 2015 (EDT)

: It seems pretty clear that the Hallucinoids were intended to have a ranged weapon: their description specifically mentions they posses a ranged, freezing blast but either the developers overlooked this or never got around to including it, as it would have required modifying one of the turret entries to a stun weapon (or, they wanted to have a ranged stun weapon without the default explosion but didn't have time to change the various areas of code which that would have required.) Heck, the developers never added the code to allow the proper management of Tank/Gauss ammo. -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 02:22, 7 August 2015 (EDT)

:yeah, i guess a deep one was a bad example, and i should have used looser wording regarding the AI, like "might not be able to" instead of "wouldn't be capable" since not ALL relevant checks are unit-type related, but if you've seen the AI, you can see where i was coming from on this. in any case, i agree completely with Tycho's summary. as for my edit summary being bad - if you've seen my code commit notes on openxcom, this would seem like an extremely detailed explanation by comparison. i've had to explain this to people so many times, that i got fed up and decided removing the section from the article would save everyone's time, and my sanity.

User talk:Warboy1982

2015-08-07T07:09:09Z

Warboy1982:

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

Warboy,

Does OpenXcom use the same coordinate system for the globe as the original game or did you all remap it in order to make navigation plotting easier? -[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]]) 23:20, 6 August 2015 (EDT)

we converted them in most cases from xcom units into either degrees or radians, i can't remember which off the top of my head, but the in-game coordinate values are actually the same as the ones used on google maps.

Talk:Hallucinoid

2015-08-06T21:43:11Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:41:55Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:36:38Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:35:13Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:30:00Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:28:38Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:23:15Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T21:20:23Z

Warboy1982: /* Clearing this up */

Talk:Hallucinoid

2015-08-06T20:47:38Z

Warboy1982: /* Clearing this up */

Hallucinoid

2015-08-06T01:35:57Z

Warboy1982: this is misinformation. there is no such concept as a "land only" weapon in TFTD. The unit has to be hacked into a save on dry land to even appear. there is _no_ evidence to support this claim.

== General Information ==

{{Ref Open|title = Hallucinoid}}
[[Image:Hallucinoid.png|right|Hallucinoid]]Having harvested the oceans the aliens have bred these huge Earth creatures as a weapon. Do not be lulled into a false sense of security when facing these harmless looking sailors of the deeps. Possessed of a formidable, ranged, freezing blast and a close combat icy strike, the Hallucinoid is a deadly foe. 
{{Ref Close | source = Terror From The Deep Ufopaedia}}

{{Ref Open|title = Hallucinoid Autopsy}}
[[Image:HallucinoidAutopsy.png|right|Hallucinoid Autopsy]]Nested in the many layers of the gelatinous body of this organism is a powerful chemical freezer, its main offensive capability. The soft and supple skin of the Hallucinoid seems susceptible to heat based attacks. Often this mutant is found in the company of its masters, the Aquatoids. 
{{Ref Close | source = Terror From The Deep Ufopaedia}}

{{Infobox open}}
{{Statbox module
| name = Hallucinoid
| time_units = 62 - 91
| health = 120
| energy = 90 - 133
| reactions = 90 - 122
| strength = 90 - 111
| bravery = 100
| firing_acc = 32 - 129
| throwing_acc = 80
| MC_skill = 0
| MC_strength = 90 - 111
| armour_front = 14 - 42
| armour_left = 14 - 42
| armour_right = 14 - 42
| armour_back = 14 - 42
| armour_under = 10 - 30
}}
{{Statbox module/hidden stats
| melee_acc = 90 - 133
| energy_recharge = 50
| victory_points = 35
| standing_height = ?
| kneeling_height = ?
| intelligence = 7
| aggression = 2
}}
{{Statbox module/unique stats
| armour_category = Hallucinoid
| rank_types = Terrorist
| unique_attributes = Melee Attack, Can "Fly"
}}
{{Infobox close}}

The Hallucinoid is a large, "flying" alien jellyfish usually found in the company of Aquatoids underwater. It is fairly resilient, but is limited to melee attacks. It is not particularly aggressive and thus is not particularly dangerous. Still, its melee attack is quite effective against unarmoured or lightly armoured Aquanauts.

==Tactics==
Another fairly simple and straightforward opponent. The Hallucinoid is among the least dangerous aliens mostly due to its poor tactics and lack of ranged weapons.

By far the best way to bring one down is by using explosives. Sonic weapons are preferred otherwise, though strong melee weapons or the [[Thermal Shok Launcher]] will also work. Gauss weapons will have trouble piercing the Hallucinoids' armour on higher difficulties, while Armour Piercing projectiles are of little use against them. That will likely be of no concern, however, since you're unlikely to meet Hallucinoids in the first few months of the game.

==Notes==
The following are some miscellaneous notes on the Hallucinoid:
* The Hallucinoid takes 0.6x damage from melee and armour piercing attacks, 0.7x damage from explosives, 0.8x from Gauss, but 1.7x damage from incendiary attacks.
* It appears exclusively underwater.
* Takes up 4 squares on the battlescape.

==See Also==
* [[Alien Life Forms (TFTD)|Alien Life Forms]]
* [[Overviews_of_Aliens_(TFTD)|Overviews of Aliens]]
* [[Terror_Units_(TFTD)|Terror Units]]
* [[Calcinite]]
* [[Aquatoid]]
 
{{Aliens (TFTD)}}

[[Category:Alien Life Forms (TFTD)]]
[[Category:TFTD]]

Ruleset Reference Nightly (OpenXcom)

2015-07-31T13:05:23Z

Warboy1982: /* AI Units (Aliens/Civilians) */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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''
|-
| '''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, representing x/y/height/width.
| full map [0,0,mapSize_X,mapSize_Y]
|-
| '''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 ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

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

{| 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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| -
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| -
|-
|}

=== 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''durationMin'''
'''durationMax'''
| Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

=== 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).
| -
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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]

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2015-07-31T13:05:04Z

Warboy1982: /* AI Units (Aliens/Civilians) */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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''
|-
| '''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, representing x/y/height/width.
| full map [0,0,mapSize_X,mapSize_Y]
|-
| '''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 ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

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

{| 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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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
| 30
|-
| '''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
|-
| '''meleeWeapon'''
| If this unit has a built in weapon, what is it? this weapon does not go in an inventory slot. (must reference an item)
| none
|-
| '''builtInWeapons'''
| A list of weapons this unit comes pre-equipped with. these WILL appear in inventory slots (references items)
| 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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''durationMin'''
'''durationMax'''
| Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

=== 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).
| -
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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]

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]

Ruleset Reference Nightly (OpenXcom)

2015-07-31T11:59:25Z

Warboy1982: /* AI Units (Aliens/Civilians) */

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 file paths are case insensitive, but IDs (such as string IDs, music names, or cutscene names) are case sensitive. In general, though, if it works on one operating system, it will work on all operating systems.

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.
| -
|-
| '''textures'''
| List of terrains that correspond to each [[TEXTURE.DAT|Geoscape texture]]. Terrains can be restricted to certain areas on the globe with '''area: (''[lon1, lat1, lon2, lat2]'')''' and '''weight: NUMBER''' gives their chance of appearance.
| -
|}

=== 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.
| -
|-
| '''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.
Mission zone 3 defines cities belonging to a region (''[lon1, lat1, lon2, lat2, -1, STR_CITY_NAME]''). They will be displayed on the globe and used for terror site missions. Cities can also have a '''zoom''' setting which determines the appearance of its name label according to the specified zoom level.
| -
|-
| '''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''
|-
| '''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, representing x/y/height/width.
| full map [0,0,mapSize_X,mapSize_Y]
|-
| '''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 ====
* There are 3 main 'types' of map generation in UFO/TFTD:
** Random, where any map block (including XCom craft and/or UFOs/USOs) can be placed anywhere in the [[Battlescape]];
** Procedurally generated, where placement of certain maps is defined by rules (i.e. the roads on the Urban terrain used in terror sites in Enemy Unknown/UFO Defense);
** Static, where only 1 or more maps are used (i.e. Cargo and Liner Ships in TFTD).
* Map scripting in OpenXcom allows also for a mixture of 2 or even all the 3 described above, where some parts of the map will be static, others will be filled according to certain rules and the remainer filled randomly.
* Every script requires at least 1 map block used for spawning XCom units. Usually that role is taken by XCom craft, except on the XCom Base, Alien Base and the 2nd part of the Cydonia mission. If the script can't place this map then OpenXcom will display a message saying that it couldn't place XCom units on the map.
* Every space on the Battlescape needs to be filled, so the script should have enough mapblocks available for use. In the case of the vanilla terrains, the maxUses settings were designed mostly for 50x50 dimensions so any increases to those dimensions will require adjusting the maxUses settings. Otherwise the game will crash and display an error message that it couldn't generate the map.
* The "addLine" command relies on groups 2, 3 and 4 as its vertical road, horizontal road and crossroad pieces.
* The "addCraft" and "addUFO" commands will place blocks from group 1 as well, by default, if any are defined.

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

{| 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
|-
| '''soldierNames'''
| List of soldier name files/paths. Use '''delete''' to clear previously-loaded names.
| -
|}

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

{| 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
| 30
|-
| '''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.
| ""
|-
| '''finalDestination'''
| Sets whether this mission is where you send your [[Avenger|uber-craft]] to win the game.
| "false"
|-
| '''winCutscene'''
| Sets the cutscene to play when you win the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''loseCutscene'''
| Sets the cutscene to play when you lose the mission. If set to "winGame" or "loseGame", the player will be returned to the main menu after the cutscene plays.
| -
|-
| '''alert'''
| String ID to use when this mission spawns on the Geoscape.
| -
|-
| '''markerName'''
| String ID that identifies this mission on the Geoscape.
| -
|-
| '''durationMin'''
'''durationMax'''
| Minimum and maximum duration of this mission on the Geoscape (in hours).
| -
|-
| '''script'''
| Reference to a mapScript.
| -
|-
| '''data'''
| List of deployment data for each alien rank on this mission (see below).
| -
|-
| '''briefing'''
| Information about the mission briefing (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''
|-
|}

==== Briefing Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''title'''
| String ID for a custom briefing title text. Defaults to the same name as the ''alienDeployment''.
| -
|-
| '''desc'''
| String ID for a custom briefing description text. Defaults to the same name as the ''alienDeployment + _BRIEFING''.
| -
|-
| '''palette'''
| The color swatch to use from [[BACKPALS.DAT]].
| 0
|-
| '''textOffset'''
| Number of pixels to vertically offset the briefing text. Larger values move the text further down the screen.
| 0
|-
| '''music'''
| The ID of the music to play.
| "GMDEFEND"
|-
| '''background'''
| The background screen to show.
| "BACK16.SCR"
|-
| '''showCraft'''
| Whether to show the name of craft that arrived at the mission site.
| true
|-
| '''showTarget'''
| Whether to display the mission target name.
| true
|-
| '''cutscene'''
| Sets the cutscene to play before the mission briefing.
| -
|-
|}

=== 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).
| -
|-
| '''cutscene'''
| The name of the cutscene to play when this project is completed. If the cutscene is "wingame" or "losegame", the player is returned to the main menu after the cutscene plays.
| -
|}

=== 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)|Equipment]]
* 15 = TFTD Armour
* 16 = TFTD [[Base Facilities (TFTD)|Base Facilities]]
* 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]

==Font==

Defines the [[Font collection (OpenXcom)|font collection]] used by default.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''fontName'''
| Name of *.dat file, placed in Language folder, which describes used [[Font collection (OpenXcom)|font collection]].
| Font.dat
|}

== Cutscenes ==

Defines a video playlist or a slideshow sequence, listed in ''"cutscenes:"''.

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''type'''
| String ID of the cutscene.
| ''required''
|-
| '''useUfoAudioSequence'''
| Whether to use the audio sequence for the original UFO intro movie. This should only ever be set to true for the UFO intro.
| "false"
|-
| '''videos'''
| A list of video filenames to play with the FLC player.
| ''required if this is cutscene is a video playlist''
|-
| '''slideshow'''
| Info for playing a slideshow (see below).
| ''required if this is cutscene is a slideshow''
|}

==== Slideshow Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''transitionSeconds'''
| The number of seconds to wait before automatically transitioning to the next slide. The user can always force a transition faster by clicking.
| 30
|-
| '''musicId'''
| The id of the music to play.
| -
|-
| '''slides'''
| List of slide data elements (see below).
| ''required''
|}

==== Slide Data ====

{| class="wikitable" width="100%"
! width="150"| Value
! width="*" | Description
! width="80" | Default
|-
| '''imagePath'''
| The path to the image file to display in the background. The palette for the slide is taken from the image, so caption text color will be determined by the image palette.
| ''required''
|-
| '''caption'''
| The string ID of the caption text.
| -
|-
| '''captionSize'''
| The size of the text box, in pixels, in which to display the caption.
| [320, 200]
|-
| '''captionPos'''
| The screen position at which to display the caption.
| [0, 0]
|-
| '''captionColor'''
| The palette index to use for the caption color.
| ''required''
|}

==References==

<references />

[[Category:OpenXcom]]