Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 2.08 KB

MIGRATION.md

File metadata and controls

43 lines (33 loc) · 2.08 KB

FixedMathSharp for Unity Migration Guide

This guide covers upgrades to the Unity packages. For changes to the engine-agnostic math, geometry, and optional Chronicler companion APIs, see the FixedMathSharp core migration guide.

Update the installed Standard or Lean variant and rebuild dependent assemblies. Install exactly one variant; both contain the FixedMathSharp core assembly.

Chronicler integration is optional. Pair com.mrdav30.fixedmathsharp.chronicler with the Standard math base, or com.mrdav30.fixedmathsharp.chronicler.lean with Lean, at the same package version. Install the base first. When switching variants, remove the companion and base before installing the other pair. See the Chronicler integration guide.

Migrating from v7.x to v8.x

All four packages now require Unity 6.3 LTS (6000.3) or newer. Projects on Unity 2022.3 or Unity 6.0–6.2 must upgrade the editor before adopting v8. Projects staying on older editors should keep the v7 math packages; the new Chronicler companions require v8 and the new editor baseline.

Both variants bundle the .NET Standard 2.1 build of FixedMathSharp v8.0.0 and Chronicler.Diagnostics v1.0.0. Lean also bundles the attribute-only Chronicler.MemoryPackShim v1.0.0. These dependencies are included as plugins; no separate Chronicler installation is needed. Standard retains the MemoryPack serializer/runtime; Lean continues to omit it.

The Unity adapter API is unchanged. Re-run geometry, transform, and deterministic replay tests: corrected core results can change simulation outcomes and replay hashes.

For formatting, use concrete TryFormat methods or IFormattable; the bundled .NET Standard 2.1 core does not implement ISpanFormattable.

Upgrading from earlier versions

Review the Unity package changelog for adapter changes and follow the matching sections in the core migration guide linked above.