Skip to content

facebook/immersive-web-sdk

Immersive Web SDK

npm version npm download language license

Where every webpage can become a world.

The Immersive Web SDK makes building immersive web experiences as approachable as traditional web development. It's a complete collection of frameworks and tools built on Three.js with a high-performance Entity Component System, developer-first workflow with one-command setup and built-in emulation, and production-ready systems for grab interactions, locomotion, spatial audio, physics, and scene understanding.

Same code, two experiences: Run immersively in VR/AR headsets and automatically provide mouse-and-keyboard emulation on desktop browsers. No browser extensions, no special setup—anyone with a laptop can develop for the immersive web.

Quick Start

# Install dependencies
pnpm install

# Build and pack all packages
pnpm run build:tgz

# Run example
cd examples/locomotion && pnpm run fresh:dev

Development

# Lint and format code
pnpm run lint
pnpm run format

# Build specific package
pnpm --filter '@iwsdk/core' run build

Documentation

For detailed information about using IWSDK, including step-by-step guides, architectural concepts, and complete API references, please visit our documentation site:

License

IWSDK is licensed under the MIT License. For more details, see the LICENSE file in this repository.

Contributing

Your contributions are welcome! Please feel free to submit issues and pull requests. Before contributing, make sure to review our Contributing Guidelines and Code of Conduct.

Developer Terms

About

WebXR made simple. Full-featured framework with interactions, locomotion, and spatial UI. Powered by Three.js.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •