SabreTools.Serialization 1.9.1

dotnet add package SabreTools.Serialization --version 1.9.1
                    
NuGet\Install-Package SabreTools.Serialization -Version 1.9.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SabreTools.Serialization" Version="1.9.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SabreTools.Serialization" Version="1.9.1" />
                    
Directory.Packages.props
<PackageReference Include="SabreTools.Serialization" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SabreTools.Serialization --version 1.9.1
                    
#r "nuget: SabreTools.Serialization, 1.9.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SabreTools.Serialization@1.9.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SabreTools.Serialization&version=1.9.1
                    
Install as a Cake Addin
#tool nuget:?package=SabreTools.Serialization&version=1.9.1
                    
Install as a Cake Tool

SabreTools.Serialization

Build and Test

This library comprises of serializers that both read and write from files and streams to the dedicated models as well as convert to and from the common internal models. This library is partially used by the current parsing and writing code but none of the internal model serialization is used.

Find the link to the Nuget package here.

The following non-project libraries (or ports thereof) are used for file handling:

  • SharpCompress - Common archive format extraction
  • StormLibSharp - MoPaQ extraction [Unused in .NET Framework 2.0/3.5/4.0, non-Windows, and non-x86 builds due to Windows-specific libraries]

The following projects have influenced this library:

  • libmspack - Documentation around the MS-CAB format and associated compression methods.
  • Unshield - InstallShield CAB extraction tool that influenced internal handling

Releases

For the most recent stable build, download the latest release here: Releases Page

For the latest WIP build here: Rolling Release

InfoPrint

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 <options> file|directory ...

Options:
-?, -h, --help           Display this help text and quit
-d, --debug              Enable debug mode
-c, --hash               Output file hashes
-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 <options> 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
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 Embedded archives and executables in the overlay and Wise installer
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
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.

Interface Name Source Type Destination Type
IByteDeserializer byte[]? Model
IByteSerializer Model byte[]?
IFileDeserializer string? path Model
IFileSerializer Model string? path
IModelSerializer Model Model
IStreamDeserializer Stream? Model
IStreamSerializer Model Stream?
IStringDeserializer string? representation Model
IStringSerializer Model string? representation

Below is a table representing the various non-conversion interfaces that are implemented within this library.

Interface Name Purpose
IExtractable Marks a wrapper as able to be extracted
IPrinter Provides a formatted output for a model
IWrapper / IWrapper<T> Wraps a model or set of models to provide additional functionality

Namespaces

Below is a table of all namespaces within the library and what they represent

Namespace Description
SabreTools.Serialization.CrossModel Convert between models; mainly used for metadata files converting to and from a common, Dictionary-based model
SabreTools.Serialization.Deserializers Convert from external sources to models
SabreTools.Serialization.Printers Export model information in a formatted manner
SabreTools.Serialization.Serializers Convert from models to external sources
SabreTools.Serialization.Wrappers Classes that wrap serialization and models to allow for including extension properties
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net20 is compatible.  net35 is compatible.  net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 is compatible.  net46 was computed.  net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 is compatible.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on SabreTools.Serialization:

Package Downloads
UnshieldSharp

Port of Unshield and unshieldv3 to C#

WiseUnpacker

Wise installer unpacker based on E_WISE and HWUN

BurnOutSharp

Protection scanning library

BinaryObjectScanner

Protection scanning library

SabreTools.Printing

Pretty-printing library for various models

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on SabreTools.Serialization:

Repository Stars
SabreTools/MPF
Redumper/Aaru/DiscImageCreator GUI in C#
SabreTools/SabreTools
DAT management tool with advanced editing and sorting features
SabreTools/BinaryObjectScanner
C# protection, packer, and archive scanning library
Version Downloads Last Updated
1.9.1 0 9/6/2025
1.9.0 123 9/2/2025
1.8.7 403 5/19/2025
1.8.6 1,589 12/31/2024
1.8.5 183 12/31/2024
1.8.4 1,442 12/18/2024
1.8.3 290 12/13/2024
1.8.2 154 12/10/2024
1.8.1 1,687 12/3/2024
1.8.0 586 12/1/2024
1.7.6 1,072 11/21/2024
1.7.5 651 11/16/2024
1.7.4 2,259 11/14/2024
1.7.3 146 11/14/2024
1.7.2 161 11/14/2024
1.7.1 156 11/14/2024
1.7.0 395 11/13/2024
1.6.9 1,657 10/31/2024
1.6.8 2,761 10/1/2024
1.6.7 4,102 6/13/2024
1.6.6 228 6/2/2024
1.6.5 3,635 5/15/2024
1.6.4 207 5/15/2024
1.6.3 343 5/7/2024
1.6.2 193 5/7/2024
1.6.1 357 4/28/2024
1.6.0 601 4/27/2024
1.5.6 370 4/24/2024
1.5.5 471 4/24/2024
1.5.4 392 4/24/2024
1.5.3 412 4/18/2024
1.5.2 244 4/17/2024
1.5.1 166 4/17/2024
1.5.0 897 4/4/2024
1.4.3 447 4/2/2024
1.4.2 158 4/2/2024
1.4.1 566 3/25/2024
1.4.0 1,155 3/12/2024
1.3.3 936 3/5/2024
1.3.2 911 2/6/2024
1.3.1 1,308 1/6/2024
1.3.0 1,813 11/22/2023
1.2.1 223 11/15/2023
1.2.0 232 11/14/2023
1.1.7 370 10/25/2023
1.1.6 439 9/29/2023
1.1.5 214 9/16/2023
1.1.4 166 9/16/2023
1.1.3 184 9/16/2023
1.1.2 230 9/13/2023
1.1.1 196 9/11/2023
1.1.0 167 9/11/2023