    
                             Wing Commander Toolbox


The Wing Commander Toolbox provides functionality for creating, editing, or
extracting Wing Commander 1/2/3/Academy/Armada and Privateer 1 game data.


----------------------------------------------------------------------
Wing Commander 1
----------------------------------------------------------------------

The WCToolbox supports the following WC1 file formats:
  BRIEFING, CAMP, COCKPIT, COMM, DISK, DRV, EGA, EXE, FNT, INSTALL, INTRO, MID,
  MIDGAME, MODULE, PAL, PCSHIP, SHIP, SHIPTYPE, TGA, TIM, VGA, WLD

These files can be created or edited using the included library and
applications:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4. It is a fully documented set of
types which provide read and write functionality to many of the game data
formats. Consult the help file for additional information, including the
underlying data structures of the data formats.

* The WCTools.exe is a Windows application which provides functionality to
extract information and assets from data files, and to convert the data to and
from XML.

* The WC1ToolsCmd.exe is a console application which provides various commands
to perform actions on game data files:

DECOMPRESS COMMAND

You can use the "decompress" command to decompress a data file.

  WC1ToolsCmd decompress "source\INTRO.DAT" "destination\INTRO.DAT"

EXTRACT COMMAND

You can use the "extract" command to extract information and assets (images,
music, etc) from a data file.

  WC1ToolsCmd extract OBJECTS.VGA [/encoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "xmlpack" and "xmlunpack" commands to convert a data file to and
from XML.

  WC1ToolsCmd xmlpack BRIEFING.000.xml [/encoding:(code page|name)]
  
  WC1ToolsCmd xmlunpack BRIEFING.000 [/encoding:(code page|name)]

OPTIONS

/encoding    The code page or name of the character encoding of the data file;
             must be a single-byte encoding. Defaults to CP437.


----------------------------------------------------------------------
Wing Commander 2
----------------------------------------------------------------------

The WCToolbox supports the following WC2 file formats:
  ALTINT, ALTSHIPS, CAMP, CAMPAIGN, COMM, DIFFLEVL, DRV, EGA, FNT, GAMEFLOW,
  INCIDENT, INTEL, INTELSHP, MISSILE, MODULE, MUSIC, PAL, PALETTE, PCSHIP,
  SECTOR, SERIES, SHIP, SPEECH, STAR, TIM, VGA

These files can be created or edited using the included library and
applications:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4. It is a fully documented set of
types which provide read and write functionality to many of the game data
formats. Consult the help file for additional information, including the
underlying data structures of the data formats.

* The WCTools.exe is a Windows application which provides functionality to
extract information and assets from data files, and to convert the data to and
from XML.

* The WC2ToolsCmd.exe is a console application which provides various commands
to perform actions on game data files:

ASSEMBLE / DISASSEMBLE COMMANDS

You can use the "assemble" and "disassemble" commands to convert a bytecode file
to and from assembly code.

  WC2ToolsCmd assemble SERIES.S00-Packet005-Container-Plane-Script-Offset.ASM
  
  WC2ToolsCmd disassemble SERIES.S00-Packet005-Container-Plane-Script-Offset.BIN

EXTRACT COMMAND

You can use the "extract" command to extract information and assets (images,
music, etc) from a data file.

  WC2ToolsCmd extract SPEECH.S00 [/encoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "xmlpack" and "xmlunpack" commands to convert a data file to and
from XML.

  WC2ToolsCmd xmlpack COMMUNIC.YOU.xml [/encoding:(code page|name)]
  
  WC2ToolsCmd xmlunpack COMMUNIC.YOU [/encoding:(code page|name)]

OPTIONS

/encoding    The code page or name of the character encoding of the data file;
             must be a single-byte encoding. Defaults to CP437.


----------------------------------------------------------------------
Wing Commander 3
----------------------------------------------------------------------

The WCToolbox supports the following WC3 file formats:
  MVE, PAK, PAL, SHP, TRE

These files can be extracted using the included application:

* The WC3ToolsCmd.exe is a console application which provides various commands
to perform actions on game data files:

HELP COMMAND

You can use the "help" command to view detailed information about a command.

  WC3ToolsCmd help <command name>

EXMOVIE COMMAND

You can use the "exmovie" command to extract a video from a movie (MVE) file.

  WC3ToolsCmd exmovie source [destination] [/gamma:value]

EXPACK COMMAND

You can use the "expack" command to extract the files from a pack (PAK) file.

  WC3ToolsCmd expack source [destination]

EXPALETTE COMMAND

You can use the "expalette" command to extract an image from a palette (PAL)
file.

  WC3ToolsCmd expalette source [destination] [/format:(BMP|GIF|PNG|TIF)]
                        [/gamma:value]

EXSHAPE COMMAND

You can use the "exshape" command to extract the images from a shape (SHP) file.

  WC3ToolsCmd exshape source [destination] [/format:(BMP|GIF|PNG|TIF)]
                      /palette:image

EXTREE COMMAND

You can use the "extree" command to extract the files from a tree (TRE) archive.

  WC3ToolsCmd extree source [destination] [/hashes:text]

OPTIONS

/format      Specifies the image format for the image. Defaults to PNG.

/gamma       Specifies the gamma adjustment value. Defaults to 80; use -1 for
             no adjustment.

/hashes      Specifies the text file to use for resolving file name hashes.

/palette     Specifies the image file to use as the color palette; must be
             an 8-bit (256 colors) indexed image.


----------------------------------------------------------------------
Wing Commander Academy
----------------------------------------------------------------------

The WCToolbox supports the following WCAcad file formats:
  COMM, CREDIT, DISPLAY, DRV, HOTRECT, INTEL, INTELSHP, MISSILE, MUSIC, PALETTE,
  PCSHIP, SHIP, TIM, XSHIP, WAVEINFO

These files can be created or edited using the included library and
applications:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4. It is a fully documented set of
types which provide read and write functionality to many of the game data
formats. Consult the help file for additional information, including the
underlying data structures of the data formats.

* The WCTools.exe is a Windows application which provides functionality to
extract information and assets from data files, and to convert the data to and
from XML.

* The WCAcadToolsCmd.exe is a console application which provides various
commands to perform actions on game data files:

EXTRACT COMMAND

You can use the "extract" command to extract information and assets (images,
music, etc) from a data file.

  WCAcadToolsCmd extract INTELSHP.050 [/encoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "xmlpack" and "xmlunpack" commands to convert a data file to and
from XML.

  WCAcadToolsCmd xmlpack WAVEINFO.DAT.xml [/encoding:(code page|name)]
  
  WCAcadToolsCmd xmlunpack WAVEINFO.DAT [/encoding:(code page|name)]

OPTIONS

/encoding    The code page or name of the character encoding of the data file;
             must be a single-byte encoding. Defaults to CP437.


----------------------------------------------------------------------
Wing Commander Armada
----------------------------------------------------------------------

The WCToolbox supports the following WCArm file formats:
  IFF, PAK, PAL, SHP, TEP, TRE

These files can be created or edited using the included application:

* The WCArmToolsCmd.exe is a console application which provides various commands
to perform actions on game data files:

HELP COMMAND

You can use the "help" command to view detailed information about a command.

  WCArmToolsCmd help <command name>

UNMAKE COMMAND

You can use the "unmake" command to reverse a variety of files (IFF, PAL, etc)
into a custom format.

  WCArmToolsCmd unmake source [destination] [/encoding:(code page|name)]
                       /template:(Interchange|Palette)

To recreate these files, use the supplied external XMIFF program. It is an old
DOS program which will need to be runned through DOSBox.

  XMIFF source [target]

PACK / UNPACK COMMANDS

You can use the "pack" and "unpack" commands to create a pack (PAK) file from
imported files, or reverse a pack file into exported files.

  WCArmToolsCmd pack script
  
  WCArmToolsCmd unpack source [destination]

Script Rules:
    file <filename>
        Each file to import.
    flag <value>
        The flag value indicating the format of the packet.
    outputfile <filename.pak>

PALETTE / UNPALETTE COMMANDS

You can use the "palette" and "unpalette" commands to create a palette (PAL)
file from an image, or reverse a palette file into an image.

  WCArmToolsCmd palette script

  WCArmToolsCmd unpalette source [destination] [/format:(BMP|GIF|PNG|TIF)]

Script Rules:
    composite <start> <count>
        The start index and the color count of a composite palette.
    inputfile <filename>
        The image file to use as the color palette; must be an 8-bit indexed
        image.
    outputfile <filename.pal>

SHAPE / UNSHAPE COMMANDS

You can use the "shape" and "unshape" commands to create a shape (SHP) file from
encoded images, or reverse a shape file into decoded images.

  WCArmToolsCmd shape script
  
  WCArmToolsCmd unshape source [destination] [/format:(BMP|GIF|PNG|TIF)]
                        /palette:image

Script Rules:
    inputfile <filename>
        Each image to encode; must be an 8-bit indexed image.
    outputfile <filename.shp>
    origin <x> <y>
        The xy-coordinates of the image origin.
    transparent <index>
        The image color palette index of the transparent color.

FONT / UNFONT COMMANDS

You can use the "font" and "unfont" commands to create a font shape (SHP) file
from encoded images, or reverse a font shape file into decoded images.

  WCArmToolsCmd font script
  
  WCArmToolsCmd unfont source [destination] [/format:(BMP|GIF|PNG|TIF)]
                       /palette:image

Script Rules:
    inputfile <filename>
        Each image to encode; must be an 8-bit indexed image.
    norectangularregion
        Clears the rectangular region.
    notransparent
        Clears the transparent color.
    outputfile <filename.shp>
    origin <x> <y>
        The xy-coordinates of the image origin.
    rectangularregion <x> <y> <width> <height>
        The rectangular region of the image.
    transparent <index>
        The image color palette index of the transparent color.

TEXTURE / UNTEXTURE COMMANDS

You can use the "texture" and "untexture" commands to create a texture (TEP)
file from images, or reverse a texture file into images.

  WCArmToolsCmd texture script
  
  WCArmToolsCmd untexture source [destination] [/format:(BMP|GIF|PNG|TIF)]
                          /palette:image

Script Rules:
    inputfile <filename>
        Each image to encode; must be an 8-bit indexed image.
    norectangularregion
        Clears the rectangular region.
    outputfile <filename.shp>
    rectangularregion <x> <y> <width> <height>
        The rectangular region of the image.

TREE / UNTREE COMMANDS

You can use the "tree" and "untree" commands to create a tree (TRE) file from
imported files, or reverse a tree file into exported files.

  WCArmToolsCmd tree script

  WCArmToolsCmd untree source [destination]

Script Rules:
    file <filename>
        Each file to import.
    outputfile <filename.tre>
    padding <filename>
        Spacing before the file content.

OPTIONS

/encoding    The code page or name of the character encoding of the data file;
             must be a single-byte encoding. Defaults to CP437.

/format      Specifies the image format for the image. Defaults to PNG.

/palette     Specifies the image file to use as the color palette; must be
             an 8-bit (256 colors) indexed image.

/template    Specifies the reversing template to use.


----------------------------------------------------------------------
Privateer 1
----------------------------------------------------------------------

The WCToolbox supports the following Priv1 file formats:
  IFF, PAK, PAL, PFC, SHP, TRE, VPF, VPK

These files can be created or edited using the included application:

* The Priv1ToolsCmd.exe is a console application which provides various commands
to perform actions on game data files:

HELP COMMAND

You can use the "help" command to view detailed information about a command.

  Priv1ToolsCmd help <command name>

UNMAKE COMMAND

You can use the "unmake" command to reverse a variety of files (IFF, PFC, etc)
into a custom format.

  Priv1ToolsCmd unmake source [destination] [/encoding:(code page|name)]
                       /template:(Conversation|Interchange|Palette)

To recreate these files, use the supplied external XMIFF program. It is an old
DOS program which will need to be runned through DOSBox.

  XMIFF source [target]

PACK / UNPACK COMMANDS

You can use the "pack" and "unpack" commands to create a pack (PAK) file from
imported files, or reverse a pack file into exported files.

  Priv1ToolsCmd pack script
  
  Priv1ToolsCmd unpack source [destination]

Script Rules:
    file <filename>
        Each file to import.
    flag <value>
        The flag value indicating the format of the packet.
    outputfile <filename.pak>

PALETTE / UNPALETTE COMMANDS

You can use the "palette" and "unpalette" commands to create a palette (PAL)
file from an image, or reverse a palette file into an image.

  Priv1ToolsCmd palette script

  Priv1ToolsCmd unpalette source [destination] [/format:(BMP|GIF|PNG|TIF)]

Script Rules:
    composite <start> <count>
        The start index and the color count of a composite palette.
    inputfile <filename>
        The image file to use as the color palette; must be an 8-bit indexed
        image.
    outputfile <filename.pal>

SHAPE / UNSHAPE COMMANDS

You can use the "shape" and "unshape" commands to create a shape (SHP) file from
encoded images, or reverse a shape file into decoded images.

  Priv1ToolsCmd shape script
  
  Priv1ToolsCmd unshape source [destination] [/format:(BMP|GIF|PNG|TIF)]
                        /palette:image

Script Rules:
    inputfile <filename>
        Each image to encode; must be an 8-bit indexed image.
    outputfile <filename.shp>
    origin <x> <y>
        The xy-coordinates of the image origin.
    transparent <index>
        The image color palette index of the transparent color.
    packformat
        Changes the format of the file to a pack file.
    globalpalette
    trailing <value>
        An unknown value trailing the global palette.

TEMPLATE / UNTEMPLATE COMMANDS

You can use the "template" and "untemplate" commands to create a template (TPL)
file from an encoded image, or reverse a template file into a decoded image.

  Priv1ToolsCmd template script
  
  Priv1ToolsCmd untemplate source [destination] [/format:(BMP|GIF|PNG|TIF)]

Script Rules:
    inputfile <filename>
        The image to encode; must be an 8-bit indexed image.
    outputfile <filename.shp>
    offset <x> <y>
        The xy-coordinates of the image offset.

TREE / UNTREE COMMANDS

You can use the "tree" and "untree" commands to create a tree (TRE) file from
imported files, or reverse a tree file into exported files.

  Priv1ToolsCmd tree script

  Priv1ToolsCmd untree source [destination]

Script Rules:
    file <filename>
        Each file to import.
    outputfile <filename.tre>
    padding <filename>
        Spacing before the file content.

OPTIONS

/encoding    The code page or name of the character encoding of the data file;
             must be a single-byte encoding. Defaults to CP437.

/format      Specifies the image format for the image. Defaults to PNG.

/palette     Specifies the image file to use as the color palette; must be
             an 8-bit (256 colors) indexed image.

/template    Specifies the reversing template to use.


----------------------------------------------------------------------
Wing Commander
----------------------------------------------------------------------

The WCToolbox also provides functionality which is not specific to any
particular WC game. These files can be manipulated using the included
application:

* The WCToolsCmd.exe is a console application which provides various commands
to perform common actions on files:

HELP COMMAND

You can use the "help" command to view detailed information about a command.

  WCToolsCmd help <command name>

PALEXPORT COMMAND

You can use the "palexport" command to export the color palette of an image.

  WCToolsCmd palexport source [destination] [/format:(BMP|GIF|PNG|TIF)]
                       [/layout:(grid|linear)]

PALREMAP COMMAND

You can use the "palremap" command to convert the colors of an image to a
different color palette.

  WCToolsCmd palremap source [destination] [/format:(BMP|GIF|PNG|TIF)]
                      /palette:image

OPTIONS

/format      Specifies the image format for the image.

/layout      Specifies the layout of the colors.

/palette     Specifies the image file to use as the color palette; must be
             an 8-bit (256 colors) indexed image.
