Workes.SaveSystem 1.0.1

Workes.SaveSystem

Workes.SaveSystem is an engine-neutral .NET save system for games and applications that need registered state providers, disk saves, backups, metadata, and save-format migrations.

The package is not tied to Unity, Godot, or another engine. Your application chooses the persistent save path and serializer, then SaveManager<TIdentity> coordinates provider capture, persistence, loading, validation, recovery, and migration.

Highlights

• Register typed state providers with stable save keys and schema versions.
• Save and load named slots using string or custom identity types.
• Use readable JSON by default, compact JSON when desired, or serializer wrappers for compression and transforms.
• Rotate backups and recover from interrupted writes.
• Store typed application metadata for save menus without loading provider files.
• Migrate old provider payloads through format-neutral data nodes.
• Distinguish old saves from missing provider files through persisted provider manifests.
• Extend serialization, metadata, transforms, migrations, provider lifecycle, and default-state behavior.

Installation

Install from NuGet:

dotnet add package Workes.SaveSystem --version 1.0.1

Or add a package reference:

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

The package targets .NET Standard 2.1 and currently depends on Newtonsoft.Json for the built-in JSON serializer.

Quick Example

using Workes.SaveSystem;

var serializer = new JsonSaveSerializer();
var manager = SaveManager<string>.CreateDefault(
    serializer,
    saveRootPath: "Saves");

var playerProvider = new PlayerSaveProvider();
manager.RegisterProvider(playerProvider);
manager.ValidateRegistrations();

manager.SaveToDisk("slot-1");

playerProvider.Current = new PlayerState();
manager.LoadFromDisk("slot-1");

public sealed class PlayerState
{
    public string Name { get; set; } = string.Empty;
    public int Level { get; set; }
}

public sealed class PlayerSaveProvider : ISaveProvider<PlayerState>
{
    public string SaveKey => "player";
    public int SchemaVersion => 1;
    public int LoadPriority => 0;

    public PlayerState Current { get; set; } = new PlayerState
    {
        Name = "Rook",
        Level = 5
    };

    public PlayerState CaptureState() => Current;

    public void RestoreState(PlayerState state)
    {
        Current = state;
    }
}

See the Quick Start for the beginner-first walkthrough.

Documentation

Start here:

1. Quick Start
2. Configuration
3. Providers

Focused guides:

• Serialization
• Save Operations
• Save Metadata
• Backups And Recovery
• Migrations
• Extending The Save System
• Unity And Godot Integration

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

Companion Packages

The core package ships JSON and does not reference MessagePack. Compact MessagePack saves are handled by the optional companion package:

• Workes.SaveSystem.MessagePack

Use JSON when readable save files are useful. Use compressed JSON for smaller files without an additional dependency. Use the MessagePack companion package when compact binary saves are more important than direct readability.

License

Workes.SaveSystem is available under the MIT License.