rooomAvatars Overview

Build iframe-based avatar editing flows with rooomAvatars, then register avatar settings and download generated models through the REST API.

Components

Editor Embedding

Use Editor Embedding to embed the avatar editor, pass startup options, and receive editor events.

REST API

Use REST API to register avatar configurations, download .glb models, fetch previews, and load animation files.

Animation Tutorials

Use Playing Built-in Animations or Using Mixamo Animations to animate exported models.

Troubleshooting

Use Troubleshooting to diagnose loading, authentication, origin, and export issues.

Key Features

• Embeddable avatar editor for web applications.
• URL-based startup configuration for editor display flags, language, theme, avatar name, and initial avatar settings.
• postMessage events for configuration updates, completion results, and error handling.
• REST endpoints for avatar registration, model downloads, preview images, and animation files.
• Mixamo-compatible avatar rig for built-in and external animation workflows.

Live Demo

Try the Babylon.js Playground demo to load a default avatar and walk around in a space. The demo requests the model with the locomotion animation set baked in:

https://api.avatars.rooom.com/model/AVATAR_HASH.glb?mergeMesh=1&animations=locomotion