    
                             Wing Commander Toolbox


The Wing Commander Toolbox provides functionality for creating, editing, or
extracting Wing Commander 1/2/3/4/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 application:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4.6. 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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "WC1:PC:Help" command to view detailed information about a
command.

  WCToolsCmd WC1:PC:Help [command name]

DECOMPRESS COMMAND

You can use the "WC1:PC:Decompress" command to decompress a data file.

  WCToolsCmd WC1:PC:Decompress source destination

EXTRACT COMMAND

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

  WCToolsCmd WC1:PC:Extract source [destination]
             [-TextEncoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "WC1:PC:XmlPack" and "WC1:PC:XmlUnpack" commands to convert a
data file to and from XML.

  WCToolsCmd WC1:PC:XmlPack source [destination]
             [-TextEncoding:(code page|name)]
  
  WCToolsCmd WC1:PC:XmlUnpack source [destination]
             [-TextEncoding:(code page|name)]

OPTIONS

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


----------------------------------------------------------------------
Wing Commander 1 on the 3DO console (Super Wing Commander)
----------------------------------------------------------------------

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

HELP COMMAND

You can use the "WC1:3DO:Help" command to view detailed information about a
command.

  WCToolsCmd WC1:3DO:Help [command name]

EXTRACTDIRECTORY COMMAND

You can use the "WC1:3DO:ExtractDirectory" command to extract all the files from
a directory archive.

  WCToolsCmd WC1:3DO:ExtractDirectory source [destination]


----------------------------------------------------------------------
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 application:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4.6. 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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "WC2:PC:Help" command to view detailed information about a
command.

  WCToolsCmd WC2:PC:Help [command name]

ASSEMBLE / DISASSEMBLE COMMANDS

You can use the "WC2:PC:Assemble" and "WC2:PC:Disassemble" commands to convert a
bytecode file to and from assembly code.

  WCToolsCmd WC2:PC:Assemble source [destination]
  
  WCToolsCmd WC2:PC:Disassemble source [destination]

EXTRACT COMMAND

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

  WCToolsCmd WC2:PC:Extract source [destination]
             [-TextEncoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "WC2:PC:XmlPack" and "WC2:PC:XmlUnpack" commands to convert a
data file to and from XML.

  WCToolsCmd WC2:PC:XmlPack source [destination]
             [-TextEncoding:(code page|name)]
  
  WCToolsCmd WC2:PC:XmlUnpack source [destination]
             [-TextEncoding:(code page|name)]

OPTIONS

-TextEncoding     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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "WC3:PC:Help" command to view detailed information about a
command.

  WCToolsCmd WC3:PC:Help [command name]

EXTRACTAUDIO COMMAND

You can use the "WC3:PC:ExtractAudio" command to extract the audio from a
profile sound (IFF) file.

  WCToolsCmd WC3:PC:ExtractAudio source [destination]

EXTRACTFRAME COMMAND

You can use the "WC3:PC:ExtractFrame" command to extract all the frames from a
movie (MVE) file.

  WCToolsCmd WC3:PC:ExtractFrame source [destination] [-GammaAdjustment:value]
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTMOVIE COMMAND

You can use the "WC3:PC:ExtractMovie" command to extract all the videos from a
movie (MVE) file.

  WCToolsCmd WC3:PC:ExtractMovie source [destination] [-GammaAdjustment:value]

EXTRACTPACK COMMAND

You can use the "WC3:PC:ExtractPack" command to extract all the packets from a
pack (PAK) file.

  WCToolsCmd WC3:PC:ExtractPack source [destination]

EXTRACTPALETTE COMMAND

You can use the "WC3:PC:ExtractPalette" command to extract an image from a
palette (PAL) file.

  WCToolsCmd WC3:PC:ExtractPalette source [destination] [-GammaAdjustment:value]
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTSHAPE COMMAND

You can use the "WC3:PC:ExtractShape" command to extract all the images from a
shape (SHP) file.

  WCToolsCmd WC3:PC:ExtractShape source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTSUBTITLE COMMAND

You can use the "WC3:PC:ExtractSubtitle" command to extract all the subtitles
from a movie (MVE) file.

  WCToolsCmd WC3:PC:ExtractSubtitle source [destination]
             [-TextEncoding:(code page|name)]

EXTRACTTREE COMMAND

You can use the "WC3:PC:ExtractTree" command to extract all the files from a
tree (TRE) archive.

  WCToolsCmd WC3:PC:ExtractTree source [destination] [-HashMappingFile:text]

MAKEPACK / UNMAKEPACK COMMANDS

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

  WCToolsCmd WC3:PC:MakePack script
  
  WCToolsCmd WC3:PC:UnmakePack source [destination]

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

OPTIONS

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

-HashMappingFile  Specifies the text file to use for resolving file name hashes.

-ImageFormat      Specifies the image format for the image. Defaults to PNG.

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

-TextEncoding     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 on the 3DO console
----------------------------------------------------------------------

The WCToolbox supports the following WC3 file formats:
  BUN, STR

These files can be extracted using the included application:

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

HELP COMMAND

You can use the "WC3:3DO:Help" command to view detailed information about a
command.

  WCToolsCmd WC3:3DO:Help [command name]

EXTRACTBUNDLE COMMAND

You can use the "WC3:3DO:ExtractBundle" command to extract all the files from a
bundle (BUN) archive.

  WCToolsCmd WC3:3DO:ExtractBundle source [destination] [-HashMappingFile:text]

EXTRACTSTREAM COMMAND

You can use the "WC3:3DO:ExtractStream" command to extract all the files from a
stream (STR) archive.

  WCToolsCmd WC3:3DO:ExtractStream source [destination] [-HashMappingFile:text]

OPTIONS

-HashMappingFile  Specifies the text file to use for resolving file name hashes.


----------------------------------------------------------------------
Wing Commander 3 on the PlayStation console
----------------------------------------------------------------------

The WCToolbox supports the following WC3 file formats:
  LIB, TAI

These files can be extracted using the included application:

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

HELP COMMAND

You can use the "WC3:PSX:Help" command to view detailed information about a
command.

  WCToolsCmd WC3:PSX:Help [command name]

EXTRACTAUDIO COMMAND

You can use the "WC3:PSX:ExtractAudio" command to extract audio from a sound
(TAI) file.

  WCToolsCmd WC3:PSX:ExtractAudio source [destination]
             [-SampleRate:(<11025>|22050)]

EXTRACTLIBRARY COMMAND

You can use the "WC3:PSX:ExtractLibrary" command to extract all the files from a
library (LIB) archive.

  WCToolsCmd WC3:PSX:ExtractLibrary source [destination]

OPTIONS

-SampleRate       Specifies the sampling rate of the audio. Defaults to 11025, 
                  which is used for inflight sounds; use 22050 for gameflow
                  sounds.


----------------------------------------------------------------------
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 application:

* The library (BeBe.WCToolbox.Engines.dll) provides an application programming
interface for the Microsoft .NET Framework v4.6. 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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "WCAcad:PC:Help" command to view detailed information about a
command.

  WCToolsCmd WCAcad:PC:Help [command name]

EXTRACT COMMAND

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

  WCToolsCmd WCAcad:PC:Extract source [destination]
             [-TextEncoding:(code page|name)]

XMLPACK / XMLUNPACK COMMANDS

You can use the "WCAcad:PC:XmlPack" and "WCAcad:PC:XmlUnpack" commands to
convert a data file to and from XML.

  WCToolsCmd WCAcad:PC:XmlPack source [destination]
             [-TextEncoding:(code page|name)]
  
  WCToolsCmd WCAcad:PC:XmlUnpack source [destination]
             [-TextEncoding:(code page|name)]

OPTIONS

-TextEncoding     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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "WCArm:PC:Help" command to view detailed information about a
command.

  WCToolsCmd WCArm:PC:Help [command name]

EXTRACTFONT COMMAND

You can use the "WCArm:PC:ExtractFont" command to extract an image from a font
shape (SHP) file.

  WCToolsCmd WCArm:PC:ExtractFont source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTSHAPE COMMAND

You can use the "WCArm:PC:ExtractShape" command to extract all the images from a
shape (SHP) file.

  WCToolsCmd WCArm:PC:ExtractShape source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTTEXTURE COMMAND

You can use the "WCArm:PC:ExtractTexture" command to extract all the images from
a texture (TEP) file.

  WCToolsCmd WCArm:PC:ExtractTexture source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

UNMAKEDATA COMMAND

You can use the "WCArm:PC:UnmakeData" command to reverse a variety of files
(IFF, etc) into a custom format.

  WCToolsCmd WCArm:PC:UnmakeData source [destination]
             [-Template:(<Interchange>)]
             [-TextEncoding:(code page|name)]

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]

MAKEFONT / UNMAKEFONT COMMANDS

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

  WCToolsCmd WCArm:PC:MakeFont script
  
  WCToolsCmd WCArm:PC:UnmakeFont source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

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.
    origin <x> <y>
        The xy-coordinates of the image origin.
    outputfile <filename.shp>
    rectangularregion <x> <y> <width> <height>
        The rectangular region of the image.
    transparent <index>
        The image color palette index of the transparent color.

MAKESHAPE / UNMAKESHAPE COMMANDS

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

  WCToolsCmd WCArm:PC:MakeShape script
  
  WCToolsCmd WCArm:PC:UnmakeShape source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

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

MAKETEXTURE / UNMAKETEXTURE COMMANDS

You can use the "WCArm:PC:MakeTexture" and "WCArm:PC:UnmakeTexture" commands to create a texture (TEP)
file from images, or reverse a texture file into images.

  WCToolsCmd WCArm:PC:MakeTexture script
  
  WCToolsCmd WCArm:PC:UnmakeTexture source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

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.

OPTIONS

-ImageFormat      Specifies the image format for the image. Defaults to PNG.

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

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


----------------------------------------------------------------------
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 WCToolsCmd.exe is a console application which provides various commands to
perform actions on game data files:

HELP COMMAND

You can use the "Priv1:PC:Help" command to view detailed information about a
command.

  WCToolsCmd Priv1:PC:Help [command name]

EXTRACTPACK COMMAND

You can use the "Priv1:PC:ExtractPack" command to extract all the packets from a
pack (PAK) file.

  WCToolsCmd Priv1:PC:ExtractPack source [destination]

EXTRACTPALETTE COMMAND

You can use the "Priv1:PC:ExtractPalette" command to extract an image from a
palette (PAL) file.

  WCToolsCmd Priv1:PC:ExtractPalette source [destination]
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTSHAPE COMMAND

You can use the "Priv1:PC:ExtractShape" command to extract all the images from a
shape (SHP) file.

  WCToolsCmd Priv1:PC:ExtractShape source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTTEMPLATE COMMAND

You can use the "Priv1:PC:ExtractTemplate" command to extract an image from a
template (TPL) file.

  WCToolsCmd Priv1:PC:ExtractTemplate source [destination]
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

EXTRACTTREE COMMAND

You can use the "Priv1:PC:ExtractTree" command to extract all the files from a
tree (TRE) archive.

  WCToolsCmd Priv1:PC:ExtractTree source [destination]

UNMAKEDATA COMMAND

You can use the "Priv1:PC:UnmakeData" command to reverse a variety of files
(IFF, PAL, PFC, etc) into a custom format.

  WCToolsCmd Priv1:PC:UnmakeData source [destination]
             [-Template:(Conversation|<Interchange>|Palette)]
             [-TextEncoding:(code page|name)]

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]

