Getting Started
Spectacles Interaction Kit (SIK) is a collection of code components, modules, and assets for Lens Studio. SIK simplifies development for the Spectacles platform by providing common building blocks that facilitate the creation of interactive augmented reality experiences.
Download the latest compatible version of Lens Studio 5.
For the most recent updates, please refer to the release notes.
Starting a New Spectacles Project
In the Lens Studio home, select “Spectacles” under Start New Project.
Your new project will already be preconfigured with Spectacles Interaction Kit and other essential configurations for Spectacles development.
Importing Spectacles Interaction Kit into a new Lens Studio Project
To configure a new project from scratch using the Spectacles Interaction Kit, follow these steps:
-
Create a new project in Lens Studio.
-
Add the TypeScript Status panel to the Lens Studio UI by navigating to Window > TypeScript Status.
-
Add a Device Tracking component to your Camera and set tracking mode to World.
-
Set Platform Settings to Lens Is Made For > Spectacles.
-
In the Preview panel, set Device Type Override to Spectacles.
-
Install the latest Spectacles Interaction Kit version from the Asset Library via Window > Asset Library > Spectacles > Spectacles Interaction Kit.
-
Import Spectacles Interaction Kit by clicking the + symbol on the Asset Browser. Under the Installed Packages tab, select SpectaclesInteractionKit.
-
After the TypeScript Status panel confirms that compilation is complete, click the Refresh button on the Preview panel.
You can also unpack the Spectacles Interaction Kit package by right-clicking and selecting Unpack. Unpacking enables direct editing of SIK but may complicate future upgrades to newer versions. Additionally, when unpacked, import components and modules in your TypeScript files using SpectaclesInteractionKit rather than SpectaclesInteractionKit.lspkg in your import path.
-
From the Asset Browser, drag Assets/SpectaclesInteractionKit/Prefabs/SpectaclesInteractionKit.prefab into the scene hierarchy.
Instantiating the prefab before TypeScript compilation is complete may result in a corrupt prefab with missing links to TypeScript script components. Ensure that TypeScript compilation is fully complete before adding a prefab instance to the scene hierarchy.
-
If the Examples are no longer needed, disable or delete the [EXAMPLES] scene objects from the scene hierarchy.
-
Save your project, and you’re all finished!
Upgrading Spectacles Interaction Kit within a Project
Open your project. After TypeScript compilation is complete, right-click the SpectaclesInteractionKit package in the Asset Browser. If Pull Update from Library is available, select it.
To manually check for updates, navigate to Asset Library > Spectacles > SpectaclesInteractionKit and verify if a new version is available for installation. You can also select a specific version to install. After updating, right-click the SpectaclesInteractionKit package in the Asset Browser and select Pull Update from Library.
Now your project is updated!
Compilation errors may result after updates from changes in the API. Review the release notes for any updates on new APIs and make the necessary edits.