@urth/metatell-sdk-internal

@urth/metatell-sdk-internal is the package that metatell itself uses to set up the runtime for third-party plugins.

Normal plugin development does not use this package directly. To call metatell features from a plugin, use @urth/metatell-sdk.

Role

This package provides the bridge between metatell and plugins.

On the metatell side, it reads state such as the microphone, camera, screen share, avatar, and waypoints. It passes that state to plugins via window.MetatellSDK and window.MetatellPlugin.

Install

Install this only when embedding it into metatell itself or a verification host environment.

npm install @urth/metatell-sdk-internal

With pnpm:

pnpm add @urth/metatell-sdk-internal

Requirements

This package is meant to run in the metatell runtime in the browser. It is not a library for standalone use on Node.js.

At runtime, metatell must provide window.APP, the DOM, media device APIs, and so on.

Entry points

• environments/setting — passes metatell's APP.scene to the plugin runtime.
• environments/thirdparty — loads third-party plugin scripts with type="module".
• main/mic — notifies plugins of the microphone device and mute state.
• main/camera — notifies plugins of the camera pose.
• main/screen — notifies plugins of the screen-share MediaStream.
• main/waypoints — lets plugins read the list of waypoints.
• main/bus — initializes window.MetatellPluginBus.
• main/presence — publishes local and remote user presence to the plugin bus.
• main/chat — relays chat events and send requests over the plugin bus.
• main/input — relays pointer, gaze, and raycast requests over the plugin bus.
• main/voice — publishes speaking state and volume levels to the plugin bus.
• main/emote — relays emote events over the plugin bus.
• main/user/avatar — notifies plugins of the user avatar pose.
• interface/ — initializes the global interfaces called from the plugin side.

Visibility

This package is published to npm, but it is intended for metatell itself and verification host environments. Do not depend on @urth/metatell-sdk-internal in external plugin implementations.