diff --git a/README.MD b/README.MD index afd08024..1c094b6d 100644 --- a/README.MD +++ b/README.MD @@ -14,7 +14,7 @@ For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/S ## InfoPrint -**InfoPrint** is a reference implementation for the library, packaged as a standalone executable for all supported platforms. It will attempt to detect and display information about many supported file types, optionally both hashing the file and outputting the information to a JSON file (.NET Core 3.1 and above only). +**InfoPrint** is a reference implementation for the deserialization and printing features of the library, packaged as a standalone executable for all supported platforms. It will attempt to detect and display information about many supported file types, optionally both hashing the file and outputting the information to a JSON file (.NET Core 3.1 and above only). ``` InfoPrint file|directory ... @@ -26,6 +26,48 @@ Options: -j, --json Print info as JSON ``` +## ExtractionTool + +**ExtractionTool** is a reference implementation for the extraction features of the library, packaged as a standalone executable for all supported platforms. It will attempt to detect and extract many supported file types. See the table below for supported extraction functionality. + +``` +ExtractionTool.exe file|directory ... + +Options: +-?, -h, --help Display this help text and quit +-d, --debug Enable debug mode +-o, --outdir [PATH] Set output path for extraction (required) +``` + +| Format Name | Notes | +| --- | --- | +| 7-zip archive | .NET Framework 4.6.2 and greater | +| BFPK custom archive format | | +| bzip2 archive | .NET Framework 4.6.2 and greater | +| Compound File Binary (CFB) | Only CFB common pieces extractable. .NET Framework 4.0 and greater | +| gzip archive | | +| Half-Life Game Cache File (GCF) | | +| Half-Life Level (BSP) | | +| Half-Life Package File (PAK) | | +| Half-Life Texture Package File (WAD3) | | +| Half-Life 2 Level (VBSP) | | +| InstallShield Archive V3 (Z) | | +| InstallShield CAB | Currently not working | +| Microsoft cabinet file | Does not support LZX or Quantum compression | +| Microsoft LZ-compressed files | KWAJ, QBasic, and SZDD variants | +| MoPaQ game data archive (MPQ) | Currently not working. Windows only. .NET Framework 4.5.2 and above | +| New Exectuable | Currently not working. Wise installer only | +| NovaLogic Game Archive Format (PFF) | | +| PKZIP and derived files (ZIP, etc.) | .NET Framework 4.6.2 and greater | +| Portable Executable | Embedded archives and executables in the resources and overlay, CExe-packed data, SFX archives (7-zip, PKZIP, and RAR), and Wise installer. Same restrictions apply to SFX archives as standalone variants. | +| Quantum archive (Q) | Currently not working | +| RAR archive (RAR) | .NET Framework 4.6.2 and greater | +| SGA game archive | | +| Tape archive (TAR) | | +| Valve Package File (VPK) | | +| XBox Package File (XZP) | | +| xz archive (XZ) | .NET Framework 4.6.2 and greater | + ## Interfaces Below is a table representing the various conversion interfaces that are implemented within this library.