@realitycollective/iwsdk-interactions

The Meta IWSDK adapter for the Reality Collective Interaction Extensions. It connects the @realitycollective/webxr-interactions core to Meta's Immersive Web SDK.

npm install @realitycollective/iwsdk-interactions @iwsdk/core

It re-exports everything from the core, so this is the only interaction package your app needs.

What it binds

| Layer | Detail | | --- | --- | | Input | IWSDK's player rig, controller state and hand joints | | Targeting | IWSDK already knows what is being pressed or grabbed, through its Pressed and Grabbed tags. The adapter passes that answer straight through instead of working it out again with rays | | Grab | Where the app has IWSDK grabbing or physics turned on, IWSDK performs the grab itself | | Setup | One call: registerInteractions(world) |

Usage

import { registerInteractions } from "@realitycollective/iwsdk-interactions";

const interactions = registerInteractions(world);

interactions.register({ id: "handle", behaviours: [{ kind: "grab" }] }, entity);

interactions.runtime.onEvent((event) => console.log(event.type));

registerInteractions is idempotent per world and registers the bridge system for you; the render loop is driven by IWSDK, so there is no update call to make.

Peer dependencies

@iwsdk/core >=0.5.0 <0.6.0. The adapter is source-compatible with 0.4.x, but 0.5 is the only line CI exercises, so that is the only line supported.

@iwsdk/xr-input >=0.5.0 <0.6.0 and three >=0.170.0. Every IWSDK application already has both: @iwsdk/core installs @iwsdk/xr-input, and IWSDK projects carry three (aliased to super-three). The adapter imports three.js classes from three and InputComponent from @iwsdk/xr-input directly, rather than through @iwsdk/core's star re-exports, so it prebundles even when an application excludes one of those packages from Vite's dependency optimizer to transform its source.

Live demo

The interaction playground - the full station set, mouse-capable on desktop, VR button for headsets: webxr-interactions.pages.dev

Documentation

See the repository README.

License

MIT - see LICENSE.