Skip to main content

WebSpatial Handbook

Overview​

It's recommended to read these docs in order, especially the first three chapters:

  1. Introduction: Introduces the problems WebSpatial solves and the benefits it brings.
  2. Quick Example: Use a minimal example to get a quick feel for the actual results and development experience of the WebSpatial SDK.
  3. Core Concepts: Learn the fundamental concepts of Spatial Apps and the WebSpatial SDK.

The fourth chapter provides comprehensive and detailed Development Guide. The guide consists of three parts, structured for both sequential reading and quick reference:

  1. What web projects can use WebSpatial API.
  2. How to add the WebSpatial SDK to your web projects, use WebSpatial Builder for visionOS testing (simulator or device), and how to bring spatial features to your site while still keeping it a standard, cross-platform website.
  3. How to use the WebSpatial API (Spatialization, Material, Elevation, Scenes, 3D) in web projects where the SDK is already integrated.

There are currently two sample projects:

  1. One is the Quick Example itself, which you can build it from scratch, or just grab the ready-made version from the repo. There's also a video showing the full setup process.
  2. The other is the "techshop" demo, showcases more realistic spatial UI design and also demonstrates cross-platform functionality.

Feedback & Support​

The WebSpatial SDK is newly open-sourced and may have bugs or missing docs/examples. If you run into issues, don't spend too much time trying to fix them yourself, just share sample code with us on Discord or GitHub Issues. That way, we can quickly assess the problem and offer a solution, suggestion, or hotfix.

Table of Contents​

  1. Introduction
  2. Quick Example
  3. Core Concepts
  4. Development Guide