1- # WebXR Framework Boilerplate
1+ # WebXR Framework Scne Understanding Example
22
3- This is the official boilerplate project for the WebXR Framework, designed for optimal developer, designer, and tech artist workflow.
3+ This is the official scene understanding example project for the WebXR Framework, designed for optimal developer, designer, and tech artist workflow.
44
55## 📁 Project Structure
66
77```
8- boilerplate /
8+ scene-understanding /
99├── src/ # Source code
1010│ ├── index.js # Main application entry point
1111│ ├── settings.js # Settings configuration
@@ -17,12 +17,11 @@ boilerplate/
1717│ ├── textures/ # Images and texture files
1818│ ├── audio/ # Audio files
1919│ └── models/ # Other 3D model formats
20- ├── generated/ # Auto-generated files (committed for designers)
21- │ └── components/ # Generated component XML definitions
22- │ ├── Transform.xml # Core transform component
23- │ ├── LocomotionEnvironment.xml # Locomotion component
24- │ └── ... # Other framework components
2520├── metaspatial/ # Meta Spatial project files
21+ │ └── components/ # Generated component XML (committed for designers)
22+ │ ├── IWSDKAudioSource.xml # Audio Source component
23+ │ ├── IWSDKLocomotionEnvironment.xml # Locomotion component
24+ │ └── ... # Other framework components
2625├── dist/ # Build output (generated)
2726├── index.html # Main HTML file
2827├── vite.config.js # Vite configuration
@@ -33,13 +32,13 @@ boilerplate/
3332
3433### Prerequisites
3534
36- - Node.js 18 + and pnpm
35+ - Node.js 20.19.0 + and pnpm
3736- HTTPS support for WebXR development
3837
3938### Installation
4039
4140``` bash
42- cd boilerplate
41+ cd scene-understanding
4342pnpm install
4443```
4544
@@ -62,7 +61,7 @@ The development server will start at `https://localhost:8081` with automatic HTT
6261
6362### WebXR-Optimized Asset Handling
6463
65- This boilerplate uses Vite's ` public/ ` directory for WebXR assets since they are:
64+ This example uses Vite's ` public/ ` directory for WebXR assets since they are:
6665
6766- Loaded at runtime via URLs (not imported as modules)
6867- Large files that shouldn't be bundled or processed
@@ -114,7 +113,7 @@ The `generated/` folder organizes all auto-generated files:
114113
115114### HTTPS Requirements
116115
117- WebXR requires HTTPS for all features to work properly. This boilerplate includes:
116+ WebXR requires HTTPS for all features to work properly. This example includes:
118117
119118- Automatic HTTPS certificate generation via ` vite-plugin-mkcert `
120119- Self-signed certificates for local development
@@ -157,7 +156,7 @@ The `vite.config.js` file includes:
157156
158157## 🔗 Integration
159158
160- This boilerplate is designed to work seamlessly with:
159+ This example is designed to work seamlessly with:
161160
162161- ** Meta Spatial SDK** for component definitions
163162- ** WebXR browsers** for VR/AR development
0 commit comments