UFOpaedia - User contributions [en]

MCDEdit

2016-08-27T17:48:30Z

Volutar: /* Download 1.17j */

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

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

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

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

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

At the top of the main area is the MCD preview/selection line with the bar. Yellow highlighted MCDs are animated. Red dot indicates it's a referenced MCD (by some other MCDs, which will be shown at the right part of Status Bar).
You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD. You can select multiple MCDs with ''Shift'' and ''Ctrl'', it will aggregate MCD data, and it's possible to change multiple values through selected (different values are displayed as "mix"). '''RMB''' calls the context menu for the clicked MCD (''Copy MCDs / Paste MCDs / Insert MCD / Add MCD / Delete MCDs / Clear MCDs'') - same as in the '''Edit''' menu. If you are not allowed to change the number of MCDs (ie: in vanilla mode) these menu entries will be greyed out.

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).

When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values. Also you can change number of sprites per row when exporting images.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Autoconfirm" checkbox (saving changes of sprites without confirm window). Lower are set of color/group modification buttons. They change colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself. Lower are rotating/flipping buttons.

Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17j (2016-08-27) ([http://volutar.eu5.org/_mcdedit117j.7z download])

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

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

Talk:MCDEdit

2016-08-27T17:47:32Z

Volutar: /* 2016-08-26 v1.17j */

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
** Added multiple PCKs adding to menu (1,5 and 15)

====2015-04-06 v1.17g====
* PCK Edit:
** Fixed RGBA png import.
** Fixed insert new PCK.
** Added "Settings" menu with PCK sheet margin/spacing options and number of sprites per row for export.

====2015-06-21 v1.17h====
* MCD Edit:
* Adding/Deleting MCDs will change particular fields accordingly (Alt_MCD/Die_MCD fields), including consideration if it's a "door" field or not. Special characters are needed at the tail of particular field names to work properly.
* Informative warning message if you're trying to delete MCDs which are used in other MCDs (as Alt_MCD/Die_MCD).
* PCK Edit:
** PasteMode is not going to be turned off in Draw mode until you start drawing.
** Hover color info and highlight cross now works correcty with overlay/underlay "pasted" fragment.
** Added tools to rotate (CW/CCW) + Flip (Horizontal/vertical) of selection or "pasted" fragment.
** Additional small fixes.

====2015-06-23 v1.17i====
* MCD Edit:
* Alt_MCD/Die_MCD readjustment rules are changed - now it affects Alt_MCD only if it's a door, and Die_MCD only if it's not 0.
* Same rules are applied when "Append MCDs" happens (through File menu).
* Doesn't allow adding MCDs more than 256 (either through Add or Append or Insert).
* Fixed graying add/del/ins options for "vanilla" MCDsets (as it meant to be eariler) - now you can't accidentally change number of vanilla tiles.
* Showing in which MCDs selected one is used (as Alt/Die) at the right part of the Status Bar.
* Showing red dots at the "Used" MCDs (the ones which are better not to delete).
* Fixed wrong "using: MCDs" in warnings when deleting them.
* If Used MCDs are still deleted, the Using MCDs are getting wrong value replaced with even more wrong "255" (to make it easier to catch).

====2016-08-27 v1.17j====
* PCK Edit:
** Added new command line option "-pckonly" which runs program in single-window PCK edit mode, without need of MCD files.
** Separate configuration/layout file pckedit.lyt for standalone PCK mode (without interfering with mcdedit+pckedit settings).
** ''View->Height 48'' option toggles full PCK height, useful for bigobs.
** Import and export of png sheets are now depend on ''Height 48'' mode (either 40 or 48 pixels height).

===Wishes===

UNITREF.DAT

2015-06-24T08:38:25Z

Volutar: /*clarification */ 0x77 +0x80/0x82

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words with "1" alien unit is spawned at exact random node marked as "civilian/scout" ignoring actual rank of unit. As result - Commander can occasionally be spawned outside of the UFO craft (and ramble around UFO), not in the "contol room", which has exclusive commander spawn node.
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Unused by game code and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|[Garbage unused by game] Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120-123
!0x78-0x7B
|Unit bit flags (32bit), mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Unit moving.
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!124-125
!0x7C-0x7D
|TFTD ONLY - Bubble animation count for soldiers. Can be 0 to 16 (0x0F).
|- valign="top"
!126-127
!0x7E-0x7F
|TFTD ONLY - Bubble animation delay, skips this amount of frames.
|- valign="top"
!128-129
!0x80-0x81
|TFTD ONLY - Bubble animation enable. (0=disable, 1=enable) - [unused by game - taken from "underwater" flag]
|- valign="top"
!130-131
!0x82-0x83
|TFTD ONLY - Called "floorabove" flag. Is there a floor above unit? (0=no, 1=yes) [unused by game - calculated on-fly]
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 119 values.
Unknown values (5 in total):
[[#75|[075 / 0x4B]]] - Always 0?
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

UNITREF.DAT

2015-06-24T08:30:09Z

Volutar: Undo revision 66004 by Volutar (talk)

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words with "1" alien unit is spawned at exact random node marked as "civilian/scout" ignoring actual rank of unit. As result - Commander can occasionally be spawned outside of the UFO craft (and ramble around UFO), not in the "contol room", which has exclusive commander spawn node.
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Unused by game code and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120-123
!0x78-0x7B
|Unit bit flags (32bit), mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Unit moving.
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!124-125
!0x7C-0x7D
|TFTD ONLY - Bubble animation count for soldiers. Can be 0 to 16 (0x0F).
|- valign="top"
!126-127
!0x7E-0x7F
|TFTD ONLY - Bubble animation delay, skips this amount of frames.
|- valign="top"
!128-129
!0x80-0x81
|TFTD ONLY - Bubble animation enable. (0=disable, 1=enable)
|- valign="top"
!130-131
!0x82-0x83
|TFTD ONLY - Called "floorabove" flag. Is there a floor above unit? (0=no, 1=yes)
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 119 values.
Unknown values (5 in total):
[[#75|[075 / 0x4B]]] - Always 0?
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

UNITREF.DAT

2015-06-24T08:27:16Z

Volutar: /*0x78-0x7b*/ mobility is 32bit

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words with "1" alien unit is spawned at exact random node marked as "civilian/scout" ignoring actual rank of unit. As result - Commander can occasionally be spawned outside of the UFO craft (and ramble around UFO), not in the "contol room", which has exclusive commander spawn node.
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Unused by game code and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120-123
!0x78-0x7B
|Unit bit flags (32bit value), mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Unit moving.
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!124-125
!0x7C-0x7D
|TFTD ONLY - Bubble animation count for soldiers. Can be 0 to 16 (0x0F).
|- valign="top"
!126-127
!0x7E-0x7F
|TFTD ONLY - Bubble animation delay, skips this amount of frames.
|- valign="top"
!128-129
!0x80-0x81
|TFTD ONLY - Bubble animation enable. (0=disable, 1=enable)
|- valign="top"
!130-131
!0x82-0x83
|TFTD ONLY - Called "floorabove" flag. Is there a floor above unit? (0=no, 1=yes)
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 111 values.
Unknown values (13 in total):
[[#34|[034 / 0x22]]] - Always 0?
[[#36|[036 / 0x24]]] - Always 0?
[[#43|[043 / 0x2B]]] - Set to 1 on occasion, usually 0.
[[#52|[052 / 0x34]]] - Seems to be a mirror of 48 / 0x30, the LOFTemp index for the unit.
[[#71|[071 / 0x47]]] - Appears to relate to lighting caused by the unit, [[Talk:UNITREF.DAT#Offset_0x47|discussion here]].
[[#74|[074 / 0x4A]]] - Appears to relate to the AI-mode used by the unit, [[Talk:UNITREF.DAT#Offset_0x4A_.2874.29|discussion here]].
[[#75|[075 / 0x4B]]] - Always 0?
[[#112|[112 / 0x70]]] - Set to 1 for some aliens, 0 otherwise.
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#120|[120 / 0x78]]] - Unit bit flags, mainly re: mobility. Only one bit not 100% identified.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

Know 1 TFTD value.
Unknown TFTD values (7 in total):
[[#125|[125]]] [[#126|[126]]] [[#127|[127]]] [[#128|[128]]] [[#129|[129]]] [[#130|[130]]] [[#131|[131]]]

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

UNITREF.DAT

2015-06-24T05:47:13Z

Volutar: /* fix back*/

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words with "1" alien unit is spawned at exact random node marked as "civilian/scout" ignoring actual rank of unit. As result - Commander can occasionally be spawned outside of the UFO craft (and ramble around UFO), not in the "contol room", which has exclusive commander spawn node.
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Unused by game code and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120
!0x78
|Unit bit flags, mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Dead. ''This was only set for 2 of 3 dead aliens in my current game.''
''[[#13|[13]]] (Health=0) is the most reliable indicator for me.''
''-[[User:MikeTheRed|MikeTheRed]]''
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!121
!0x79
|Possible Values: 0 or 16. All units in unitref.dat get a value of 0 except for the second unit in the list which gets 16. Doesn't matter if the second unit is a soldier, a tank, or an alien. It's always 16. Editing it to 0 doesn't crash the game or have any dire consequences.
|- valign="top"
!122
!0x7A
|Always 0?
|- valign="top"
!123
!0x7B
|Always 0?
|- valign="top"
!124-125
!0x7C-0x7D
|TFTD ONLY - Bubble animation count for soldiers. Can be 0 to 16 (0x0F).
|- valign="top"
!126-127
!0x7E-0x7F
|TFTD ONLY - Bubble animation delay, skips this amount of frames.
|- valign="top"
!128-129
!0x80-ox81
|TFTD ONLY - Bubble animation enable. (0=disable, 1=enable)
|- valign="top"
!130-131
!0x82-0x83
|TFTD ONLY - Called "floorabove" flag. Is there a floor above unit? (0=no, 1=yes)
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 111 values.
Unknown values (13 in total):
[[#34|[034 / 0x22]]] - Always 0?
[[#36|[036 / 0x24]]] - Always 0?
[[#43|[043 / 0x2B]]] - Set to 1 on occasion, usually 0.
[[#52|[052 / 0x34]]] - Seems to be a mirror of 48 / 0x30, the LOFTemp index for the unit.
[[#71|[071 / 0x47]]] - Appears to relate to lighting caused by the unit, [[Talk:UNITREF.DAT#Offset_0x47|discussion here]].
[[#74|[074 / 0x4A]]] - Appears to relate to the AI-mode used by the unit, [[Talk:UNITREF.DAT#Offset_0x4A_.2874.29|discussion here]].
[[#75|[075 / 0x4B]]] - Always 0?
[[#112|[112 / 0x70]]] - Set to 1 for some aliens, 0 otherwise.
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#120|[120 / 0x78]]] - Unit bit flags, mainly re: mobility. Only one bit not 100% identified.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

Know 1 TFTD value.
Unknown TFTD values (7 in total):
[[#125|[125]]] [[#126|[126]]] [[#127|[127]]] [[#128|[128]]] [[#129|[129]]] [[#130|[130]]] [[#131|[131]]]

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

UNITREF.DAT

2015-06-24T05:39:13Z

Volutar: Undo revision 65998 by Volutar (talk)

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words (and if I understand the terminology correctly), a value of 0 means the alien will spawn on (aka inside) the tile it was assigned to, while a value of 1 means the alien will spawn outside of the assigned node on a civ-scout route.
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Probably unused and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120
!0x78
|Unit bit flags, mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Dead. ''This was only set for 2 of 3 dead aliens in my current game.''
''[[#13|[13]]] (Health=0) is the most reliable indicator for me.''
''-[[User:MikeTheRed|MikeTheRed]]''
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!121
!0x79
|Possible Values: 0 or 16. All units in unitref.dat get a value of 0 except for the second unit in the list which gets 16. Doesn't matter if the second unit is a soldier, a tank, or an alien. It's always 16. Editing it to 0 doesn't crash the game or have any dire consequences.
|- valign="top"
!122
!0x7A
|Always 0?
|- valign="top"
!123
!0x7B
|Always 0?
|- valign="top"
!124-125
!0x7C-0x7D
|TFTD ONLY - Bubble animation count for soldiers. Can be 0 to 16 (0x0F).
|- valign="top"
!126-127
!0x7E-0x7F
|TFTD ONLY - Bubble animation delay, skips this amount of frames.
|- valign="top"
!128-129
!0x80-ox81
|TFTD ONLY - Bubble animation enable. (0=disable, 1=enable)
|- valign="top"
!130-131
!0x82-0x83
|TFTD ONLY - Called "floorabove" flag. Is there a floor above unit? (0=no, 1=yes)
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 111 values.
Unknown values (13 in total):
[[#34|[034 / 0x22]]] - Always 0?
[[#36|[036 / 0x24]]] - Always 0?
[[#43|[043 / 0x2B]]] - Set to 1 on occasion, usually 0.
[[#52|[052 / 0x34]]] - Seems to be a mirror of 48 / 0x30, the LOFTemp index for the unit.
[[#71|[071 / 0x47]]] - Appears to relate to lighting caused by the unit, [[Talk:UNITREF.DAT#Offset_0x47|discussion here]].
[[#74|[074 / 0x4A]]] - Appears to relate to the AI-mode used by the unit, [[Talk:UNITREF.DAT#Offset_0x4A_.2874.29|discussion here]].
[[#75|[075 / 0x4B]]] - Always 0?
[[#112|[112 / 0x70]]] - Set to 1 for some aliens, 0 otherwise.
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#120|[120 / 0x78]]] - Unit bit flags, mainly re: mobility. Only one bit not 100% identified.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

Know 1 TFTD value.
Unknown TFTD values (7 in total):
[[#125|[125]]] [[#126|[126]]] [[#127|[127]]] [[#128|[128]]] [[#129|[129]]] [[#130|[130]]] [[#131|[131]]]

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

UNITREF.DAT

2015-06-24T05:31:37Z

Volutar: /* 0x2b clarification*/

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|Called "deployment" with values of 0 or 1 (0=inside, 1=outside). When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first. In other words with "1" alien unit is spawned at exact random node marked as "civilian/scout" ignoring actual rank of unit. As result - Commander can occasionally be spawned outside of the UFO craft (and ramble around UFO), not in the "contol room", which has exclusive commander spawn node.
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Unknown. With that said, the only item remaining on my list is called "lightdirect" or direction of light for a unit (0=all around, 1=direction unit facing). Probably unused and always 0. Maybe it was for a hand-held light source, or a armor-mounted flashlight?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120
!0x78
|Unit bit flags, mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Dead. ''This was only set for 2 of 3 dead aliens in my current game.''
''[[#13|[13]]] (Health=0) is the most reliable indicator for me.''
''-[[User:MikeTheRed|MikeTheRed]]''
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!121
!0x79
|Possible Values: 0 or 16. All units in unitref.dat get a value of 0 except for the second unit in the list which gets 16. Doesn't matter if the second unit is a soldier, a tank, or an alien. It's always 16. Editing it to 0 doesn't crash the game or have any dire consequences.
|- valign="top"
!122
!0x7A
|Always 0?
|- valign="top"
!123
!0x7B
|Always 0?
|- valign="top"
!124
!0x7C
|TFTD ONLY - Appears to be a count as to which frame of bubbles the soldier is on. Can be 0 to 16 (0x0F), most likely 125/7D is included with this.
|- valign="top"
!125
!0x7D
|TFTD ONLY, unknown.
|- valign="top"
!126
!0x7E
|TFTD ONLY, unknown.
|- valign="top"
!127
!0x7F
|TFTD ONLY, unknown.
|- valign="top"
!128
!0x80
|TFTD ONLY, unknown.
|- valign="top"
!129
!0x81
|TFTD ONLY, unknown.
|- valign="top"
!130
!0x82
|TFTD ONLY, unknown.
|- valign="top"
!131
!0x83
|TFTD ONLY, unknown.
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 111 values.
Unknown values (13 in total):
[[#34|[034 / 0x22]]] - Always 0?
[[#36|[036 / 0x24]]] - Always 0?
[[#43|[043 / 0x2B]]] - Set to 1 on occasion, usually 0.
[[#52|[052 / 0x34]]] - Seems to be a mirror of 48 / 0x30, the LOFTemp index for the unit.
[[#71|[071 / 0x47]]] - Appears to relate to lighting caused by the unit, [[Talk:UNITREF.DAT#Offset_0x47|discussion here]].
[[#74|[074 / 0x4A]]] - Appears to relate to the AI-mode used by the unit, [[Talk:UNITREF.DAT#Offset_0x4A_.2874.29|discussion here]].
[[#75|[075 / 0x4B]]] - Always 0?
[[#112|[112 / 0x70]]] - Set to 1 for some aliens, 0 otherwise.
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#120|[120 / 0x78]]] - Unit bit flags, mainly re: mobility. Only one bit not 100% identified.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

Know 1 TFTD value.
Unknown TFTD values (7 in total):
[[#125|[125]]] [[#126|[126]]] [[#127|[127]]] [[#128|[128]]] [[#129|[129]]] [[#130|[130]]] [[#131|[131]]]

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

MCDEdit

2015-06-22T19:56:25Z

Volutar: /* Main screen 1.17i */

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

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

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

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

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

At the top of the main area is the MCD preview/selection line with the bar. Yellow highlighted MCDs are animated. Red dot indicates it's a referenced MCD (by some other MCDs, which will be shown at the right part of Status Bar).
You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD. You can select multiple MCDs with ''Shift'' and ''Ctrl'', it will aggregate MCD data, and it's possible to change multiple values through selected (different values are displayed as "mix"). '''RMB''' calls the context menu for the clicked MCD (''Copy MCDs / Paste MCDs / Insert MCD / Add MCD / Delete MCDs / Clear MCDs'') - same as in the '''Edit''' menu. If you are not allowed to change the number of MCDs (ie: in vanilla mode) these menu entries will be greyed out.

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).

When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values. Also you can change number of sprites per row when exporting images.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Autoconfirm" checkbox (saving changes of sprites without confirm window). Lower are set of color/group modification buttons. They change colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself. Lower are rotating/flipping buttons.

Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17i (2015-06-23) ([http://volutar.eu5.org/_mcdedit117i.7z download])

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

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

MCDEdit

2015-06-22T19:52:05Z

Volutar: /* 2015-06-23 v1.17i */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).

When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values. Also you can change number of sprites per row when exporting images.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Autoconfirm" checkbox (saving changes of sprites without confirm window). Lower are set of color/group modification buttons. They change colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself. Lower are rotating/flipping buttons.

Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17i (2015-06-23) ([http://volutar.eu5.org/_mcdedit117i.7z download])

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

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

Talk:MCDEdit

2015-06-22T19:48:19Z

Volutar: /* 2015-06-23 v1.17i */

Talk:MCDEdit

2015-06-21T18:38:35Z

Volutar: minor update

MCD

2015-06-21T16:07:05Z

Volutar: clarification

{{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
|Lightblock. Note that the actual game seems to ignore this value.
0 Blocks no light.
''... up to ...''
10 Blocks all light.
Is apparently percentage based: 1=10%, 10=100%.
|- 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
|Smoke blockage. This is set to 0 for all UFO tiles!
Technically called "gasblock" by the game. Supposedly it would block the gas type from spreading. Not sure if this is intended to be just smoke, gas or a combination of the two. Needs testing.
|- 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 USO 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>USO/Entry</td><td>9</td></tr>
<tr><td align="left">uext3</td><td>USO/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>USO</td><td>41</td></tr>
<tr><td align="left">uint2</td><td>USO</td><td>11</td></tr>
<tr><td align="left">uint3</td><td>USO</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]]

SMOKREF.DAT

2015-06-21T16:00:24Z

Volutar: Field 8 is never "4". if (animation_frame>3) animation_frame-=4;

'''SMOKEREF.DAT''' contains 400 records of 9 values of one byte each for a total of 3600 bytes.

There are a total of 12 sprites available for displaying smoke. Any given patch will animate through 4 consecutive sprites. The first sprite is (int)(smokeref[3] / 6 + 8) in [[SMOKE.PCK]].

That is to say, if the smoke is due to last for less then six turns, smoke sprites 0 to 3 will be used. If the smoke is due to last less the twelve but more then five turns, sprites 1 to 4 will be used, and so forth.

This allows for nine different densities of ''displayable'' smoke. If the smoke is due to last fifty four or more turns, however, then [[rank]] badges will be included in the smoke animation. Values higher still will include bullet animations.

Smoke hinders vision according to a similar formula - (int)(smokeref[3] / 3). That is to say, take a cloud's "time to live", divide that by three and round the result down: This tells you how many tiles it chops off your effective range.

For example, say there are ten clouds with a TTL of 1 directly between you and your target. In this scenario, they won't affect your vision at all (1/3 rounded down = 0). But if they each have a TTL of 8, they'll each require you to move closer by two tiles (8/3 rounded down = 2) - removing 20 tiles from your visibility range!

Because the formula for what you see on the screen doesn't match the formula for how smoke obscures vision, it's impossible to tell a cloud's effect just by looking at it. For example, a cloud with a TTL of 7 will look the same as a cloud with a TTL of 10 - But the first cloud will only remove two tiles from your vision, whereas the second removes three.

Smoke clouds will drift around the battlescape and merge with others (effectively making them denser), though the rules for how are currently unknown. Summed up simply this means that smoke grenades are most likely more effective a few turns after they actually go off.

==Structure==
* '''0:''' Y position of smoke/fire.
* '''1:''' X position of smoke/fire.
* '''2:''' Z position of smoke/fire.
* '''3:''' Time smoke will last (also used as density). AKA "Intensity"
* '''4:''' Time fire will last. AKA "Age"
* '''5:''' Number of smoke patches overlapped (used only in runtime). Called "justspread"; 0=hasn't spread recently otherwise intensity of new spread.
* '''6:''' Fire or smoke?
** 0 Empty
** 1 Fire
** 2 Smoke
** 3-6 Gas (probably unused)
* '''7:''' Visibility flag. Note that smoke still won't be rendered unless the tile it's in is also visible.
* '''8:''' Animation frame offset. Set at random, to break tile pattern in cloud of smoke. Ranges from 0 to 3.

==See Also==
* [[Saved Game Files]]
* [[Saved_Game_Files#Battlescape_Files|Battlescape Files]]
* [[Smoke and Fire]]
* [[Smoke Grenade]]
* [[SMOKBIT.DAT]]

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

UNITREF.DAT

2015-06-21T15:52:39Z

Volutar: clarification on 0x24

A [[Saved Game Files|save game file]] that has a record size of 124 bytes for UFO, or 132 for TFTD. Values are unsigned unless otherwise stated. Some bytes represent bitfields. There are 80 records (not all of them necessarily used) for a fixed file size of 9,920 bytes (or 10,560 for TFTD). It goes hand in hand with [[UNITPOS.DAT]].

Comes in three flavours: 

*UNIREF.DAT 
Initially created by the GeoScape engine before tactical battles. Stored in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder and contains info on all units that will be present in the coming mission (in an alive state - the deaths of aliens killed by exploding UFO power units isn't determined until [[Battlescape_Map_Generation#KABOOM.21.21|later]]). Unlike the other two versions, this only contains the bare minimum number of records required to store the units it details. 

*UNITREF.DAT 
Created along with a [[Saved_Game_Files#Battlescape_Files|battlescape save]], contains the mid-mission state of the unit table. 

*UNIREF2.DAT 
Appears in the [[Saved_Game_Files#Missdat_Files|MISSDAT]] folder at the end of combat. Used to determine which troopers/tanks survived, statistic gains via [[experience]], and which aliens need to be hauled off to the [[Alien Containment]] unit. 

Values are presented according to byte offset ([[#0|0]] to [[#123|123]] (or [[#131|131]] for TFTD)) followed by the equivalent hex offset ([[#0x00|0x00]] to [[#0x7B|0x7B]] (or [[#0x83|0x83]] for TFTD)). Notes apply to both UFO and TFTD unless otherwise stated. Let us know what else you can find - refer to the [[#Notes|bottom of the page]] for those values that're unknown, or to the [[Talk:UNITREF.DAT|talk page]] for further ideas as to what they could be.

== Structure ==

{| class="wikitable"
|-
!Offset (Decimal)
!Offset (Hex)
!Usage
|- valign="top"
!0
!0x00
|Type of unit. Unit scream and movement sound effects are based on this and gender. Gender and flying abilities affect the sprites as well. Not turrets. Specifically: [[#53|[53]]] & [[#54|[54]]] (weapons in hands), [[#115|[115]]] (gender) and [[#120|[120]]] (other flags) affect the final screen image. If the unit is a large unit, this will also determine the appearance of the last three quarters of the unit. This does NOT affect: the flying ability of the unit, the soldier image in the inventory screen, or the special abilities for certain aliens.
UFO TFTD
0: Male/female unarmored X-COM soldier 0: Male/female unarmored X-COM diver
1: Male/female personal armor soldier 1: Male/female plastic armor diver
2: Power/flying suit soldier 2: Power/flying suit diver
3: Tank 3: Tank
4: Sectoid 4: Aquatoid
5: Snakeman 5: Gillman
6: Ethereal 6: Lobster Man
7: Muton 7: Tasoth
8: Floater 8: Calcinite
9: Celatid 9: Deep One
10: Silacoid 0A: BioDrone
11: Chryssalid 0B: Tentaculat
12: Reaper 0C: Triscene
13: Sectopod 0D: Hallucinoid
14: Cyberdisc 0E: Xarquid
15: Male civilian 0F: Male civilians
16: Female civilian 10: Female civilians
17: Zombie 11: Zombie
255: Unused 255: Unused

<blockquote>If the corresponding [[UNITPOS.DAT]] record is unused, then the record is unused.</blockquote>
|- valign="top"
!1
!0x01
|Inventory paper doll image. File "UFOGRAPH\MAN_"+(char)(value + 48)+".SPK" will be used as the inventory sprite, unless the value is 0 or 1. In those cases, [[#115|[115]]] and [[#116|[116]]] are used to determine the picture.
0: No armor.
1: Personal armour.
2: Power suit.
3: Flying suit.
|- valign="top"
!2-5
!0x02-0x05
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|PCK set]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!6-9
!0x06-0x09
|Four byte value pointing to RAM location of the [[Image_Formats#PCK|TAB index for the PCK data]] used by the unit. Re-determined when the save game is loaded.
|- valign="top"
!10
!0x0A
|Unit facing. Does NOT control HWP turret direction; see [[#24|[24]]].
0: North (up right)
1: Northeast (right)
2: East (down right)
3: Southeast (down)
4: South (down left)
5: Southwest (left)
6: West (up left)
7: Northwest (up)
|- valign="top"
!11
!0x0B
|Movement type. When entering a given map location, each tile is checked to see the TU requirements accordingly. [[MCD]][39+[[#11|UnitRef[11]]]] is the offset used. Note: By default, this is 0 for ALL unit types.
0: Walking
1: Sliding
2: Flying
|- valign="top"
!12
!0x0C
|Current TUs.
|- valign="top"
!13
!0x0D
|Current Health. Health of 0 = Dead. Compare [[#42|[42]]], [[#120|[120]]].

''For my [[Talk:Bravery|Bravery experience point testing]], I killed 15 of 16 aliens by setting this to zero, and my soldiers to 0 Morale. When I loaded the savegame, the aliens were still "alive" (i.e., up), then all died when I ended this turn. So death is probably only checked when injury happens, and at end of turn... to truly kill them dead on the ground through savegame editing must take more. And arg - when they all died, my soldiers all went to 100 Morale! So I edited them back to 0 Morale. But guess what... then all the aliens died '''again''' at the end of '''next''' turn, even though they were all on the ground (I heard screams, and all soldiers' Morale went to 100 again). What the heck? The aliens stayed down after that, though. --[[User:MikeTheRed|MikeTheRed]] 16:01, 3 November 2006 (PST)''

''Update: [[UNITPOS.DAT]] offset 10 bit 2 should be used to kill a unit entirely dead. Thanks, NKF & BB - MTR''

: ''While the game kills characters when Health<=Fatal Wounds (__ dies message), XComUtil will recover them based if their health is greater than 0. Haven't tested an unmodified game. --[[User:Zaimoni|Zaimoni]] 11:52, 14 April 2007 (CDT)''
|- valign="top"
!14
!0x0E
|Current Stun level ''how much falloff of paralysis every turn? What determines it?''
|- valign="top"
!15
!0x0F
|Current Energy
|- valign="top"
!16
!0x10
|Current Reactions ''NKF: affected by health percentage''
|- valign="top"
!17
!0x11
|Strength
|- valign="top"
!18
!0x12
|Current Front Armour
|- valign="top"
!19
!0x13
|Current Left Armour
|- valign="top"
!20
!0x14
|Current Right Armour
|- valign="top"
!21
!0x15
|Current Rear Armour
|- valign="top"
!22
!0x16
|Current Under Armour
|- valign="top"
|colspan="3"|"Base" means the original (total) value (as carried forward from geoscape) - Also see Note 1 re: Base soldier stat values.
|- valign="top"
!23
!0x17
|Base Firing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)
|- valign="top"
!24
!0x18
|Base Throwing accuracy. Current value = this * [[#13|[13]]]/[[#26|[26]]] (percent health)

Note: Tanks (turreted units?) always have 0 throwing accuracy. They use this for turret facing, relative to unit facing. 0 means it's facing forwards. Additional values are clockwise increments; see [[#10|[10]]].
|- valign="top"
!25
!0x19
|Base TUs
|- valign="top"
!26
!0x1A
|Base Health
|- valign="top"
!27
!0x1B
|Base Energy
|- valign="top"
!28
!0x1C
|Base Reactions
|- valign="top"
|colspan="3"|''These Base Armour values are used to show the starting armor value in the Attributes screen (so you can readily see if it's been damaged''
|- valign="top"
!29
!0x1D
|Base Front Armour
|- valign="top"
!30
!0x1E
|Base Left Armour
|- valign="top"
!31
!0x1F
|Base Right Armour
|- valign="top"
!32
!0x20
|Base Rear Armour
|- valign="top"
!33
!0x21
|Base Under Armour
|- valign="top"
!34
!0x22
|Supposedly this was going to be Health Recharge which would function like the Energy Recharge. Always 0 and ignored by game.
|- valign="top"
!35
!0x23
|Energy to recharge each turn. Equals '''recruit initial''' TUs/3 ([[SOLDIER.DAT]][43], '''not''' total base TUs). This is a signed byte. See [[Time Units]] and [[Energy#Usage|Energy Usage]]; also see [[#45|[45]]] (energy usage when walking/turning). ''BombBloke: Is this affected by damage?''
|- valign="top"
!36
!0x24
|Supposedly this was going to be Armor Recharge which would function like the Energy Recharge. Always 0 and probably unused, but needs testing.
|- valign="top"
!37
!0x25
|Psi skill. Psi stats not displayed/usable until this is greater then 0.
|- valign="top"
!38
!0x26
|Item to create when unit is unconscious/dead (index into obdata.dat).

NKF: If you set this value to that of a usable item, the item that is created in place of the unconscious or dead soldier can be used like the ordinary item. Elerium pods, for example, can be recovered for 50 elerium each after the battle. Weapons can be used as you normally use them, etc.

For unconscious 'units', the item will be treated as the unconscious body - it will retain the name of the unconscious unit when looked at via the inventory screen. Picking up and using the 'item' will work, but when the unit wakes up, the 'item' image in the soldier's hands is not cleared, even though the item no longer 'exists' in the soldier's hands. Using this 'item' will just crash the battlescape.

Actually, I do not even want to think about what would happen if you 'prime' a grenade/stunned body.
|- valign="top"
!39
!0x27
|"Soldier value" a.k.a. victory points. You gain (or lose, as the case may be) score at the end of combat according to this value when the unit dies.
*For X-COM units: A soldier with 42 will be worth -42 points if killed. Note this doesn't seem to apply if the soldier is killed when unconscious. The soldier just vanishes.
*For aliens: A commander with 35 will give you +35 points if killed.
*This value is the same as [[SOLDIER.DAT]] bytes 15-16 (a Word) and equals:
20 + Missions + Rank Bonus

with [[Rank]] Bonus as follows: SGT +1, CPT +3, COL +6, CDR +10
Note that although this equation holds true, the value is not actually computed per se. Instead, 1 is added directly to it each mission, as is a rank-bonus delta if you advance (e.g. COL to CDR, delta +4). In other words, hacking the Missions or Rank fields does not affect this value.
|- valign="top"
!40
!0x28
|Index into [[SOLDIER.DAT]], so game knows what to update. 255 = does not belong to anyone (i.e., it's not a soldier). ''NKF: This byte is critical for player controlled units. If this doesn't refer to anything, the unit ceases to exist at the end of the game. If it points to a valid soldier entry in soldier.dat, the soldier.dat entry will be updated.''
|- valign="top"
!41
!0x29
|Animation frame counter for the unit. Used by eg [[Celatid]]s and [[Silacoid]]s.
|- valign="top"
!42
!0x2A
|Rank. Affects morale loss and interface icon (hull for tanks). Only X-COM troopers display rank icons.
X-COM
0: Rookie ''Civvies are 0 too''
1: Squaddie
2: Sergeant
3: Captain
4: Colonel
5: Commander
255: Dead/unused

Aliens
1: Commander
2: Leader
3: Engineer
4: Medic
5: Navigator
6: Soldier
7: Terrorist
255: Dead/unused

Hull shape for X-COM tanks:
0: Treaded
1: Hover
''I don't see 255 set for three dead mutons in a current game... [[#13|[13]]] (Health=0) seems to be the only reliable death indicator for them. Compare [[#120|[120]]]. -[[User:MikeTheRed|MikeTheRed]]''
|- valign="top"
!43
!0x2B
|0 or 1. ''When alien units are generated for a battle, there is a random chance for this byte to be set. That unit is a "scout" and can be assigned to one of the neutral spawn points on the map without the need to fill up all the alien exclusive points first.-[[User:Morgan525|Tycho]] ([[User talk:Morgan525|talk]])''
|- valign="top"
!44
!0x2C
|Alien aggression. The higher it is, the less likely an alien will take cover. Maximum of 2. 0=Cautious,1=Normal,2=Aggressive ''MTR: This is true for aliens in Hobbes game, but soldiers have values from 4 to 254. Garbage? Delete this comment if so.'' This determines the amount of the unit's TUs that are devoted to shooting: 0=50%,1=60%,2=66%.
|- valign="top"
!45
!0x2D
|Used to calculate energy loss when walking or turning as: INT( TUs / 2[45] ). See [[Energy#Usage]]; compare [[#35|[35]]] (energy recharge per turn). Set this byte to 4 to ensure no energy use whatsoever (maximum map [[Time Units#Time_Unit_Walking_Usage_Tables|tile TU cost]] is 12). ''In Hobbes game, many aliens are 0 and all soldiers are 1, but a dozen aliens have higher values ranging all the way up to 112! Garbage and/or the game doesn't care if they are garbage?''
|- valign="top"
!46
!0x2E
|HWP turret image. Only used (and only appears) if unit type [[#0|[0]]]=3 (X-COM tanks):
0: Cannon
1: Rocket
2: Laser
3: Plasma
4: Blaster
5,6: ? Blanks
'''Note:''' For non-tanks, this controls the inventory layout. ''Only'' 0 and 1 are valid. 0 is the standard layout seen on all soldiers. 1 is an alternate layout that may have been intended for custom tank equipment. Larger values only crash the game due to missing files. Also see [[#113|[113]]] and [[#117|[117]]].
|- valign="top"
!47
!0x2F
|This is a direct copy of offset[48] from the [[MCD]] record of the tile the unit is standing on. A signed byte.
|- valign="top"
!48
!0x30
|Values for this byte always equal [[#52|[52]]] and are:
2 (3x3 square; legacy 5 pixels): Sectoid
3 (5x5 square, corners removed; legacy 7 pixels): Celatid, Chryssalid, Civvie,
Ethereal, Floater, Muton, Snake, '''Soldier'''
4 (7x7 octagon; legacy 9 pixels): Cyberdisc, Hovertank, Reaper, Sectopod, Tank
5 (9x9 square, Ls with 3-pixel legs removed; legacy 11 pixels): Silacoid
Based on copious research by [[User:Bomb_Bloke|Bomb_Bloke]], [[User:Seb76|Seb76]], [[user:Zombie|Zombie]], and others, this has been found to be a LOF Template look-up for the shape of targets; Loftemps 2 to 5 define the "3D" shape of units relative to Line Of Fire as a cylinder, where 2 (Sectoid) is a thin cylinder and 5 (Silacoid) is very wide. The pixel width of each "silhoutte" that [[LOFTEMPS.DAT]] corresponds to has been added to the list above (see LOFTemps images 2-5). Tiles are 16 pixels wide in the X or Y direction (that's what this byte is about), and 24 pixels high (compare [[#49|[49]]]).

This cylindrical shape is used in conjunction with height [[#49|[49]]] to define the silhouette that targets present to a shooter. Combine the pixel-width cross-section from Loftemps with height to find the cross-sectional area presented to shooters (sorted on increasing cross-section):

LOF LOF Cross Percent
Lookup Width Height Section of 384 Float 4x?
Type ''UR[48] Pixels UR[[#49|[49]]] Pxls X Ht (16x24) UR[[#51|[51]]]''
---- ------ ------ ------ --------- ------- ------ ---
Sectoid 2 5 16 80 20.8% - -
Celatid 3 7 12 84 21.9% 6 -
Soldier (Kneeling) 3 7 14 98 25.5% - -
Hovertank 4 9 12 108 28.1% 6 Yes
Silacoid 5 11 10 110 28.6% - -
Snakeman 3 7 18 126 32.8% - -
Zombie 3 7 18 126 32.8% - -
Ethereal 3 7 20 140 36.5% - -
Cyberdisc 4 9 15 135 35.2% 2 Yes
Chryssalid 3 7 21 147 38.3% - -
Civilian 3 7 21 147 38.3% 2 -
Floater 3 7 21 147 38.3% 2 -
Muton 3 7 21 147 38.3% - -
Tank 4 9 16 144 37.5% - Yes
Soldier 3 7 22 154 40.1% - -
Reaper 4 9 23 207 53.9% - Yes
Sectopod 4 9 23 207 53.9% - Yes
Units take up an amount of the whole tile (as seen in cross-section by a shooter) as shown in the "Percent of 384" column. In reality, though, the [[Firing Accuracy|accuracy]] of shots makes this a more complex topic than the percents suggest. Also, dividing by 384 is an oversimplification, since it implies a directly rectangular shot (shooting right down the X or Y axis). While it's useful to see, keep in mind that this column only shows relative numbers.

: [[User:Zaimoni|Zaimoni]]: actual cross section depends on shot facing. The table is close to correct for pure diagonal shots, so leaving alone for now.

The unit Float number ([[#51|[51]]], below) is shown simply for convenience. It does not enter into the cross-sectional computations. "4x" units actually consist of four units grouped in tight 2x2 formation (making their cross section effectively much larger then the percentage stated).

Note that causing an X-Com soldier to kneel causes their cross section to fall by 36.36~% of that of when they are standing.
|- valign="top"
!49
!0x31
|[[height|Standing height]].
|- valign="top"
!50
!0x32
|[[height|Kneeling height]].
|- valign="top"
!51
!0x33
|Floating [[height]]. A unit 'floats' this high above the ground, thus allowing shots to fly underneath. The highest point of a unit can be found by adding this to the units height stat. Does this have an effect on explosive damage?
|- valign="top"
!52
!0x34
|"Radius" of LOF Template. Always the same as [[#48|[48]]] in all known saved games. More info can be found at [[Talk:UNITREF.DAT#Offsets_0x30_.26_0x34|Talk:UNITREF.DAT#Offsets_0x30_&_0x34]] ([48] and [52]).
|- valign="top"
!53
!0x35
|Image index for item in left hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
!54
!0x36
|Image index for item in right hand. 255 for none. Indexes into [[OBDATA.DAT]], not [[OBPOS.DAT]].
|- valign="top"
|colspan="3"|''NKF:'' If there is no item in the unit's hands, but one of the above two bytes are set, the 'image' that represents the item will still be displayed in the battlescape. If these phantom items are clicked on, the game crashes. If the image is not the right type for the real item in hand, the ammo count doesn't get displayed. Otherwise, it'll work as normal.
|- valign="top"
!55
!0x37
|[[Damage#Susceptible_to...|Damage Modifier]] Category

This field is simply a look-up table, or more directly, a way to categorize the units into similar groups. The actual modifiers are listed in the executable. A value of 1 indicates the first DM category, a value of 4 indicates the 4th, etc. The values of 2 and 3 are not seen in the alien stats as they refer to X-COM soldier armor info. I'm not sure about 13 as the Zombie's stats haven't been found yet, but I think there is a category in the DM's for it.

'''Value''' '''Unit Type(s)'''
'''0''' Terrain and Items
'''1''' Civilian, Sectoid, Celatid, Floater
'''2''' Personal Armor
'''3''' Power Suit, Flying Suit
'''4''' Tanks, Hovertanks
'''5''' Snakemen
'''6''' Ethereal
'''7''' Muton
'''8''' Silacoid
'''9''' Chryssalid
'''10''' Reaper
'''11''' Sectopod
'''12''' Cyberdisc
'''13''' Zombie
|- valign="top"
!56
!0x38
|[[Melee Accuracy]] ([[SOLDIER.DAT]] bytes 50 (initial) & 60 (increase) added together)
|- valign="top"
!57
!0x39
|[[Psionic Strength]]
|- valign="top"
!58
!0x3A
|Current [[Morale]]. Base morale is hardcoded to 100.
|- valign="top"
!59
!0x3B
|[[Bravery]] = 110 - (10 * ''this value'')
|- valign="top"
!60
!0x3C
|Panic mode. This takes effect at the start of the unit's next turn. Since it is cleared at that point, you'll never see it at anything other then 0 in the save files. You can manually change it to other values to force a specific panic attack on the next turn.
0: None
1: Freeze
2: Running
3: Berserk
|- valign="top"
!61
!0x3D
|[[#62|[62]]] will increment by this amount whenever the unit moves.
3: Sectiod ''- Hobbes''
4: Soldiers, civs, and all other aliens (but Hobbes had no Large aliens)
30: Tank/Laser
|- valign="top"
!62
!0x3E
|Visibility via motion scanner. The bigger it is, the bigger the blip. Test this one out for values.
|- valign="top"
!63
!0x3F
|Number of [[Fatal Wounds]] to head.
|- valign="top"
!64
!0x40
|Number of fatal wounds to torso.
|- valign="top"
!65
!0x41
|Number of fatal wounds to right arm.
|- valign="top"
!66
!0x42
|Number of fatal wounds to left arm.
|- valign="top"
!67
!0x43
|Number of fatal wounds to right leg.
|- valign="top"
!68
!0x44
|Number of fatal wounds to left leg.
|- valign="top"
!69-70
!0x45-0x46
|Indexes into [[ROUTES.DAT]]. To start with, aliens will be located at the same position as the node indicated by byte 69.
:For patrol AI (no X-COM units sighted in turn 1, either X-COM or alien):
::Byte 69 is the index of the node of the start of the planned move.
::Byte 70 is the index of the node of the end of the planned move.
:Note that the move may be multi-turn, and byte 69 is not guaranteed to update during a multi-turn move. I think it will if the alien ends its move on a node, however. -- Zaimoni
|- valign="top"
!71
!0x47
|Unit lighting: always 16 for XCom units, 0 for most aliens but 1 for cyberdisc. If greater than 1, it is set to 1 when unit inactive - see the [[Talk:UNITREF.DAT#Offset_0x47|Talk]] page.
|- valign="top"
!72
!0x48
|The amount of [[Morale]] that has been restored using the [[Medi-Kit (EU)|Medkit's]] painkillers. The amount that ''can'' be restored is equal to the maximum health of the unit (index 26) minus their current health (index 13) further minus this.
|- valign="top"
!73
!0x49
|Intelligence. Rated from 2 - 8. Indicates for how many turns the alien will know the location of spotted soldiers. ''Hey - why do humans have zero intelligence? :(''
|- valign="top"
!74
!0x4A
|AI Mode. Zaimoni found [http://www.strategycore.co.uk/forums/UFO-AI-patch-t8908.html&st=20&start=20 Here] that the values are 0:PATROL, 1:SNIPER, 2:ATTACKING, 3:ESCAPING, 4:GUARD, 5:Returning to UFO. 255 (-1) is also possible. Zaimoni tripped this by wounding a Floater in SNIPER mode; it returned fire, then was taken down by another soldier. Snap guess is that this is a "recalculate" marker.
|- valign="top"
!75
!0x4B
|Always 0?
|- valign="top"
!76-77
!0x4C-0x4D
|Mission count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]] ''MTR: Wonder why they bothered to put this in Unitref since this will never change '''during''' a mission; compare how soldier stats are actually read from SOLDIER (not UNITREF) on return to geoscape. Is Missions shown anywhere on the combatscape?
|- valign="top"
!78-79
!0x4E-0x4F
|Kill count. Signed integer (low byte, high byte) also found in [[SOLDIER.DAT]]. Number of kills this unit has made for ALL missions, not just this one. This one '''can''' vary "unpredictably" and thus is the only byte known to directly carry forward into the geoscape / Soldier.Dat!
|- valign="top"
!80
!0x50
|[[Reactions]] experience counter, for number of reaction shots. It doesn't matter if they hit the target; reactions still count. See Note 2 re: Experience counters. (Also note: Aliens do not use experience counters.)

''NKF:'' Where does death by fire (overexposure rather than incendiary shell impact) fit into the experience counters? It becomes a non-assigned kill, I guess, like death by wounds, or death by a grenade that hasn't got an owner?
|- valign="top"
!81
!0x51
|[[Firing Accuracy]] experience counter, for number of hits on an enemy (lethal or not, grenades or bullets). Each Autoshot hit counts as 1, so you can get 3 hits from one Autoshot burst. Likewise, grenades and blaster bombs can hit multiple targets with one explosion. Also, if you miss the intended target but hit a different alien, it still counts. Finally, if your shot actually has zero [[Damage]], it does still count as a hit. (Not due to armor blockage; a pure roll of 0 coming out of the gun.)
|- valign="top"
!82
!0x52
|[[Melee Accuracy]] experience counter, for number of times stun rod has been used (not stun bombs).
|- valign="top"
!83
!0x53
|[[Throwing Accuracy]] experience counter, for number of times unit has thrown any object.
|- valign="top"
!84
!0x54
|<div id="Psi_Skill_Experience_Counter"></div>[[Psionic Skill]] experience counter, for number of psi attacks performed. 1 is added if attempt was unsuccessful, 3 if it was successful. Note: if this value goes over 255, all psi experience is lost. That's 85 successful psis (255/3). So be careful of marathon psi'ing (a minimum of 43 turns at 2 psis/turn, 29 turns at 3/turn).
|- valign="top"
!85
!0x55
|[[Bravery]] experience counter, for number of times unit has ''resisted'' panicking, despite Morale < 50. Being mind-controlled, panicking, or going berserk does ''not'' increase this stat -- although Panic Unit attacks will reduce Morale to the point where panic checks will be performed by the game.
|- valign="top"
!86-110
!0x56-0x6E
|Unit's Name. Standard string ended by null byte. The rest can hold garbage.
|- valign="top"
!111
!0x6F
|Called "BigFire". If true (value of 1) then the unit is currently firing a weapon. It reverts back to 0 afterwards - determines whether to render the gun and firing arm in the "pointing weapon" position, or whether the weapon is being held against the chest. If manually set to a value above 0, the unit will hold its weapon out until such time as it actually uses it.

Note that this value is only used by units holding two-handed weapons. A unit holding for eg a pistol will ''always'' point the weapon, and uses a different arm sprite for the purposes of doing so (regardless of whether or not the weapon is being fired).
|- valign="top"
!112
!0x70
|Called "Finished". If true (value of 1) signifies that the unit finished AI actions for current turn.
|- valign="top"
!113
!0x71
|If 1, then you can't use the inventory button and the unit will be immune to stun. Used for tanks. Mind controlled units don't use this but their button disables anyway.

''BombBloke:'' This is the only way to access tank inventories.
*Tank/Cannon has a normal inventory and uses man_1m0.spk.
*Tank/Rocket Launcher has a different layout and uses man_1m0.spk.
*Tank/Laser Cannon uses man_œ.spk, which doesn't exist normally. Providing this file still crashes.
*Hovertank/Plasma simply crashes.
*Hovertank/Launcher simply crashes.

[[#1|[1]]] actually determines the inventory screen used, might be worth playing with that. [[#46|[46]]] determines the layout.
|- valign="top"
!114
!0x72
|If not 0, then unit is on fire, and will burn for this amount of turns.
|- valign="top"
!115
!0x73
|Gender: 0 = male, 1 = female.
|- valign="top"
!116
!0x74
|Hair/skin colour (for inventory; all other units = 0):
0: Blond caucasian
1: Brunette caucasian
2: Asian
3: Black
|- valign="top"
!117
!0x75
|Turret weapon. Over-rides hand held weapon. Turret images are not centered; that would be impossible because they aren't all 'objects' (e.g. Celatid). ''(Mix of notes by BB and NKF)''
F.A. TUs F.A. TUs
0: HWP cannon (bigobs[40])....................Aimed 90% 80% Snap 60% 33%
1: HWP rocket (bigobs[42])....................Aimed 115% 75% Snap 55% 45%
2: HWP laser (bigobs[54]).....................Aimed 85% 75% Snap 50% 33%
3: HWP plasma cannon (bigobs[43]).............Aimed 100% 60% Snap 86% 30%
4: HWP blaster (bigobs[43]) (looks like ordinary cannon?)......Aimed 120% 80%
5: Celatid plasma cannon (bigobs[38]).........Aimed 110% 60% Snap 75% 30%
6: Cyberdisc plasma cannon (bigobs[34]).......Aimed 110% 60% Snap 75% 30%
7: Sectopod Laser* cannon (bigobs[34])as cyberdisk, above, plus Auto 50% 35%
22: Invalid - Incredibly powerful armour piercing shell. Overpowering.
255: Unused
Note: This item will take precendence over any item carried in the hand slots. It can be installed on non-tanks, but then the unit won't be able to use any carried weapons or items. This weapon is NOT affected by the kneeling modifier, but it is affected by the current unit's accuracy stat. Also note, this byte does NOT determine the turret image for HWPs in the battlescape.

[*]The damage type for the Sectopod is indeed set to (3)laser in the executable! Graphical/sound effects of a turret weapon is set there as well, via a reference to a weapon in OBDATA.DAT (HWP Cannon=4=Heavy Cannon, Sectopod=34=Heavy Plasma) ''When I changed HWP Cannon to 2, it looked/sounded like rifle fire - Crus8r''

Also see [[#46|[46]]], [[#113|[113]]], and [[#118|[118]]].
|- valign="top"
!118
!0x76
|Ammo for [[#117|[117]]] turret weapon
|- valign="top"
!119
!0x77
|Movement related? Large unit related? Possible bitfield.
''MTR:''
00000000 0 Chryssalid(2), Civilian(9), Ethereal(2), Floater(2), Muton,
00000001 1 Muton, PA Soldier(2) Sectoid(2), Silacoid(2),
00000011 3 PA Soldier PA Soldier(2), Tank/Laser
00000101 5 Snakeman
00001010 10 Celatid ''- Hobbes game - could have some garbage''
00001101 13 Muton, PA Soldier '' (parens) is count, if more than 1 unit''
00010011 19 Snakeman
00100110 38 PA Soldier
00101010 42 Muton(3)
00110001 49 Muton
00110010 50 PA Soldier
00110101 53 Silacoid(2)
00111011 59 Celatid
00111111 63 Silacoid
01001110 78 PA Soldier
01100111 103 PA Soldier
01111111 127 Muton
10010000 144 Muton
11000000 192 Celatid
11111110 254 Muton
|- valign="top"
!120
!0x78
|Unit bit flags, mainly re: mobility. They do NOT affect the soldier in inventory screen: ''(Mix of notes by BB and NKF)''
( 1) 1: 1 = Dead. ''This was only set for 2 of 3 dead aliens in my current game.''
''[[#13|[13]]] (Health=0) is the most reliable indicator for me.''
''-[[User:MikeTheRed|MikeTheRed]]''
( 2) 2: 1 = Unit can fly.
( 4) 3: 1 = Unit is flying. (Toggles leg sprites for power armour.)
( 8) 4: 1 = Has been to this unit in next unit loop. Or to put it another way, has the unit been selected this turn.
( 16) 5: 1 = Unit has been disabled for selection.
(Stops the unit tab button from selecting this soldier.)
( 32) 6: 0 = Unit has left hand object selected, 1 = right hand object selected.
( 64) 7: 1 = Unit is kneeling.
(128) 8: 1 = Unit is wearing power/flying suit. (Can't be stunned by smoke flag?
Seems to work for fire, too.)
If a unit is carrying something in either hand, it is impossible to get him to appear as if he is carrying nothing - in the game, at least. If he is carrying nothing, bit 6 can flag (as though the unit was using it's right hand item). But maybe it's just the order of dropped items affecting this?

Note: A unit is only considered as flying if it is not on the ground. For example, a hover tank is not always considered as flying.

What if a hovertank is half on the ground, half in the air? What about a treaded tank, or large alien unit? What about units in lifts?
|- valign="top"
!121
!0x79
|Possible Values: 0 or 16. All units in unitref.dat get a value of 0 except for the second unit in the list which gets 16. Doesn't matter if the second unit is a soldier, a tank, or an alien. It's always 16. Editing it to 0 doesn't crash the game or have any dire consequences.
|- valign="top"
!122
!0x7A
|Always 0?
|- valign="top"
!123
!0x7B
|Always 0?
|- valign="top"
!124
!0x7C
|TFTD ONLY - Appears to be a count as to which frame of bubbles the soldier is on. Can be 0 to 16 (0x0F), most likely 125/7D is included with this.
|- valign="top"
!125
!0x7D
|TFTD ONLY, unknown.
|- valign="top"
!126
!0x7E
|TFTD ONLY, unknown.
|- valign="top"
!127
!0x7F
|TFTD ONLY, unknown.
|- valign="top"
!128
!0x80
|TFTD ONLY, unknown.
|- valign="top"
!129
!0x81
|TFTD ONLY, unknown.
|- valign="top"
!130
!0x82
|TFTD ONLY, unknown.
|- valign="top"
!131
!0x83
|TFTD ONLY, unknown.
|-
|}

== Notes ==
1) The original/base values for soldier stats (offsets [[#23|[23]]]-[[#28|[28]]], etc.) correspond to the initial+increase bytes from [[SOLDIER.DAT|Soldier.Dat]] (bytes 43-62). Changes to these Unitref bytes are lost when the mission ends; instead, XCOM re-reads them from Soldier at that time. This makes sense because base soldier stats don't change during a mission per se (although they might increase when the mission ends); in this way, the programmers didn't have to bother with separately storing and/or adding initial+increase during combat. (It's also why you don't see the initial+increase in the soldier stat display during combat, that you can see back at base.) On a practical note, if you are testing soldier stat increases versus experience counters, change the experience counters in Unitref, but change the soldier stats in Soldier. (IOW, it doesn't matter what the soldier stats are in the combat mission.)

The Kill count (offset [[#78-79|[78-79]]]) is the only Unitref value I know of that is directly carried forward into the geoscape and Soldier.dat. However, some others do indirectly carry forward, for example: experience (offsets [[#80|[80]]]-[[#85|[85]]]) causes stat and rank increases, and decreased health (offset [[#26|[26]]] - offset [[#13|[13]]]) means hospital time. And, of course, death is permanent. Heh.

2) Experience counters (offsets [[#80|[80]]]-[[#85|[85]]]) determine the likelihood of soldier stat increases at the end of the combat mission, according to the formula for Primary Stats shown [[Experience#How_Experience_Points_Are_Applied|here]]. The Bravery counter (offset [[#85|[85]]]) affects Bravery as shown [[Bravery|here]].

Also, if at least one of the experience counters (except Throws) has a count, your secondary stats will increase, as discussed [[Experience#Secondary_Stats|here]]. All you need is at least a 1 in offsets [[#80|[80]]]-[[#82|[82]]] or [[#84|[84]]]-[[#85|[85]]]; more than 1 and/or multiple counters has no additional effect.

3) BombBloke's additional "To be Done" notes - can we cross some of these off yet?

Need to research:
Stun recovery rate, does it exist?
Hand to hand attacks
<strike>Offset of weapon from unit image?</strike>
''Based on unit height and nothing else. There may be values to determine what arm sprites to use,''
''but I doubt it.''
Firing sprite offset?
''Probably just based on unit height and some hardcoded values in the executable.''
<strike>Inventory lockout?</strike> ''All mind controlled units are locked out.''
Kneel lockout?
''Probably the same as above, I seem to remember that using XcomUtil to "swap sides" would make it''
''possible to kneel small alien units.''
<strike>Aliens seen?</strike> ''Not used in unitref.dat, only in unitpos.dat. -[[User:Zombie|Zombie]] 23:48, 29 September 2006 (PDT)''
<strike>Whether a unit slides/floats/hovers/rolls/walks (movement noise)?</strike> ''Set according to unit type.''
What else? The more to look for, the easier it is...

Know 111 values.
Unknown values (13 in total):
[[#34|[034 / 0x22]]] - Always 0?
[[#36|[036 / 0x24]]] - Always 0?
[[#43|[043 / 0x2B]]] - Set to 1 on occasion, usually 0.
[[#52|[052 / 0x34]]] - Seems to be a mirror of 48 / 0x30, the LOFTemp index for the unit.
[[#71|[071 / 0x47]]] - Appears to relate to lighting caused by the unit, [[Talk:UNITREF.DAT#Offset_0x47|discussion here]].
[[#74|[074 / 0x4A]]] - Appears to relate to the AI-mode used by the unit, [[Talk:UNITREF.DAT#Offset_0x4A_.2874.29|discussion here]].
[[#75|[075 / 0x4B]]] - Always 0?
[[#112|[112 / 0x70]]] - Set to 1 for some aliens, 0 otherwise.
[[#119|[119 / 0x77]]] - No idea, possible bitfield, could be anything.
[[#120|[120 / 0x78]]] - Unit bit flags, mainly re: mobility. Only one bit not 100% identified.
[[#121|[121 / 0x79]]] - Second unit gets a value of 16. Everyone else gets 0. No obvious purpose.
[[#122|[122 / 0x7A]]] - Always 0?
[[#123|[123 / 0x7B]]] - Always 0?

Know 1 TFTD value.
Unknown TFTD values (7 in total):
[[#125|[125]]] [[#126|[126]]] [[#127|[127]]] [[#128|[128]]] [[#129|[129]]] [[#130|[130]]] [[#131|[131]]]

4) Hobbes posted a savegame with a TON of different aliens in it [http://www.xcomufo.com/forums/index.php?showtopic=8591 here] (message 6). Interesting for testing. But note it was made with XCOMUTIL and there may(?) be concerns over vailidity of unit info - see [[Talk:UNITREF.DAT]].

5) A [[HackerTools|Hex Workshop]] Structure Library for UNITREF.DAT created by Danial is [[UNITREF_DAT_HSL|here]].

== For More Information ==
*[[SOLDIER.DAT]]
*[[Soldiers|Soldier Stats]]
*[[Experience]]
*[[HackerTools|Hex editing]]

Return to [[Saved_Game_Files|Saved Game Files]]
[[Category:Game Files]]
[[Category:Enemy Unknown/UFO Defense]]

Talk:MCDEdit

2015-06-21T14:58:49Z

Volutar: /* 2015-06-21 v1.17h */

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
* Added multiple PCKs adding to menu (1,5 and 15)

====2015-04-06 v1.17g====
* PCK Edit:
* Fixed RGBA png import.
* Fixed insert new PCK.
* Added "Settings" menu with PCK sheet margin/spacing options and number of sprites per row for export.

====2015-06-21 v1.17h====
* MCD Edit:
* Adding/Deleting MCDs will change particular fields accordingly (Alt_MCD/Die_MCD fields), including consideration if it's a "door" field or not. Special characters are needed at the tail of particular field names to work properly.
* Informative warning message if you're trying to delete MCDs which are used in other MCDs (as Alt_MCD/Die_MCD).
* PCK Edit:
** PasteMode is not going to be turned off in Draw mode until you start drawing.
** Hover color info and highlight cross now works correcty with overlay/underlay "pasted" fragment.
** Added tools to rotate (CW/CCW) + Flip (Horizontal/vertical) of selection or "pasted" fragment.
** Additional small fixes.

===Wishes===

MCDEdit

2015-06-21T14:53:07Z

Volutar: /* 1.17h */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).

When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values. Also you can change number of sprites per row when exporting images.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Autoconfirm" checkbox (saving changes of sprites without confirm window). Lower are set of color/group modification buttons. They change colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself. Lower are rotating/flipping buttons.

Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17h (2015-06-21) ([http://volutar.eu5.org/_mcdedit117h.7z download])

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

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

File:Mcdedit pckedit.png

2015-06-21T14:43:44Z

Volutar: Volutar uploaded a new version of "File:Mcdedit pckedit.png"

PCK Editor

Talk:MCDEdit

2015-06-20T08:12:38Z

Volutar:

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
* Added multiple PCKs adding to menu (1,5 and 15)

====2015-04-06 v1.17g====
* PCK Edit:
* Fixed RGBA png import.
* Fixed insert new PCK.
* Added "Settings" menu with PCK sheet margin/spacing options and number of sprites per row for export.

====2015-xx-xx v1.17h (upcoming) ====
* MCD Edit:
* Adding/Deleting MCDs will change particular fields accordingly (Alt_MCD/Die_MCD), including consideration if it's a "door" field or not.
* Informative warning message if you're trying to delete MCDs which are used in other MCDs (as Alt_MCD/Die_MCD).
* PCK Edit:
** PasteMode is not going to be turned off in Draw mode until you start drawing.
** Hover color info and highlight cross now works correcty with overlay/underlay "pastemode" fragment.
** (?) Rotate (90/180/270)/Flip(hor/ver) selection or "pastemode" fragment (through the Edit/RMB menu).

===Wishes===

Talk:MCDEdit

2015-06-20T08:11:45Z

Volutar: /* announce of upcoming v1.17h */

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
* Added multiple PCKs adding to menu (1,5 and 15)

====2015-04-06 v1.17g====
* PCK Edit:
* Fixed RGBA png import.
* Fixed insert new PCK.
* Added "Settings" menu with PCK sheet margin/spacing options and number of sprites per row for export.

====2015-xx-xx v1.17h==== (upcoming)
* MCD Edit:
* Adding/Deleting MCDs will change particular fields accordingly (Alt_MCD/Die_MCD), including consideration if it's a "door" field or not.
* Informative warning message if you're trying to delete MCDs which are used in other MCDs (as Alt_MCD/Die_MCD).
* PCK Edit:
** PasteMode is not going to be turned off in Draw mode until you start drawing.
** Hover color info and highlight cross now works correcty with overlay/underlay "pastemode" fragment.
** (?) Rotate (90/180/270)/Flip(hor/ver) selection or "pastemode" fragment (through the Edit/RMB menu).

===Wishes===

Talk:MCD

2015-06-20T07:47:21Z

Volutar: /* Offset 38 (0x26) */

52: Footstep sound effect.

I didn't log in because I don't have an account... yet. I looks like I was wrong on the arctic terrain, I thought it uses sand effect, but I checked it's actually normal (2).

----
I've started writing a section on Terrain/Map Editing and the technical portion (the structure of the MCD files and so on) has been already presented here. Should I add the Terrain Editing material to this page or start a new one? [[User:Hobbes|Hobbes]] 19:39, 18 Nov 2005 (PST)

----
I am wondering if we might not have a major restructuring of all this stuff. Instead of first "Under the Hood", then "Game File Analysis", and then on yet another link, "Saved Games"... I think these parts warrant enough attention (at least by many wiki regulars) that they have their own link off the main page, and then something like this structure:

Overviews
(right here goes overviews of everything, then:)
Main Programs And Data
Savegame Files
Specific Directories And Files
Main Programs And Data
Savegame Files

Something like that... ANY suggestions welcome, but I think it's time to revamp the lot of it to show it's importance to many regulars, and leave places for overviews versus specific things.

Edit: To answer you more specifically, Hobbes: Choose your place; a general place is fine for me. I think we should overhaul the whole structure. I think it's grown past its original little pecks and nibbles.

What do the rest of you think? ---[[User:MikeTheRed|MikeTheRed]] 19:58, 18 Nov 2005 (PST)

----
Sounds spiffy. --[[User:Danial|Danial]] 20:01, 18 Nov 2005 (PST)

----

Yup, I was planning on doing something like that later on... We'll have to do it a few times as we introduce more pages, in order to keep everything easy to find.

--[[User:Bomb Bloke|Bomb Bloke]] 20:59, 18 Nov 2005 (PST)

== Offsets 22-29 / 0x16-0x1D ==

They seem to be the same as 2-9 bytes of UnitRef table. After MCD loading they are filled with pointers to appropriate pck/tab.

v60 = &a_mcd_data[result];
v60->field_1A_pck = a_TileSet_Catalog[v_BF_Tileset_Cnt].pck;
v60->field_16_tab = a_TileSet_Catalog[v_BF_Tileset_Cnt].tab;

I've found this the same way as for unit pck/tab pointers.
--[[User:Volutar|Volutar]] 14:27, 21 February 2011 (EST)

== Offset 47 / 0x2F ==

It is set to 1 when the MCD data is used as an opened door tile type. It is only set at runtime when a door is opened. Since MCD data is not saved, this explains the door jam bug that makes the doors stay opened when you reload. You can test that on the medium scout ship: if you open the door to the central reactor room and save/reload, the door will stay stuck. If you now open a door of the same type (and same orientation) and end the turn, the door to the reactor chamber will be closed again on the next turn. [[User:Seb76|Seb76]] 14:18, 13 December 2008 (CST)

== Offset 51 / 0x33 ==

Who said this is LIGHT block?
Game uses this field in calculations of explosion wave permeability, so it apparently should be called "explosion block"
Function at address .text:00417F40 refers to this field and to the table (dimensions is 11x17: 11 block values for 17 levels of intensity) at .data:0046C45C. This function is used for calculation of how much explosion will come from x/y/z to its neighbour x1/y1.
--[[User:Volutar|Volutar]] 14:28, 15 April 2011 (EDT)

It's not that easy as it meets the eye. This function (using field 51) works only for second chained explosion. It doesn't create lot of smoke comparing to original and first chained explosions...

Does anyone have particular observation of such ''non standard'' explosions behaviour?
--[[User:Volutar|Volutar]] 05:55, 16 April 2011 (EDT)

This field indeed was ment to be used for lighing calculation (they were using same function for explosion field calculation and for lighting). But they calceled use of this function for light blocking, I dont know why, maybe its results wasn't very good. Still they've left this "lighting" function and it is used after first chained explosion (original, chained1,(enabling!), chained2, chained3, etc). Results are quite unpredictable, since intensivity more than 16 cause getting out of bounds. If you manage to get to this second chained explosion you may notice it looks weird.

void DoExplosion(x,y,z,intens,radius)
{
isExplosion=1;
ClearChainedExplBuffer();
CalcExplosionLightMap(x,y,z,intense,radius); //<--- depending on isExplosion it calculates damage field or lighting
ApplyExplosionDamage(); //<--- adds chained, if something with flag "HE" got exploded
while(!ChainedExplosionsEOF())
{
GetNextChainedExplosion(&x,&y,&z,&intense,&radius)
CalcExplosionLightMap(x,y,z,intense,radius);
ApplyExplosionDamage();
isExplosion=0; /// <--- WHY??? Obviously a bug
}
isExplosion=0;
}
BTW, there are only 50 chained explosions possible, 51th won't explode.
--[[User:Volutar|Volutar]] 06:41, 16 April 2011 (EDT)

== MCDedit ==

Urgh. MCDedit and support files are gone. Anyone want to put it somewhere more ... permanent? Strategycore files section, for example?
[[User:Knan|Knan]] 21:25, 13 March 2009 (EDT)

:It's been in StrategyCore's files section for years now. [http://www.strategycore.co.uk/files/index.php?dlid=415 Clicky]. :) --[[User:Zombie|Zombie]] 21:52, 13 March 2009 (EDT)

::Right. Only went looking in the Editors section, Maps didn't register on the radar. --[[User:Knan|Knan]] 17:47, 14 March 2009 (EDT)

== Ground with TUs = 0 ==

There are at least 2 ground tiles which consumes 0 TUs to walk through them.
Interesting thing, that pathfinder deny walk directly on them, you can only walk ''through''.
These are 6 and 7 tiles in U_BITS tileset.
--[[User:Volutar|Volutar]] 08:02, 12 October 2011 (EDT)

== Offset 38 (0x26) ==

Zombie: 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.

Where is it "defined"? It's not used in the game code AT ALL. There is no check whether it 3,2 or 1.
What map designer do you mean?

I seems to me as just a fantasy.
--[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 10:34, 19 June 2015 (EDT)

:Before you accuse me of being delusional or making stuff up, consider that I am working directly off of dev comments from part of the ACTUAL C code from UFO which I received recently. It's commented in there plain as day. Whether it is actually used in-game anymore is not a earth shattering concern - providing explanations to the remaining unknowns is what I'm after. The burden of proof lies in testing or code digging to see if it is used or not. (You are more than welcome to provide any additional information you can find out). And before this discussion degrades into a "but you only have it, I can't trust you unless I can see it myself" issue, no, you may not get the C code until I can get it cleared through 2K/Firaxis. --[[User:Zombie|Zombie]] ([[User talk:Zombie|talk]]) 01:08, 20 June 2015 (EDT)
:: I wasn't going to accuse you, it's just... this info is too "out of nowhere" tho _pretty_ detailed, that I suspected it might be the real game source (if I remember correctly they claimed it was simply "lost"). My sources are just reversed exes, tho I tried to dig up through everything I could. Of course they don't contain any comments or var names to figure out something about structure members which actually were "optimized" and thrown away from EXE as not used. Of course initially they must be having some purpose devs quitted eventually. And of course I trust you. Partial tile rendering COULD be used for some volumetric tiles like wheat, and for some reason that concept was rejected. But structure member remains. --[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 03:45, 20 June 2015 (EDT)

Talk:MCD

2015-06-20T07:46:24Z

Volutar: /* Offset 38 (0x26) */

52: Footstep sound effect.

I didn't log in because I don't have an account... yet. I looks like I was wrong on the arctic terrain, I thought it uses sand effect, but I checked it's actually normal (2).

----
I've started writing a section on Terrain/Map Editing and the technical portion (the structure of the MCD files and so on) has been already presented here. Should I add the Terrain Editing material to this page or start a new one? [[User:Hobbes|Hobbes]] 19:39, 18 Nov 2005 (PST)

----
I am wondering if we might not have a major restructuring of all this stuff. Instead of first "Under the Hood", then "Game File Analysis", and then on yet another link, "Saved Games"... I think these parts warrant enough attention (at least by many wiki regulars) that they have their own link off the main page, and then something like this structure:

Overviews
(right here goes overviews of everything, then:)
Main Programs And Data
Savegame Files
Specific Directories And Files
Main Programs And Data
Savegame Files

Something like that... ANY suggestions welcome, but I think it's time to revamp the lot of it to show it's importance to many regulars, and leave places for overviews versus specific things.

Edit: To answer you more specifically, Hobbes: Choose your place; a general place is fine for me. I think we should overhaul the whole structure. I think it's grown past its original little pecks and nibbles.

What do the rest of you think? ---[[User:MikeTheRed|MikeTheRed]] 19:58, 18 Nov 2005 (PST)

----
Sounds spiffy. --[[User:Danial|Danial]] 20:01, 18 Nov 2005 (PST)

----

Yup, I was planning on doing something like that later on... We'll have to do it a few times as we introduce more pages, in order to keep everything easy to find.

--[[User:Bomb Bloke|Bomb Bloke]] 20:59, 18 Nov 2005 (PST)

== Offsets 22-29 / 0x16-0x1D ==

They seem to be the same as 2-9 bytes of UnitRef table. After MCD loading they are filled with pointers to appropriate pck/tab.

v60 = &a_mcd_data[result];
v60->field_1A_pck = a_TileSet_Catalog[v_BF_Tileset_Cnt].pck;
v60->field_16_tab = a_TileSet_Catalog[v_BF_Tileset_Cnt].tab;

I've found this the same way as for unit pck/tab pointers.
--[[User:Volutar|Volutar]] 14:27, 21 February 2011 (EST)

== Offset 47 / 0x2F ==

It is set to 1 when the MCD data is used as an opened door tile type. It is only set at runtime when a door is opened. Since MCD data is not saved, this explains the door jam bug that makes the doors stay opened when you reload. You can test that on the medium scout ship: if you open the door to the central reactor room and save/reload, the door will stay stuck. If you now open a door of the same type (and same orientation) and end the turn, the door to the reactor chamber will be closed again on the next turn. [[User:Seb76|Seb76]] 14:18, 13 December 2008 (CST)

== Offset 51 / 0x33 ==

Who said this is LIGHT block?
Game uses this field in calculations of explosion wave permeability, so it apparently should be called "explosion block"
Function at address .text:00417F40 refers to this field and to the table (dimensions is 11x17: 11 block values for 17 levels of intensity) at .data:0046C45C. This function is used for calculation of how much explosion will come from x/y/z to its neighbour x1/y1.
--[[User:Volutar|Volutar]] 14:28, 15 April 2011 (EDT)

It's not that easy as it meets the eye. This function (using field 51) works only for second chained explosion. It doesn't create lot of smoke comparing to original and first chained explosions...

Does anyone have particular observation of such ''non standard'' explosions behaviour?
--[[User:Volutar|Volutar]] 05:55, 16 April 2011 (EDT)

This field indeed was ment to be used for lighing calculation (they were using same function for explosion field calculation and for lighting). But they calceled use of this function for light blocking, I dont know why, maybe its results wasn't very good. Still they've left this "lighting" function and it is used after first chained explosion (original, chained1,(enabling!), chained2, chained3, etc). Results are quite unpredictable, since intensivity more than 16 cause getting out of bounds. If you manage to get to this second chained explosion you may notice it looks weird.

void DoExplosion(x,y,z,intens,radius)
{
isExplosion=1;
ClearChainedExplBuffer();
CalcExplosionLightMap(x,y,z,intense,radius); //<--- depending on isExplosion it calculates damage field or lighting
ApplyExplosionDamage(); //<--- adds chained, if something with flag "HE" got exploded
while(!ChainedExplosionsEOF())
{
GetNextChainedExplosion(&x,&y,&z,&intense,&radius)
CalcExplosionLightMap(x,y,z,intense,radius);
ApplyExplosionDamage();
isExplosion=0; /// <--- WHY??? Obviously a bug
}
isExplosion=0;
}
BTW, there are only 50 chained explosions possible, 51th won't explode.
--[[User:Volutar|Volutar]] 06:41, 16 April 2011 (EDT)

== MCDedit ==

Urgh. MCDedit and support files are gone. Anyone want to put it somewhere more ... permanent? Strategycore files section, for example?
[[User:Knan|Knan]] 21:25, 13 March 2009 (EDT)

:It's been in StrategyCore's files section for years now. [http://www.strategycore.co.uk/files/index.php?dlid=415 Clicky]. :) --[[User:Zombie|Zombie]] 21:52, 13 March 2009 (EDT)

::Right. Only went looking in the Editors section, Maps didn't register on the radar. --[[User:Knan|Knan]] 17:47, 14 March 2009 (EDT)

== Ground with TUs = 0 ==

There are at least 2 ground tiles which consumes 0 TUs to walk through them.
Interesting thing, that pathfinder deny walk directly on them, you can only walk ''through''.
These are 6 and 7 tiles in U_BITS tileset.
--[[User:Volutar|Volutar]] 08:02, 12 October 2011 (EDT)

== Offset 38 (0x26) ==

Zombie: 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.

Where is it "defined"? It's not used in the game code AT ALL. There is no check whether it 3,2 or 1.
What map designer do you mean?

I seems to me as just a fantasy.
--[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 10:34, 19 June 2015 (EDT)

:Before you accuse me of being delusional or making stuff up, consider that I am working directly off of dev comments from part of the ACTUAL C code from UFO which I received recently. It's commented in there plain as day. Whether it is actually used in-game anymore is not a earth shattering concern - providing explanations to the remaining unknowns is what I'm after. The burden of proof lies in testing or code digging to see if it is used or not. (You are more than welcome to provide any additional information you can find out). And before this discussion degrades into a "but you only have it, I can't trust you unless I can see it myself" issue, no, you may not get the C code until I can get it cleared through 2K/Firaxis. --[[User:Zombie|Zombie]] ([[User talk:Zombie|talk]]) 01:08, 20 June 2015 (EDT)
:: I wasn't going to accuse you, it's just... this info is too "out of nowhere" tho _pretty_ detailed, that I suspected it might be the real game source (if I remember correctly they claimed it was simply "lost"). My sources are just reversed exes, tho I tried to dig up through everything I could. Of course they don't contain any comments or var names to figure out something about structure members which actually was "optimized" and thrown away from EXE as not used. Of course initially they must be having some purpose devs quitted eventually. And of course I trust you. Partial tile rendering COULD be used for some volumetric tiles like wheat, and for some reason that concept was rejected. But structure member remains. --[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 03:45, 20 June 2015 (EDT)

Talk:MCD

2015-06-20T07:45:58Z

Volutar: /* Offset 38 (0x26) */

52: Footstep sound effect.

I didn't log in because I don't have an account... yet. I looks like I was wrong on the arctic terrain, I thought it uses sand effect, but I checked it's actually normal (2).

----
I've started writing a section on Terrain/Map Editing and the technical portion (the structure of the MCD files and so on) has been already presented here. Should I add the Terrain Editing material to this page or start a new one? [[User:Hobbes|Hobbes]] 19:39, 18 Nov 2005 (PST)

----
I am wondering if we might not have a major restructuring of all this stuff. Instead of first "Under the Hood", then "Game File Analysis", and then on yet another link, "Saved Games"... I think these parts warrant enough attention (at least by many wiki regulars) that they have their own link off the main page, and then something like this structure:

Overviews
(right here goes overviews of everything, then:)
Main Programs And Data
Savegame Files
Specific Directories And Files
Main Programs And Data
Savegame Files

Something like that... ANY suggestions welcome, but I think it's time to revamp the lot of it to show it's importance to many regulars, and leave places for overviews versus specific things.

Edit: To answer you more specifically, Hobbes: Choose your place; a general place is fine for me. I think we should overhaul the whole structure. I think it's grown past its original little pecks and nibbles.

What do the rest of you think? ---[[User:MikeTheRed|MikeTheRed]] 19:58, 18 Nov 2005 (PST)

----
Sounds spiffy. --[[User:Danial|Danial]] 20:01, 18 Nov 2005 (PST)

----

Yup, I was planning on doing something like that later on... We'll have to do it a few times as we introduce more pages, in order to keep everything easy to find.

--[[User:Bomb Bloke|Bomb Bloke]] 20:59, 18 Nov 2005 (PST)

== Offsets 22-29 / 0x16-0x1D ==

They seem to be the same as 2-9 bytes of UnitRef table. After MCD loading they are filled with pointers to appropriate pck/tab.

v60 = &a_mcd_data[result];
v60->field_1A_pck = a_TileSet_Catalog[v_BF_Tileset_Cnt].pck;
v60->field_16_tab = a_TileSet_Catalog[v_BF_Tileset_Cnt].tab;

I've found this the same way as for unit pck/tab pointers.
--[[User:Volutar|Volutar]] 14:27, 21 February 2011 (EST)

== Offset 47 / 0x2F ==

It is set to 1 when the MCD data is used as an opened door tile type. It is only set at runtime when a door is opened. Since MCD data is not saved, this explains the door jam bug that makes the doors stay opened when you reload. You can test that on the medium scout ship: if you open the door to the central reactor room and save/reload, the door will stay stuck. If you now open a door of the same type (and same orientation) and end the turn, the door to the reactor chamber will be closed again on the next turn. [[User:Seb76|Seb76]] 14:18, 13 December 2008 (CST)

== Offset 51 / 0x33 ==

Who said this is LIGHT block?
Game uses this field in calculations of explosion wave permeability, so it apparently should be called "explosion block"
Function at address .text:00417F40 refers to this field and to the table (dimensions is 11x17: 11 block values for 17 levels of intensity) at .data:0046C45C. This function is used for calculation of how much explosion will come from x/y/z to its neighbour x1/y1.
--[[User:Volutar|Volutar]] 14:28, 15 April 2011 (EDT)

It's not that easy as it meets the eye. This function (using field 51) works only for second chained explosion. It doesn't create lot of smoke comparing to original and first chained explosions...

Does anyone have particular observation of such ''non standard'' explosions behaviour?
--[[User:Volutar|Volutar]] 05:55, 16 April 2011 (EDT)

This field indeed was ment to be used for lighing calculation (they were using same function for explosion field calculation and for lighting). But they calceled use of this function for light blocking, I dont know why, maybe its results wasn't very good. Still they've left this "lighting" function and it is used after first chained explosion (original, chained1,(enabling!), chained2, chained3, etc). Results are quite unpredictable, since intensivity more than 16 cause getting out of bounds. If you manage to get to this second chained explosion you may notice it looks weird.

void DoExplosion(x,y,z,intens,radius)
{
isExplosion=1;
ClearChainedExplBuffer();
CalcExplosionLightMap(x,y,z,intense,radius); //<--- depending on isExplosion it calculates damage field or lighting
ApplyExplosionDamage(); //<--- adds chained, if something with flag "HE" got exploded
while(!ChainedExplosionsEOF())
{
GetNextChainedExplosion(&x,&y,&z,&intense,&radius)
CalcExplosionLightMap(x,y,z,intense,radius);
ApplyExplosionDamage();
isExplosion=0; /// <--- WHY??? Obviously a bug
}
isExplosion=0;
}
BTW, there are only 50 chained explosions possible, 51th won't explode.
--[[User:Volutar|Volutar]] 06:41, 16 April 2011 (EDT)

== MCDedit ==

Urgh. MCDedit and support files are gone. Anyone want to put it somewhere more ... permanent? Strategycore files section, for example?
[[User:Knan|Knan]] 21:25, 13 March 2009 (EDT)

:It's been in StrategyCore's files section for years now. [http://www.strategycore.co.uk/files/index.php?dlid=415 Clicky]. :) --[[User:Zombie|Zombie]] 21:52, 13 March 2009 (EDT)

::Right. Only went looking in the Editors section, Maps didn't register on the radar. --[[User:Knan|Knan]] 17:47, 14 March 2009 (EDT)

== Ground with TUs = 0 ==

There are at least 2 ground tiles which consumes 0 TUs to walk through them.
Interesting thing, that pathfinder deny walk directly on them, you can only walk ''through''.
These are 6 and 7 tiles in U_BITS tileset.
--[[User:Volutar|Volutar]] 08:02, 12 October 2011 (EDT)

== Offset 38 (0x26) ==

Zombie: 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.

Where is it "defined"? It's not used in the game code AT ALL. There is no check whether it 3,2 or 1.
What map designer do you mean?

I seems to me as just a fantasy.
--[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 10:34, 19 June 2015 (EDT)

:Before you accuse me of being delusional or making stuff up, consider that I am working directly off of dev comments from part of the ACTUAL C code from UFO which I received recently. It's commented in there plain as day. Whether it is actually used in-game anymore is not a earth shattering concern - providing explanations to the remaining unknowns is what I'm after. The burden of proof lies in testing or code digging to see if it is used or not. (You are more than welcome to provide any additional information you can find out). And before this discussion degrades into a "but you only have it, I can't trust you unless I can see it myself" issue, no, you may not get the C code until I can get it cleared through 2K/Firaxis. --[[User:Zombie|Zombie]] ([[User talk:Zombie|talk]]) 01:08, 20 June 2015 (EDT)
:: I wasn't going to accuse you, it's just... this info is too "out of nowhere" tho _pretty_ detailed, that I suspected it might be the real game source (if I remember correctly they claimed it was simply "lost"). My sources are just reversed exes, tho I tried to dig up through everything I could. Of course they don't contain any comments or var names to figure out something about structure members which actually was "optimized" and thrown away from EXE as not used. Of course initially they must be having some purpose devs quitted eventually. And of course I trust you. Partial tile rendering COULD be used for some volumetric tiles like wheat, and for some reason that concept was rejected. But structure member remains.
--[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 03:45, 20 June 2015 (EDT)

Talk:MCD

2015-06-19T14:34:13Z

Volutar: /* Offset 38 (0x26) */

Talk:MCD

2015-06-19T14:33:55Z

Volutar: /* Offset 38 (0x26) */ new section

MCDEdit

2015-04-06T07:12:02Z

Volutar: /* PCK editor */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).

When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values. Also you can change number of sprites per row when exporting images.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17g (2015-04-06) ([http://volutar.eu5.org/_mcdedit117g.7z download])

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

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

Talk:MCDEdit

2015-04-06T07:10:57Z

Volutar: 1.17g

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
* Added multiple PCKs adding to menu (1,5 and 15)

====2015-02-19 v1.17g====
* PCK Edit:
* Fixed RGBA png import.
* Fixed insert new PCK.
* Added "Settings" menu with PCK sheet margin/spacing options and number of sprites per row for export.

===Wishes===

MCDEdit

2015-04-06T07:08:04Z

Volutar: 1.17g

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row (as default). PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.
You can change spacing between sprites, and margins in ''Edit->Settings...''. It will work for both export to and import from PNG, so pay attention, if you're using non-standard values.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17g (2015-04-06) ([http://volutar.eu5.org/_mcdedit117g.7z download])

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

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

MCDEdit

2015-04-04T17:18:21Z

Volutar: /* Download */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17f (2015-04-04) ([http://volutar.eu5.org/_mcdedit117f.7z download])

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

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

Talk:Инопланетные формы жизни (TFTD)

2015-03-10T16:36:54Z

Volutar:

== Имена пришельцев ==

Насчет переводов имен пришельцев:
* «Аквалангист», на мой взгляд, точнее и более по-русски звучит, чем «акватоид» (хотя можно оставить для сходства с сектоидом, который выглядит похоже);
* «Джиллмен» и «Лобстермен» точно ли лучше использовать в транскрипции, не переводя как «человек-...»?
* «Тасот» — в оригинальном названии в конце там есть «h», то есть «тасотх».
* «Калкинит» — может тогда «Кальцинит»? Имхо красивее звучит.
* «Галлусиноид» — опять же, предлагаю «ц» вместо «с».
* «Тентакулат» — вариант с переводом как «Тентакль» (щупальце) не более красив? Пока непонятно, кто это такой.
* «Трискен» — предлагаю Трисцен или Трисцин согласно комментариям на форуме.
* «Зарквид» — точно так правильнее? По-английски он кажется Ксарквид тогда. --[[User:Farpost|Farpost]] 07:42, 9 August 2010 (EDT)
:Каждый раз спотыкаюсь о "Зарквида" и каждый раз откладываю "на потом".. Я все же за то, чтобы оставить оригинальное звучание названия, т.е. "Ксарквид" --[[User:Ufo.mesh|ufo.mesh]]

Те, кто играли в русскую версию TFTD, привыкли именно к таким названиям. На мой взгляд, в игре названия рас не переводили, а записали транскрипцию русскими буквами, т.е. так, как это произносится в английском.
Предлагаю по всем названиям рас, оружия, кораблей отталкиваться от их названий в русских версиях игр. --[[User:Keloraen|Keloraen]]

:: Tasoth — в русском языке нет звука th (ð). Пусть уж лучше будет тасот.
:: Аквалангист — выбивается из общего ряда.
:: С Кальцинитом, трисценом и ксаргвидом я согласен, так звучит гораздо лучше. Ну и конечно галлюциноид. --[[User:Kildor|Kildor]] 01:44, 10 August 2010 (EDT)

> С Кальцинитом, трисценом и ксаргвидом я согласен, так звучит гораздо лучше. Ну и конечно галлюциноид.
Буква "с" в английском может означать "к" и "с", но не "ц". Думаю, мы переводим не из соображений благозвучности, а исходя из правильного произношения.
:Если не ошибаюсь, то "Triscen" читается как "Триссен", но вторая "с" как бы немного иначе звучит. Но мне почему-то ближе все-таки "Трисцен". Да, иногда "с" читается как "к" (Cthulhu, например), но не в этом случае. --[[User:Ufo.mesh|ufo.mesh]]
И, если не ошибаюсь, нечто подобное со словами, начинающимися на "Х", которая "кс". Такие слова принято переводить, заменяя "кс" на "з". Вспомните Xena=Зена, поэтому Xarquid=Зарквид. --[[User:Keloraen|Keloraen]]
:Что такое Зена? А как же "ксенофобия", "ксерокс"? --[[User:Ufo.mesh|ufo.mesh]]

Гм. Слово «Кальцинит», на мой взгляд, происходит от названия кальций, который по-английски как раз «Calcium».

Трисцен — динозавр, можно перевести по аналогии, как на форуме писали, «Цератопсиды» — англ. «Ceratopsidae», то есть опять же «ц».

Ну и по медузе: «Hallucination» — «Галлюцинация», здесь можно сделать также — Галлюционоид.

Тентакулата не лучше ли тогда перевести как «Тентакль» или «Щупальце»? Слово Тентакулат явно происходит от него.

А чем из общего ряда выбивается аквалангист? По смыслу вроде соответствует, разве что может быть путаница с аквалангистами X-Com. --[[User:Farpost|Farpost]]

У тентакулята не одно щупальце, каждое из которых по отдельности называется «тентакля». Владеет тентаклями тентакулят, все логично :) . --[[User:-=Troll=-|-=Troll=-]] 14:24, 10 August 2010 (EDT)

Всуну свои 2 копейки.
Во-первых изначальный досовский перевод не может считаться эталоном. Во-вторых, "уфопедия" как таковая - сборник наукоподобных знаний, соответственно названия должны транслитирироваться по-латыни (если не переводится): Акватоид, Гиллмен, Тасот, Кальцинит, Галлюциноид, Тентаклит, Трисцен, Ксарквид.--[[User:Volutar|Volutar]] ([[User talk:Volutar|talk]]) 12:36, 10 March 2015 (EDT)

Talk:Инопланетные формы жизни (TFTD)

2015-03-10T16:36:39Z

Volutar: /* Имена пришельцев */

MCDEdit

2015-02-24T19:02:34Z

Volutar: /* Download */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17f (2015-02-24) ([http://volutar.eu5.org/_mcdedit117f.7z download])

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

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

MCDEdit

2015-02-24T19:02:15Z

Volutar: /* Download */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17f (2015-02-14) ([http://volutar.eu5.org/_mcdedit117f.7z download])

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

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

SOUND

2015-02-19T18:29:33Z

Volutar: /* SAMPLE2.CAT */

This directory contains all the sound effects and music.

There are three different versions of UFO sound engine:
* DOS, before 1.4 patch
* DOS, after 1.4 patch
* CE

==Music files==

Music for different soundcards is stored in following files:
* DOS 1.2 - for some reason music for intro is stored in separate file
** ADLIB.CAT, AINTRO.CAT - AdLib and Soundblaster
** ROLAND.CAT, RINTRO.CAT - Roland
* DOS 1.4
** ADLIB.CAT
** GM.CAT - General Midi
** DRIVERS.CAT - not exactly music file. It contains various com files for different soundcards. The appropriate files are extracted by setup, and then wrapped in sndstart.exe/sndend.exe called from main bat file.
* CE - these are just midi files, one for each music sequence

==Sound files==
The sound effects files are:
* DOS 1.2
** INTRO.CAT - intro
** SOUND1.CAT - battlescape
** SOUND2.CAT - geoscape
* DOS 1.4
** SAMPLE.CAT - geoscape
** SAMPLE2.CAT - battlescape
** SAMPLE3.CAT - intro
* CE - uses same files as 1.4. However, no sound is played in intro, only music.

==Differences between versions==
The main difference versions is quality.
* 1.2: 8000 Hz, 6 bit.
* 1.4: 11025 Hz, 8 bit.
* CE: same as 1.4, but it will play .wav files correctly with higher sampling rate hacked into game. - ''Is that what was intended to be said here? - [[User:Phoenix|Phoenix]]'' - '' The files in CE (and 1.4) contain actual waves with headers. CE does not have fixed quality setting, but uses data from those headers. - [[User:Quantifier|Quantifier]]

The other difference are completely new files. Patch leaves old files, but they are no longer used. Most effects sound the same, but some, especially alien death screams have been changed.

==SAMPLE2.CAT==

This following is a list of the sounds as they are arranged in SAMPLE2.CAT with the offset of where in the file they begin and how long each sample is. I have left the reference numbers and offsets in Hex code since this is how the program references them. The offsets are left "as is" so one needs to read them in reverse order (B8 01 is 01B8).--[[User:Morgan525|Tycho]] 03:56, 4 March 2012 (EST)

<nowiki>ref# offset length Description

00 B8 01 02 2B Snakeman slither
01 BD 2C 63 01 not used (empty in 1.2, garbage in 1.4)
02 23 2E 19 2F big gun shot
03 3F 5D 57 19 normal door open
04 99 76 FF 22 rifle/pistol shot
05 9B 99 2B 51 large explosion
06 C9 EA 0C 3E muton scream
07 D8 28 01 B4 33 celatid scream
08 8F 5C 01 61 38 snakeman/silacoid scream
09 F3 94 01 28 2F ethereal/chryssalid scream
0A 1E C4 01 3E 2B sectoid/floater/reaper scream
0B 5F EF 01 43 27 laser shot
OC A5 16 02 A2 39 small explosion
0D 4A 50 02 29 25 ammo hit w/metal thunk
0E 76 75 02 48 2C standard tank move
OF C1 A1 02 64 3C flying movement warble
10 28 DE 02 02 2B celatid move (~snakeman slither)
11 2D 09 03 99 0D reload clicking
12 C9 16 03 8D 2A plasma shot
13 59 41 03 6C 34 laser/plasma hit
14 C8 75 03 1C 33 ufo door open1
15 E7 A8 03 76 21 ufo door open2
16 60 CA 03 97 34 pistol/rifle hit
17 FA FE 03 B0 5B sectopod/cyberdisc scream (machine death)
18 AD 5A 04 55 07 footstep on metal 1
19 05 62 04 66 0A footstep on metal 2
1A 6E 6C 04 AF 06 footstep on ground1
1B 20 73 04 6B 08 footstep on ground2
1C 8E 7B 04 F3 0E footstep on mars1
1D 84 8A 04 F8 0B footstep on mars2
1E 7F 96 04 E3 06 footstep on mud1
1F 65 9D 04 A8 08 footstep on mud2
20 10 A6 04 9F 11 footstep in sand1
21 B2 B7 04 0D 0E footstep in sand2
22 C2 C5 04 D3 09 footstep in snow1
23 98 CF 04 E2 09 footstep in snow2
24 7D D9 04 BA 48 mindcontrol zing
25 3A 22 05 34 59 mindprobe hum
26 71 7B 05 23 09 item drop thunk
27 97 84 05 4E 0B item toss swish
28 E8 8F 05 45 45 hovertank/cyberdisk move hum
29 30 D5 05 64 26 male scream 1
2A 97 FB 05 D9 32 male scream 2
2B 73 2E 06 1E 21 male scream 3
2C 94 4F 06 D9 28 female scream 1
2D 70 78 06 94 20 female scream 2
2E 07 99 06 52 26 female scream 3
2F 5C BF 06 0D 4D rock drag and scraping (silacoid move)
30 6C 0C 07 7A 39 reaper/zombie attack growl
31 E9 45 07 8E 39 chryssalid attack growl
32 7A 7F 07 78 35 Silacoid attack growl
33 F5 B4 07 E9 3A celatid attack scream
34 E1 EF 07 F0 3A rocket launch
35 D4 2A 08 ED 39 blaster bomb/stun launcher
36 C4 64 08 EC 31 zap sound (stun rod)
</nowiki>

==SAMPLE.CAT==
<nowiki>
Ref# Begin Offset Length Description
00 70 00 1B 08 Button push 1
01 8E 08 67 28 Window Close
02 F8 30 7D 11 Window open 1
03 78 42 B8 16 Window open 2
04 33 59 CD 22 Cannon fire
05 03 7C 43 27 Missile launch
06 49 A3 1B 08 Button push 2
07 67 AB 1D 32 FB Launch
08 87 DD 70 2C Laser Cannon
09 FA 09 01 D2 58 Plasma Cannon
0A CF 62 01 CB 26 UFO Hit
0B 9D 89 01 67 57 UFO Explosion
0C 07 E1 01 22 1B X-Com Craft Hit
0D 2C FC 01 52 61 X-com Craft Explosion?
</nowiki>

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

MCDEdit

2015-02-19T04:32:48Z

Volutar:

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with ''Shift'' and ''Ctrl''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17f (2015-02-19) ([http://volutar.eu5.org/_mcdedit117f.7z download])

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

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

MCDEdit

2015-02-19T04:31:25Z

Volutar: /* 1.17f */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with '''Shift''' and '''Ctrl'''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17f (2015-02-19) ([http://volutar.eu5.org/_mcdedit117f.7z download])

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

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

Talk:MCDEdit

2015-02-19T04:29:58Z

Volutar: /* 2015-02-19 v1.17f */

===History===

====2014-04-21 v1.1====
* '''the first public version'''

====2014-04-29 v1.11====
* rearranged main screen - moved loft to the right, in vertical manner (it feels more natural).
* added palette helper with ambiguous colors highlighted.
* 3D LOFT/animation image is now "rotatable" with mouse button held (rotates 3D LOFT model by steps of 45 degrees, and after releasing button - it returns back to 0), the angle can also be changed with the trackbar (it will be kept).
* added gamedata path and the config file.
* added PCK single image/sheet export into the PNG. Saved using current palette.
* added PCK single image import from the PNG. Preferred PNG format - with untouched vanilla palette. PNGs with screwed palette are also imported (as RGBA images), but most probably it could cause color ambiguity. RGB without alpha are ignored.
* added "orphan" PCK color tagging (they are red-yellow). Lots of them can be found in the TFTD.
* added insert of blank PCK, and delete of "orphan" PCK (when trying to delete used one, it will tell you which MCDs are using it). MCD+PCK integrity is kept (other PCKs referenced in other MCDs of same tileset are updated).
* fixed working folder change issue (relative paths were changed after getting into other folder in file selector).

====2014-05-01 v1.12====
* added custom MCD open ("Menu->Open MCD" or with checkbox "Custom").
* in the "Custom mode" you can freely choose gametype, and palette for opened tileset (because it doesn't know what game this tileset for).
* MCD values list externalized into the config file (MCDEdit.txt), each value discription text is given for the data fields.
* vanilla tilesets are now marked with * in the list. They are "most preserved" - adding/deleting of MCDs is disallowed, to keep number of MCD in each tileset intact.
* added "Add MCD" item (adds new MCD at the end).
* "Checkered" background also affects on MCD list view.

====2014-07-22 v1.13====
* compare mode (set with second path in the config).
* PNG sheet import (in the PCK edit screen). Empty sprites at the end are ignored.
* added context menu in the MCD selection bar (the same as in the "Edit" menu).
* added shaded stripe to preview different light levels (with animation on/off by LMB).
* fixed PNG import (system colors of palette was used for TFTD, by mistake).
* added "Edit->Save As".
* improved "Custom MCD" mode with list of neighbour MCDs from same folder and switch to "vanilla mode" if opened the MCD from vanilla folder.

====2014-08-01 v1.14====
* added "modified" asterix sign at the header, and warning message before closing/switching to another tileset without saving.
* added Quick save button.

====2014-08-10 v1.15====
* Added context menu "Edit PCK" for zoomed animation sprites.
* Changed "checkered" to toggle button, reviewed "global" status of it (it's not global in the child windows).
* "Copy MCD" is now works through the clipboard (as text information), so you can copy/paste them between two running copies of MCDEdit.
* Currently selected '''SCANg''' or '''PCK''' is scrolled to view.
* Added "Edit PCKs" at main screen (button at right top). Similar to PCK selection, but in this mode instead choosing of PCK it opens "PCK Editor".
* Added "PCK Edit" window:
** Introducing "Smart drawing" (to skip unnecessary 4-neighbour diagonals).
** Fast motion drawing works with bresenham filling of intermediates.
** Introduced isometric template as grid overlay. Interesting thing, that some vanilla tiles are shifted up by 1 pixel, so you can observe they are slightly off. It's not a bug.
** Introduced UNDO engine for PCK Editor only.
** Introduced preview of 4 adjacent tiles (handy to interactively see how seamless walls/grounds).

====2014-08-17 v1.16====
* Changed text format for text copy/paste of PCKs and selections (now it's more compact).
* PCK editor:
** Undo buffer size is increased up to 500 actions.
** Introduced selection modes: pixel, rectangle, lasso, color. ''Shift'' is to add to selection, ''alt'' is to subtract.
** ''Ctrl+shift+i'' inverts selection (line in Photoshop), ''ctrl+a'' - select all, ''esc'' - clears selection, cursor keys moves selection.
** Color selection mode also works for palette.
** Delete selected (filled with background color of RMB) - ''del'' key, and filling selected (color of LMB) with ''ins'' key.
** Added simple color manipulation for selection: group change (by 16), shade change (by 1), with clamping of values.
** Introduced copy/paste mode (textual form through the clipboard), shortcuts - ''ctrl+c'', ''ctrl+v''.
** Introduced cut action of selection, like in Photoshop (''ctrl''+mouse drag, or ''ctrl''+cursor keys).
** Added "wrap" trigger - it works for scrolling of selections and pasted fragments.

====2014-09-08 v1.16a====
* Fixed bug with edit->paste.
* Fixed bug with transparency for SCANg.
* Optimized animation of shaded stripe.

====2014-09-18 v1.16b====
* Added support of larger PCKs (more than 65536+), by ignoring of TAB indexes. In case of going beyond of that index in TAB, it will warn, but still allows for saving. OpenXcom is capable of loading PCKs with screwed TAB indexes.
* Added checking of PCK count going beyond 256, and MCD count going beyond 255.
* Fixed import of PNG->PCK images, which are using "system" colors (after accidental hit into "forbidden" part).

====2014-12-23 v1.17====

* MCD Edit:
* PCK Selector is now just PCK selector, like LOFT and SCANG, without any other functions (like import/export).
* PCK Selector now caches the sheet image, so it should work faster.
* PCK Selector checkered/palette doesn't affect on respective MCD Edit values, it also increases speed.
* "Edit PCKs" button now opens PCK Editor instead of PCK Selector, with PCK from selected MCD.
* Saving layout: last opened MCD file, selected MCD, PCK, trackbar and positions.
* Shutting down OS now leads to requester with timer, automatically saving if no reaction for 5 seconds.
* MCD file name is now shown without extension (no need to).
* Optimized PCK/MCD list rendering. Now it updates only changed parts.
* When changing animation sprite the MCD Edit can dynamically change "orphan" red tag in opened PCK editor.
* "Repeated" animation PCKs are now checkered-transparent, and values are greyed, so you can see key frames as normal.
* When changing "Key frame" PCK, it also replaces every other "repeated" PCK, so you can change ALL images of static MCD with one click.
* Switching MCD file after making changes in PCKs now asks for saving changes.
* When switching between MCD files it resets current MCD and PCK (if opened) to 0.
* Updated MCD field descriptions.
* PCK Edit:
** Mouseover color palette and colorpicker will show actual color even for tftd system palette part. Though they are still unselectable.
** Window is no longer modal, and having its own taskbar button.
** Added sprite stripe to switch between PCKs, and import/export/copy/paste from context menu.
** Added main menu.
** In "Paste" mode fragment is visually displayed as "hovering" above.
** In "Paste" mode now it's possible to change "foreground"/"background" apply mode (new button).
** Buttons/Controls rearrangement.
** "Enter" - apply current Paste
** "Confirm" checkbox - silently saving changes when switching PCK or closing window.
** Fixed: Insert/Delete didn't update palette "info dots".
** Ctrl+S - saving PCK (the same as "Save to memory").
** Ctrl+X - cut selected fragment.
** Fixed: Ctrl+C/X doesn't clear the clipboard buffer if nothing is selected.
** "Paste" mode now doesn't destroy pixels outside of sprite until applied (you can move beyond the sprite and back).
** Ctrl+D - deselect. Esc as well.
** Shift+Ctrl+D - "Reselect". Selects previously selected area (before it was deselected).
** Dynamic changing status of Undo-Redo and Reselect in Menu.
** First undo (ctrl+Z) was ignored before some delay.
** Ctrl is not necessary to move pasted fragment. Either for cursor keys, or mouse (pointer has to be over it, and it should be paste mode).
** Map preview window with ability to choose every PCK sprite and vertical offset for each.
** Preview map scrolling with control buttons.
** Can select empty sprite, which will get max+1 PCK index upon save.
** When PCK is selected through the preview, it switches into "Show surroundings" mode (hotkey "Q").
** Trigger to disable/enable dots in the center of pixels, representing "covered pixels" (hotkey ",").
** Sprites of surroundings are drawn with purple borders, so you can see where they are overlapping each other.
** "Space" - switch to the PCK from the surrounding (in zoomed view) under mouse pointer.
** Import of Xcom1/2 MAP files as preview, with "mcd offset" value to arrange pck indexes (all indexes out of range are filtered out)
** Added shortcuts F1-F5 for edit/draw mode select, and "'", ";", ".", "," for view mode triggers.
** Fixed mouse pointer changing during popup menues and hold'n'draw.
** Preview map size adjustment dialog window.
** Short click without move clears selection.

====2015-01-28 v1.17a====
* PCK Edit:
** Added "Area selection" (Wand tool), working in 4-connected mode. Shortcut is F5, so Drawing tool shortcut is changed to F6 (from F5).
** Added Shift+Draw for drawing straight/diagonal/isometric lines (fixed angles).

====2015-02-07 v1.17b====
* PCK Edit:
** Added "Show surrounding outlines" button, to hide dotted contours around tiles in "show neighbour" mode. With shortcut "[".

====2015-02-09 v1.17c====
* Added "Append MCD" (File menu) - chosing another MCD file to be added to the end of current (including PCK and all necessary reference values). MCD count shouldn't exceed 255.
* Added command line options, which override corresponding .lyt file values during the start (case sensitive):
-custom_mcd [true/false, if it's custom MCD mode or not]
-game_type [1/2]
-pal_idx [0-4]
-mcd_pref [full path to mcd folder]
-selectedfilename [mcd/pck/tab filename without extension]
-SelectMCD [selected mcd ID]
* Added special file (MCD_Saved.dat), which will receivereach saved file absolute path and filename (without extension).
* RMB click to MCD list doesn't selcet clicked MCD anymore.
* Added multiple MCD selection (shift, ctrl)
* Added delete/clear/copy/paste MCDs throughout selected.
* Paste MCDs works in two modes: 1. Only one MCD is selected during paste - it will override MCDs sequentially from the buffer; 2. Multiple MCDs are selected during paste (as targets) - it will run through selected MCDs and will override them from the buffer, if buffer run out of MCDs - it will start from first in the buffer (so if copy 1, and paste to 10 will clone it);
* When multiple MCDs are selected, it becomes possible to modify values of selected MCDs at once (works only for data values, no SCANG, sprite or LOFT). If values are different throughout the selection, it will show "mix".

====2015-02-10 v1.17d====
* PCK Edit:
** Added multiple PCK selection (shift, ctrl)
** Added deletion of multiple PCKs.

====2015-02-18 v1.17e====
* Added aggregation of SCANG, PCK numbers (animation) and LOFTs for multiple selected MCDs, and multiple modification.
* When there's no multiple selected MCDs, it will paste MCD only for single selection (previously paste worked sequentially).
* PCK Edit:
** More informative PCK deletion error.
** Fixed png import with untouched palette (they were still re-converted for first 16 columnts).
** Added copy/paste into/from clipboard of multiple PCKs
** Added export/import from PNG of multiple PCKs (the way similar to sheet - side by side, 10 in row)

====2015-02-19 v1.17f====
* Added multiple MCDs adding to menu (1,5 and 15)
* PCK Edit:
* Added multiple PCKs adding to menu (1,5 and 15)

===Wishes===

Talk:MCDEdit

2015-02-18T12:22:56Z

Volutar: 1.17e

MCDEdit

2015-02-18T12:10:52Z

Volutar: 1.17e

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
You also can select multiple PCKs with '''Shift''' and '''Ctrl'''. '''RMB''' opens a context menu (''PCK (numbers of selected) / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCKs'').

Selected PCKs are exported as PNG image with sprites of 32x40 pixels size, placed side by side, 10 in row. PNG is saved as 8bit color (with current palette). Color 0 is "invisible". If only one is selected - it will export PCK under the cursor (it can be different from the selected).
When importing an image to a PCK, it runs through selected PCKs, filling them with sprites from PNG image. If number of selected exceeds number of sprites in the PNG, it will start from the 0, thus it will work as cloning.

''Copy to clipboard'' mode works similarly, but it stores selected images as text in the clipboard (it can be even stored as text file).

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17e (2015-02-18) ([http://volutar.eu5.org/_mcdedit117e.7z download])

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

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

MCDEdit

2015-02-09T19:52:52Z

Volutar: /* 1.17d */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCK'').

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

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17d (2015-02-10) ([http://volutar.eu5.org/_mcdedit117d.7z download])

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

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

Talk:MCDEdit

2015-02-09T19:51:55Z

Volutar: /* 2015-02-10 v1.17d */

Talk:MCDEdit

2015-02-09T19:51:30Z

Volutar: /* 2015-02-10 v1.17d */

MCDEdit

2015-02-08T19:30:07Z

Volutar: /* Main screen */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCK'').

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

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17c (2015-02-09) ([http://volutar.eu5.org/_mcdedit117c.7z download])

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

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

MCDEdit

2015-02-08T19:28:17Z

Volutar: /* Controls */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCK'').

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

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''['' - toggle sprite contours.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17c (2015-02-09) ([http://volutar.eu5.org/_mcdedit117c.7z download])

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

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

MCDEdit

2015-02-08T19:22:52Z

Volutar: /* 1.17d */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCK'').

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

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17c (2015-02-09) ([http://volutar.eu5.org/_mcdedit117c.7z download])

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

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

Talk:MCDEdit

2015-02-08T19:22:10Z

Volutar: /* 2015-02-09 v1.17c */

File:Mcdedit pckedit.png

2015-02-07T17:17:14Z

Volutar: Volutar uploaded a new version of "File:Mcdedit pckedit.png"

PCK Editor

MCDEdit

2015-02-07T11:33:52Z

Volutar: /* 1.17b */

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

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

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

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

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

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

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

Slightly lower is the stipe with the 8 zoomed animation frames of this tile. If frame is the same as previous - it displayed pixel-transparent way, and PCK# below is greyed (though it can be edited). '''LMB''' on a particular image opens the ''PCK selection'' screen. If next frames are "greyed", their values are also changed, so it looks like changing "Keyframe". RMB calls for context menu with '''Edit PCK''' entry which opens [[#PCK_editor|PCK editor]] for this frame.

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

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

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

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

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

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

== PCK editor ==
[[File:mcdedit_pckedit.png|400px|thumb|right|PCK edit]]

At the top of this window is the PCK preview/selection line with the bar. Red highlighted PCKs are "orphans" - they aren't used in the MCDs. You can use the mouse wheel to scroll this list, and ''cursor key/home/end/pgup/pgdown'' to change the selected MCD.
'''RMB''' on each PCK opens a context menu (''PCK Edit-info / Copy to clipboard (TXT) / Paste from clipboard (TXT) / Import as PNG / Export as PNG / Insert PCK / Add PCK / Delete PCK'').

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

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

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

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

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

Slightly below of the selection line there's a toolbar where you can '''save changes''' (they will immedately reflect in ''MCD Editor'' screen).
Next to it "mode" buttons: ''Pixel selection'', ''Rectangle selection'', ''Lasso selection'', ''Color selection'', ''Area selection'' and ''Drawing'' mode.

At the right are toggle buttons, for the following from the left to the right: wrap scrolling (makes selections be wrapped when moved over the edge), paste order (when pasted fragments needed be pasted "under"), checkered background, regular pixel grid, isometric template, and show surroundings.

Palette dropdown selector is at the right (you can't change its value with mouse wheel or cursor keys).

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

Palette works as color picker for both '''LMB''' and '''RMB'''. Shift/Alt/Shift+Alt in selection modes are also work. Selected colors are shown as contrast dots at the top left/right corners of the color square. Small dot at the bottom indicates that color is used within current sprite.

Below is the smaller 2x preview of the current sprite, tile sprites of CURRENT preview tile (which coord is displayed at the header), elevation offset, and camera controls.

At the right of the palette is "Confirm" checkbox (saving changes of sprites without confirm window), the color/group modification tool. It changes colors of selected part of sprite either as shadow level (moving colors within color group), or changing the color group itself.
Slightly lower is the preview import/open/save block. With it, you can import Xcom1 map block file (.map), or load/save MCD Editor map preview file (.pmap).
After xcom .map import you can adjust MCD offset for current MCD file, to fit map indexes.

At the bottom right corner is the MAP preview window showing all surroundings. By clicking LMB PCK editor switches into "preview surroundings" mode. Window header shows current map coord and sub-tile index.
In this mode you can edit each of four sub-tiles of current tile, and change their elevation offset. Also in this mode and with "Show surroundings" mode (or with key "Q" down) you will see all surroundings in the main editor window.
Blue dotted outline represents current tile, Red outline is showing "foreground" part (all pixels will be drawn under it). Thin violet contours are showing borders between sprites. You can use "Space" key over the sprite to switch to it.
"Underlayer dots" at the center of each pixel indicate "underlying" hidden pixels.

In the Menu "Preview map resize ..." opens dialog window to manipulate preview map size. White cells represent empty tiles, grey cells are filled with insides. By clicking arrows you will modify "border" of the map. If you will try to crop the map and actual tiles gonna be cleared, it will warn you. At the right part it's Z adjustment.

==== Controls ====
* ''Mouse wheel scrolling'' - change foreground color within color group.
* ''Ctrl+Z'' - undo last action (number of current undo levels are shown in the status bar)
* ''Ctrl+Shift+Z'' - redo actions.
* ''Ctrl+A'' - select all.
* ''Ctrl+D'',''Esc'' - deselect.
* ''Shift+Ctrl+D'' - reselect last selection.
* ''Ctrl+Shift+I'' - invert selection.
* ''Ins'' - fill selected area with foreground (LMB) color.
* ''Del'' - fill selected area with background (RMB) color (ie clears).
* ''Cursor keys'' - move selected area, or pasted fragment. Affected by '''Wrap scrolling''' mode.
* ''LMB Dragging'' - over selected pixels move selected area or pasted fragment. Also affected by '''Wrap scrolling'''.
* ''Enter'' - Apply pasted fragment.
* ''Ctrl+S'' - save sprite into the memory.
* ''Ctrl+X'' - cut selection into the clipboard, as text (same as copy in clipboard + delete).
* ''Ctrl+C'' - copy selection into the clipboard, as text, which is interchangable with '''Copy/Paste as TXT'' from the PCK selection line.
* ''Ctrl+V'' - paste selection. Pasted fragment temporarily is in the "second layer" mode ('''Paste mode''' in the status bar), and can be repositioned with ''ctrl+cursor'' or ''ctrl+lmb drag''. Any other action applies it to the sprite.
* ''Ctrl'' - modifier for '''scissors''' mode: cuts selected part and moves it either by cursor keys, or LMB dragging. Cut area is filled with background (RMB) color. Moved fragment gets into the "Paste mode" and affected by '''Wrap scrolling''' mode. ''Ctrl'' is not necessary to hold to continue dragging.
* ''F1'' - pixel selection.
* ''F2'' - rectangle selection.
* ''F3'' - lasso selection.
* ''F4'' - color selection.
* ''F5'' - area selection.
* ''F6'' - draw mode.
* ''.''(period) - toggle checkered background.
* '''''(single quote) - toggle pixel grid.
* '';''(semicolon) - toggle isometric template.
* '',''(comma) - toggle underlaying dots for preview surroundings.
* ''Q'' - when held, toggle "show surroundings" state.
* ''Space'' - over particular pixel in the edit area switch to this tile (its coord is shown at the right part of status bar), only in surround preview mode.

In selection modes you can use ''Shift'' to add to the selection (cursor gets '+' sign), ''Alt'' to subtract from the selection (cursor gets '-' sign), or both ''Shift+Alt'' to cross-select (deselects outside of the selected area). Without these modifiers selection just renews.

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

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

With ''Shift'' key pressed it will draw lines with fixed angles, aligned by 45°(straight and diagonals) or 26.565° (isometric 1:2 angle).

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

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

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

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

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

= Download =
Current version 1.17b (2015-02-07) ([http://volutar.eu5.org/_mcdedit117a.7b download])

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

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

Talk:MCDEdit

2015-02-07T11:31:38Z

Volutar: /* 2015-02-07 v1.17b */

Talk:MCDEdit

2015-01-28T12:33:55Z

Volutar: /* History 1.17a */