Skip to main content

Release Notes

Sync Kit release notes: version history, breaking changes, new features, and update instructions for each release.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported
  • SPECSFully supported
  • Camera Kit WebNot supported
  • Camera Kit MobileNot supported

Platform details

  • Snapchat — Not supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported.

  • Camera Kit Mobile — Not supported.

V1.3.6064068

Breaking Changes

Storage Property Type Definition

The type definition for StorageProperty has changed. Types such as StorageProperty<string> or StorageProperty<boolean> are no longer accepted. Use StorageProperty<StorageTypes.string> or StorageProperty<StorageTypes.bool> instead.

Migration Example:

// Before
const myProperty: StorageProperty<vec3> = ...;

// After
const myProperty: StorageProperty<StorageTypes.vec3> = ...;

V1.3.651799

Sync Kit v1.3.651799 has several improvements and new features, including ability to localize faster by looking at other players around you, Start Mode and Start Menu customization, reduction of Sync Kit packages by moving mapping UI into system, new visuals and more.

To update Sync Kit in your existing project:

  1. Open your project in Lens Studio.
  2. Log in to Lens Studio.
  3. Move all custom objects and scripts under the Interaction Kit prefab and the Sync Kit prefab's Colocated World out of the Sync Kit prefab.
  4. In the Asset Browser panel,
    • If the Sync Kit package is unpacked, right-click the Sync Kit folder and select Lock Package Contents. Then select Pull Update from Library.
    • If the Sync Kit package is locked, right-click it and select Pull Update from Library. If this option is not available in the context menu, check that you are logged in to Lens Studio.
  5. In the Asset Browser panel,
    • If the Interaction Kit package is unpacked, right-click it and select Lock Package Contents. Then select Pull Update from Library.
    • If the Interaction Kit package is locked, right-click it and select Pull Update from Library. If this option is not available in the context menu, check that you are logged in to Lens Studio.
    • If Pull Update is not shown, click Register to Library then try again.
  6. Drag the Interaction Kit prefab into the Scene Hierarchy and click Revert on the Sync Kit prefab to ensure your scene has the proper script reference.
  7. Move all custom objects and scripts back under the Interaction Kit prefab and the Sync Kit prefab's Colocated World.

Before reverting the Sync Kit prefab, make sure to move any custom scene objects (such as those under Colocated World) out of the Sync Kit prefab's hierarchy. If custom objects remain inside the Sync Kit prefab when you revert it, they will be deleted from the scene.

Faster Localization

The new mapping flow makes it faster and easier for players to connect within the same shared space. Instead of manually aligning environments, players can now look at another participant who has already joined the session to automatically map and sync their space. This streamlined process reduces setup time and ensures a smoother, more natural multiplayer experience.

Start Mode and Start Menu Customization

A new Start Mode option has been added to the Session Controller Component, allowing creators to configure how the Lens starts. In addition, developers can also now customize the Start Menu to match their Lens design. The StartMenu scene object in the Scene Hierarchy includes editable elements.

V1.2.24479

Sync Kit v1.2.24479 has several improvements, including Configuring Same Session ID and Custom Location Integration.

To update Sync Kit in your existing project:

  1. Drag the Interaction Kit folder inside the Sync Kit package to the Assets folder.
  2. Right-click the Interaction Kit folder and select Lock Package Contents.
  3. Right-click the Interaction Kit package and select Pull Update.
    • If Pull Update is not shown, click Register to Library then try again.
  4. Right-click the Sync Kit folder in your Asset Browser and select Pull Update.
  5. Right-click the Sync Kit folder and select Lock Package Contents.
  6. Also select the Sync Kit and Interaction Kit prefabs in your Scene Hierarchy and click Revert to ensure your scene has the proper script reference.

Before reverting the Sync Kit prefab, make sure to move any custom scene objects (such as those under Colocated World) out of the Sync Kit prefab's hierarchy. If custom objects remain inside the Sync Kit prefab when you revert it, they will be deleted from the scene.

Session ID Configuration for Spectacles (2024) and Lens Studio

Introduced support for configuring a same Session ID to enable automatic session synchronization between Spectacles (2024) to Lens Studio and Spectacles (2024) to Spectacles (2024). This enhancement simplifies not only session selection flow but also development workflow for Multiplayer Lenses, ensuring all connected devices automatically join the same session without manual selection.

  • Spectacles (2024) to Spectacles (2024), setting a Session ID ensures both devices connect to the same session automatically which removes the need to manually select or join a session, simplifying the user flow and reducing setup time.

  • Lens Studio to Spectacles (2024), developers can test multiplayer functionality using just one Spectacles (2024) device, allowing for faster iteration and more efficient development.

For Same Session ID configuration setup, see Configuring Session ID.

Custom Location Integration

Custom Location Integration feature combines Custom Location with Sync Kit, enabling persistent, shared AR experiences linked to real-world environments. Developers can now pre-scan a location, allowing for seamless multiplayer user flow without needing to restart the mapping flow every time the Lens is launched.

Bug Fixes

  • Fixed error message regarding cleanup() in SyncEntity.
  • Fixed claiming ownership of SyncEntity issue when the object is being instantiated.
  • Fixed general compatibility SyncEntity issues with Instantiator.
  • Fixed Lens crashed when removing a key from the store.
  • Fixed mapping gets stuck in the session