Skip to content

Snapchat/Spectacles-Sample

Repository files navigation

Spectacles Logo

spectacles-2024-hero

Spectacles Sample Projects

This repository contains sample projects for Spectacles (2024). Spectacles Lenses and experiences are powered by SnapOS, utilizing Lens Studio as the authoring tool.

Interested in joining the Spectacles Developer Program? Apply here.

For guidance on building for Spectacles, refer to this tutorial.

New to spatial experiences? Explore our Introduction to Spatial Design.

Prerequisites

Large Files Storage: Many of these projects uses Git Large Files Support (LFS). Downloading a zip file using the green button on GitHub will not work. You must clone the project with a version of git that has LFS. You can download Git LFS here. Some developers experienced a "Long Path Error" in the process of cloning. You can see the resolution here.

Install Git LFS

# Install Git LFS
git lfs install

# Clone the repository with LFS support
git clone https://github.com/your-repo/sample-projects.git

API Keys: If some project take advantage of the Open AI API, You must provide your own OpenAI API key to use the functionalities provided by the project.

To update your Spectacles device and mobile app, please refer to this guide.

You can download the latest version of Lens Studio from here.

Lens Studio's Experimental APIs checkbox must be enabled in some of the projects in order to access certain features, for example "Camera Access". Please see Experimental APIs for more details here.

Extended Permissions mode on device must be enabled in some of the projects to access certain features. Please see Extended Permissions for more details here.

Content

ai-assistant

AI Assistant

AI-powered vision assistant using Spectacles ML APIs.

air-hockey

Air Hockey

Sample Connected Lens project using Spectacles Sync Kit.

crop

Crop

Sample project showing how to "crop" the environment using hand gesture.

fetch

Fetch

Sample project using the Spectacles Fetch API.

high-five

High Five

Real-time collaborative AR experience for high-five interactions.

material-library

Material Library

Experimental project collecting Materials tested on Spectacles.

outdoor-navigation

Outdoor Navigation

Outdoor navigation system using Map Component and Places API.

shared-sync-controls

Shared Sync Controls

Real-time collaborative AR experience for shared controls.

spatial-persistance

Spatial Persistence

Template project using Spectacles Spatial Anchor API.

throw-lab

Throw Lab

Sample project demonstrating realistic throwing mechanics in AR.

tic-tac-toe

Tic Tac Toe

Sample Connected Lens project using Spectacles Sync Kit.

voice-playback

Voice Playback

Sample project for recording and playing back audio on Spectacles.

Support

If you have any questions or need assistance, please don't hesitate to reach out. Our community is here to help, and you can connect with us and ask for support here. We look forward to hearing from you and are excited to assist you on your journey!