MAKEPACK / UNMAKEPACK COMMANDS

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

  WCToolsCmd Priv1:PC:MakePack script
  
  WCToolsCmd Priv1:PC:UnmakePack source [destination]

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

MAKEPALETTE / UNMAKEPALETTE COMMANDS

You can use the "Priv1:PC:MakePalette" and "Priv1:PC:UnmakePalette" commands to
create a palette (PAL) file from an image, or reverse a palette file into an
image.

  WCToolsCmd Priv1:PC:MakePalette script

  WCToolsCmd Priv1:PC:UnmakePalette source [destination]
             [-ImageFormat:(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>

MAKESHAPE / UNMAKESHAPE COMMANDS

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

  WCToolsCmd Priv1:PC:MakeShape script
  
  WCToolsCmd Priv1:PC:UnmakeShape source [destination] -PaletteFile:image
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

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

MAKETEMPLATE / UNMAKETEMPLATE COMMANDS

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

  WCToolsCmd Priv1:PC:MakeTemplate script
  
  WCToolsCmd Priv1:PC:UnmakeTemplate source [destination]
             [-ImageFormat:(BMP|GIF|<PNG>|TIF)]

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

MAKETREE / UNMAKETREE COMMANDS

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

  WCToolsCmd Priv1:PC:MakeTree script

  WCToolsCmd Priv1:PC:UnmakeTree source [destination]

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

OPTIONS

-ImageFormat      Specifies the image format for the image. Defaults to PNG.

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

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

