@superviz/threejs-plugin

SuperViz ThreeJS SDK plugin

SuperViz provides a suite of programmable low-code Collaboration and Communication components, all synchronized with an advanced Real-time Data Engine, enabling real-time and asynchronous collaboration and communication within any JavaScript based application.

The SuperViz ThreeJS Plugin, when integrated, connects a ThreeJS scene to the SuperViz SDK, allowing avatars, pinned comments, and other collaborative features within the 3D environment for a shared participant experience.

Note: to use this package, you must also have the following minimum versions:

• SuperViz SDK, minimum version 5.0.0
• ThreeJS, minimum version 0.147.0

Getting started

1. Installing SuperViz ThreeJS extension

The Presence3D component is not available from the @superviz/sdk package, instead, to use Presence 3D you must use the @superviz/threejs-plugin package.

To install the @superviz/threejs-plugin package with npm, run the following command:

npm install --save @superviz/threejs-plugin

Or with Yarn:

yarn add @superviz/threejs-plugin

2. Adding ThreeJS to SuperViz SDK

To add a ThreeJS Presence3D component, you can use the following code:

import { Presence3D } from '@superviz/threejs-plugin';

const threeJSPresence = new Presence3D(scene, camera, camera, {
  isAvatarsEnabled: true,
  isLaserEnabled: true,
  isNameEnabled: true,
  isMouseEnabled: true,
  renderLocalAvatar: true,
  avatarConfig: {
    height: 0,
    scale: 1,
    laserOrigin: { x: 0, y: 0, z: 0 },
  },
});

sdk.addComponent(threeJSPresence);

Please check the documentation for more information about the Presence3D component.

Contributing

Issues

To report a new bug, request a new feature, or if you need any help, you can file an issue on GitHub. We have a few templates to help you out.

License

SuperViz SDK is licensed under the BSD 2-Clause License.