Editing FTEQW Image Tool Documentation

== FTE Image Tool ==
This tool can show info about image files, and convert them into different formats. It can extract textures from bsp and wad files, and create wads, xwads, and mips. It's also used for making cubemaps.<br/><br/>

== Supported Image File Formats ==
*dds
*ktx
*tga
*png (1.6.37)
*bmp + ico
*jpeg (90, 9 series)
*pfm + pbm + pgm + ppm
*psd
*hdr
*astc
*pkm
*exr (unavailable)
*pcx
*lmp
<br/>

==== Supported compressed/interesting pixelformats ====
<pre>
 --L8                   8-bpp
 --L8A8                16-bpp
 --RG8                 16-bpp
 --RGBA16_SF           64-bpp
 --RGBA32_SF          128-bpp
 --A2BGR10             32-bpp
 --B10G11R11_UF        32-bpp
 --RGB565              16-bpp
 --RGBA4444            16-bpp
 --ARGB4444            16-bpp
 --RGBA5551            16-bpp
 --ARGB1555            16-bpp
 --E5BGR9_UF           32-bpp
 --BC1_RGB              4-bpp (requires nvcompress)
 --BC1_RGBA             4-bpp (requires nvcompress)
 --BC2_RGBA             8-bpp (requires nvcompress)
 --BC3_RGBA             8-bpp (requires nvcompress)
 --BC4_R                4-bpp (requires nvcompress)
 --BC5_RG               8-bpp (requires nvcompress)
 --BC6_RGB_UF           8-bpp (requires nvcompress 2.1+)
 --BC6_RGB_SF           8-bpp (requires nvcompress 2.1+)
 --BC7_RGBA             8-bpp (requires nvcompress 2.1+)
 --ASTC_4X4_LDR         8-bpp (requires astcenc)
 --ASTC_5X4_LDR       6.4-bpp (requires astcenc)
 --ASTC_5X5_LDR      5.12-bpp (requires astcenc)
 --ASTC_6X5_LDR      4.27-bpp (requires astcenc)
 --ASTC_6X6_LDR      3.56-bpp (requires astcenc)
 --ASTC_8X5_LDR       3.2-bpp (requires astcenc)
 --ASTC_8X6_LDR      2.67-bpp (requires astcenc)
 --ASTC_10X5_LDR     2.56-bpp (requires astcenc)
 --ASTC_10X6_LDR     2.13-bpp (requires astcenc)
 --ASTC_8X8_LDR         2-bpp (requires astcenc)
 --ASTC_10X8_LDR      1.6-bpp (requires astcenc)
 --ASTC_10X10_LDR    1.28-bpp (requires astcenc)
 --ASTC_12X10_LDR    1.07-bpp (requires astcenc)
 --ASTC_12X12_LDR   0.889-bpp (requires astcenc)
</pre><br/>


== Options ==
There are many command-line switches, but these are the most common:
{| class="wikitable" style="width:100%; background:#999; text-align:center;" cellpadding="4" cellspacing="1"
|-valign="top" style="background:#F8F8F8"
! Option
! Description

|-valign="top" style="background:#F8F8F8"
| -i
| show info

|-valign="top" style="background:#F8F8F8"
| -x
| extract

|-valign="top" style="background:#F8F8F8"
| --ext
| file extension, is useful with wildcards and recursion

|-valign="top" style="background:#F8F8F8"
| -o
| output

|-valign="top" style="background:#F8F8F8"
| --convert
| convert

|-valign="top" style="background:#F8F8F8"
| --nomips
| don't create mip-maps

|-valign="top" style="background:#F8F8F8"
| --premul
| premultiply the alpha channel into the rgb channels

|}<br /><br />

== Example Usage ==
<pre>
show info:
imgtool64 -i *.ktx

compress:
imgtool64 --astc_6x6_ldr [--nomips] --ext ktx in.png [in2.png ...]

compress:
imgtool64 --bc3 [--premul] [--nomips] in.png
	Convert pixel format (to bc3 aka dxt5) before writing to output file.
	
convert:
imgtool64 --convert in.exr
	Convert to different file format, while trying to preserve pixel formats.

merge:
imgtool64 -o output [--cube|--3d|--2darray|--cubearray] [--bc1] foo_*.png
	Convert to different file format, while trying to preserve pixel formats.

recursive:
imgtool64 --auto --astc_6x6_ldr destdir srcdir
	Compresses the files to dds (writing to an optionally different directory)

decompress:
imgtool64 --decompress [--exportmip 0] [--nomips] in.ktx out.png
	Decompresses any block-compressed pixel data.

create mips:
imgtool64 --ext mip [--bc1] [--resize width height] [--exportmip 2] *.dds

create xwad:
imgtool64 --genwadx [--exportmip 2] [--bc1] out.wad srcdir

create wad:
imgtool64 -w [--exportmip 2] out.wad *.mipsrcdir

extract wad:
imgtool64 -x [--ext png] src.wad

extract bsp:
imgtool64 -x [--ext png] src.bsp
</pre>