@urth/metatell-sdk

The TypeScript SDK for building third-party plugins that run on metatell, a browser-based virtual space platform.

Plugins use this package to access what metatell exposes to the plugin runtime: user information, microphone, camera, screen share, avatar, waypoints, and metrics.

This package targets the in-browser plugin runtime. It is not an SDK for standalone use on Node.js.

Install

npm install @urth/metatell-sdk

With pnpm:

pnpm add @urth/metatell-sdk

Usage

import { getWaypoints, user } from "@urth/metatell-sdk";

const waypoints = getWaypoints();
const userId = user.id;

console.log({ userId, waypoints });

The SDK is distributed as ESM and is meant to run from plugins executing in the browser.

Links

• API reference — https://sdk.metatell.io/web/
• Product & plugin docs — https://docs.metatell.io/
• Package — https://www.npmjs.com/package/@urth/metatell-sdk

The full API reference is hosted at sdk.metatell.io/web/.