Workes.SaveSystem.MessagePack 1.0.1

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package Workes.SaveSystem.MessagePack --version 1.0.1
                    


                    

                
NuGet\Install-Package Workes.SaveSystem.MessagePack -Version 1.0.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="Workes.SaveSystem.MessagePack" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Workes.SaveSystem.MessagePack" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Workes.SaveSystem.MessagePack" />
                    


                            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 Workes.SaveSystem.MessagePack --version 1.0.1
                    


                    

                
#r "nuget: Workes.SaveSystem.MessagePack, 1.0.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 Workes.SaveSystem.MessagePack@1.0.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=Workes.SaveSystem.MessagePack&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Workes.SaveSystem.MessagePack&version=1.0.1
                    


                            Install as a Cake Tool

Workes.SaveSystem.MessagePack

NuGet License: MIT

Workes.SaveSystem.MessagePack is the optional MessagePack serializer companion for Workes.SaveSystem.

Use it when you want save-system provider payloads and metadata written as compact .msgpack files instead of the core package's JSON format. The core package stays MessagePack-free; this package is the opt-in binary serializer integration.

Highlights

  • Writes provider payloads and save metadata with the .msgpack extension.
  • Stores compact integer-keyed provider payloads through automatic field maps.
  • Supports save validation, schema-version checks, provider migrations, and application metadata migrations.
  • Covers object roots, list and array roots, string-key dictionary roots, scalar roots, and nullable provider state where the state type accepts null.

Installation

Install from NuGet:

dotnet add package Workes.SaveSystem.MessagePack --version 1.0.1

Or add a package reference:

<PackageReference Include="Workes.SaveSystem.MessagePack" Version="1.0.1" />

This package targets .NET Standard 2.1 and depends on Workes.SaveSystem 1.0.1 and MessagePack.

Quick Example

using Workes.SaveSystem;

var manager = new SaveManager<string>(
    SaveSystemOptions.Create(
        saveRootPath: "Saves",
        serializer: new MessagePackSaveSerializer()));

A saved slot can contain files such as:

Saves/
  slot-1/
    metadata.msgpack
    player.msgpack

See the Quick Start for a beginner-first setup walkthrough.

Documentation

Start here:

  1. Quick Start
  2. MessagePack Serialization
  3. Metadata And Validation
  4. Migrations

See the Changelog for release history and migration-sensitive changes.

Companion Package Role

Workes.SaveSystem.MessagePack does not replace the core save-system APIs. You still use SaveManager<TIdentity>, SaveSystemOptions, providers, validation, backups, metadata providers, and migration steps from Workes.SaveSystem.

Choose the companion serializer when compact binary save files matter more than direct readability. Choose the core JSON serializer when inspecting saves by hand is more useful.

License

Workes.SaveSystem.MessagePack is available under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 was computed.  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 was computed.  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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 105 8/11/2026
1.0.0 122 6/25/2026
1.0.0-preview.2 75 6/24/2026
1.0.0-preview.1 72 6/24/2026

1.0.1 adds first-class CHANGELOG.md package documentation, packs it into the NuGet package root alongside README.md, adds focused public guides for MessagePack setup and behavior, and aligns the companion dependency with Workes.SaveSystem 1.0.1.