DOCSEARCHbyAlgolia
Submit Docs

metatell Documentation

website·Indexed 31 days ago

https://docs.metatell.io

Developer and administrator guides for metatell, a 3D spatial communication platform. Includes documentation for the @urth/metatell-sdk for browser plugins, @metatell/bot-sdk for creating AI and voice bots, external API client authentication via OAuth 2.0, and administrative controls for room roles, 3D space elements, and organization management.

Tokens
58.7K
Snippets
173
Records
457
Agent score
53%

What's inside metatell

  1. Overview of metatell Plugin Architecture

    metatell plugins allow for company-specific 2D UI replacements using Module Federation. The system loads plugins in the following sequence:

    1. Retrieves room plugin information and registers remotes via init({ remotes }).
    2. Converts each plugin to a source format: src = "{versionId}/{type}".
    3. Loads the remote at specific UI injection points using loadRemote(src) and renders the corresponding module.CustomXXX component.

  3. Overview of JS Call Events in metatell plugins

    JS Call Events allow Spoke to send events to a metatell plugin to implement interactive functionality. The workflow consists of three steps: configuring a trigger in Spoke, sending the event with specific parameters, and receiving the event in the plugin using a standard JavaScript event listener.

  5. Overview of Spoke AI Panel and MCP

    The Spoke AI Panel allows users to view and edit scenes using AI assistants that support the Model Context Protocol (MCP). MCP is a standard for secure integration between AI and applications. Users can register Spoke's MCP endpoint in Claude's custom connectors or ChatGPT's custom MCP apps to enable this functionality.

  6. Overview of metatell Bot SDK sample implementations

    The metatell Bot SDK provides several sample bot implementations to help developers build bots for different use cases. The source code is available in the official GitHub repository.
    # GitHub Repository
https://github.com/urth-inc/metatell-ai-bot

# Examples Directory
https://github.com/urth-inc/metatell-ai-bot/tree/develop/examples

  7. Overview of the Skybox element

    The Skybox is an element that generates the appearance of the sky and atmosphere covering the entire 3D space. It serves two primary purposes: as a background visual and as an environment map that defines the basis for reflections and lighting for materials within the space. Only one Skybox can be added to a space. Any changes made to the Skybox will trigger a regeneration of the environment map, which is then reflected in the material reflections of the space.

  9. Understand the difference between Organization Roles and Room Roles

    In metatell, permissions are split into two distinct scopes: Organization Roles and Room Roles. Organization Roles control access to the global administration panel (members, 3D spaces, rooms, and resources), whereas Room Roles control specific interactions within a particular room (entry, audio, sharing, and participant management).

  11. Understand how the Room Load Balancer distributes users

    The Room Load Balancer allows a single proxy URL to distribute users across multiple rooms. When a user accesses the proxy URL, the system retrieves the current number of users in each associated room in real-time and redirects the user to the room with the fewest occupants. This ensures an even distribution of load and improves overall service performance and stability.

  12. Update user profile and nickname

    Users can change their display name, self-introduction (bio), and avatar from the profile screen within a room.

    Steps:

    1. Open the 'More' (その他) menu at the bottom of the screen.
    2. Select 'Profile' (プロフィール).
    3. Edit the nickname, profile bio, and avatar.
    4. Select the Save button.

    Constraints:

    • Nicknames: Maximum 32 characters. Emojis are not permitted.
    • Profile bio: Maximum 300 characters.