Chronicler.MemoryPackShim 1.0.0

Chronicler

Deterministic state transfer and simulation timing for .NET runtimes that own their objects and their schemas.

Chronicler lets a type declare its state once, then use that same explicit schema for JSON, MemoryPack, restore workflows, stable runtime links, and deterministic record hashes. Your host constructs the object graph; Chronicler transfers state into it without taking ownership of your runtime.

It also provides exact simulation timestamps and signed durations with 64-bit whole seconds and 32 fractional bits, plus an explicitly advanced, recordable clock. These timing primitives are independent of any engine or math package.

Why Chronicler?

• Schemas stay in your code. RecordData(...) makes names, defaults, order, and ownership visible and reviewable.
• Restore into live objects. Populate initialized runtime shells instead of asking a serializer to invent your graph.
• Keep references stable. Record external or runtime-owned objects by IDs through a session-scoped registry.
• Compare deterministic state. Compute replay and conformance signals from the recording schema without hashing a transport payload.
• Keep long-lived time exact. Advance a recordable clock explicitly; subtract wide timestamps before converting short intervals for motion calculations.
• Choose your dependency surface. Use JSON and MemoryPack together, or take the Lean package when the built-in MemoryPack transport is unnecessary.

Install

dotnet add package Chronicler.Core

Chronicler.Core targets netstandard2.1 and net10.0 and includes the JSON and MemoryPack transports.

Quick start

using Chronicler;
using Chronicler.Serialization;

PlayerSnapshot source = new() { Health = 72 };
string json = JsonRecordSerializer.Serialize(source, writeIndented: true);

PlayerSnapshot restored = new(); // The host creates and initializes the shell.
JsonRecordSerializer.Populate(restored, json);

public sealed class PlayerSnapshot : IRecordable
{
    public int Health = 100;
    public WeaponSnapshot Weapon = new();

    public void RecordData(IChronicler chronicler)
    {
        RecordValues.Look(chronicler, ref Health, "health", 100);
        RecordDeep.Look(chronicler, ref Weapon, "weapon");
    }
}

public sealed class WeaponSnapshot : IRecordable
{
    public int Ammo = 30;

    public void RecordData(IChronicler chronicler)
    {
        RecordValues.Look(chronicler, ref Ammo, "ammo", 30);
    }
}

The same RecordData(...) implementation works with MemoryPackRecordSerializer in the standard package. restored.Health is now 72; its existing Weapon keeps the declared ammo default of 30.

Recording contracts and helpers live in Chronicler. Use Chronicler.Serialization for transports and converters, Chronicler.Hashing for deterministic record hashes, and Chronicler.Timing for time values and the clock. See the migration guide when upgrading existing code.

The independent Chronicler.Diagnostics package provides diagnostic channels, lazy logging, and exception guards without depending on either Core variant. See the diagnostics guide.

Choose a package

Learn more

• Getting started
• Understand values, owned state, and links
• Use deterministic record hashes
• Represent simulation time
• Browse the API reference
• View test coverage

Development

dotnet build Chronicler.slnx --configuration Release
dotnet test Chronicler.slnx --configuration Release --no-build

See the contributor guide for the full workflow.

Community and license

Open an issue for bugs and feature requests, or join the LSF Discord community.

See Support, the Code of Conduct, and the security policy for help and reporting guidance.

Chronicler is available under the MIT License. See the notice for the repository's branding and redistribution terms.