@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 and presence, chat, input, voice, emotes, microphone, camera, screen share, avatar, waypoints, room objects, Spoke triggers, room backgrounds, 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
Copy

With pnpm:

pnpm add @urth/metatell-sdk
Copy

Usage

import { getWaypoints } from "@urth/metatell-sdk";
import { onMessage } from "@urth/metatell-sdk/chat";
import { getProfile, getSessionId } from "@urth/metatell-sdk/user";

const waypoints = getWaypoints();
const sessionId = getSessionId();
const displayName = getProfile()?.displayName;

const unsubscribe = onMessage((message) => {
  console.log(`${message.from.displayName}: ${message.text}`);
});

console.log({ sessionId, displayName, waypoints });

// on plugin teardown
unsubscribe();
Copy

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

Guides

Start with the Overview for runtime requirements, import styles, and the event model.

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/.