Support, compatibility and stability

What ships, and what is source

• The engine is closed-source. LivingSim.Core.dll, LivingSim.Sdk.dll, LivingSim.Inspection.dll and LivingSim.UnityAdapter.dll ship as compiled .NET Standard 2.1 assemblies. If having the engine's source code is critical to your project, this package is not the right fit, and we would rather say so here than after a purchase.
• Everything that touches your project is readable C#. The Unity components (Runtime/), the sample game and its scene (Samples/), and the HouseShareGame the sample runs are plain source you can read, change and copy.
• Every assembly carries its documentation and symbols. LivingSim.*.xml gives your IDE a tooltip for every documented member; LivingSim.*.pdb gives a stack trace through the engine its file and line. Keep them beside the DLLs.
• No network, no telemetry, no model. The engine is deterministic and offline. Nothing in the package calls out.

Versions: what counts as breaking

The package follows Semantic Versioning. The version is in VERSION.txt, in every DLL's file properties, and at the top of CHANGELOG.md. The rules below are the ones the repository's API-surface policy and packaging notes record; a test keeps the three saying the same thing.

• What is supported. The supported surface is the LivingSimSdk facade and the documented LivingSim.Core engine API. The facade is LivingSimSdk, its seven areas (Characters, Places, Items, Actions, Relationships, Time, Events), Save and Load, and the copied views they return; the documented engine API is SimulationEngine (construction, stepping, recording, queries, snapshots), WorldEvent and its vocabulary, the scenario loader and the durable-state types the reference documents. The inspection views and the host adapter (LivingSim.Inspection, LivingSim.UnityAdapter) are opt-in tooling for the debug inspector and may move with it. Everything else that happens to be public in the DLLs is engine substrate, not a promise.
• While the version starts with 0 (0.x): a minor release may change the supported surface or the save format, and every such change is listed under Changed in the changelog with what to do about it. A patch release (0.1.0 to 0.1.1) changes no supported signature and loads every save the minor can load.
• From 1.0: a breaking change to the supported surface or to what Load accepts bumps the major version. A minor adds; a patch fixes. Anything marked [Obsolete] keeps working for at least one minor release before it can be removed, and is removed no earlier than the next major.
• Saves. A save made by a version loads in every later patch of the same minor. Across a minor at 0.x, or a major from 1.0, the changelog says whether old saves load, and a save that cannot load fails at Load with a message rather than loading wrong.
• Determinism. The same seed and the same calls give the same result, and a loaded save continues as the original would have, within one version. A new version may change what characters do (that is what most releases are for), so a replay recorded on one version is not a test of the next.

Supported Unity versions and runtimes

• Verified: Unity 2022.3 LTS (2022.3.62f1) and Unity 6 (6000.4.5f1 and 6000.6.4f1) in the Editor on Mono, including with Reload Domain off; and Unity 2022.3.62f1 in an IL2CPP standalone player at Low and High managed stripping, with no link.xml.
• Expected to work, not yet verified: other Unity 2022.3 and Unity 6 releases, and IL2CPP on Unity 6. The package uses no version-specific APIs and targets .NET Standard 2.1 under either Api Compatibility Level.
• Not supported: Unity versions before 2022.3, and WebGL and console players until we have verified them (a WebGL build of the sample is planned; when it ships, this page will say so).

Each release is verified again on the versions it names; the package README's Requirements section and the store listing name the same versions as this page.

Support

• Where: email [email protected], or the Asset Store publisher page. Please include the package version (VERSION.txt), the Unity version and backend, and a save or a seed that reproduces it where you can.
• Response target: best effort, normally within three business days. A reproducible bug in a supported configuration is fixed in the next patch release where that is feasible; a fix that needs a new API waits for a minor.
• Updates are free for buyers of the listing; the version and changelog ship inside the package.

What we will not promise

• Source access to the engine, or a licence for it.
• Compatibility with Unity versions before 2022.3, or with platforms not listed above.
• That a later version keeps every character's behaviour the same. Fixes and better modelling change outcomes; the changelog names the mechanics that moved.