Vuer Documentation Skill

This directory contains comprehensive documentation for Vuer, a lightweight 3D visualization toolkit for robotics and VR applications.

Version: v0.0.67 Source: https://docs.vuer.ai/

Documentation Structure

Guides (2/2 complete)

Introduction - Overview and key features
Getting Started - Installation and setup

Tutorials

Vuer Basics (5/5 complete)

Setting Up Your First Scene - Create basic 3D scenes
Async Programming - Handle parallel routines and callbacks
Simple Life Cycle - CRUD operations for components
SSL Proxy for WebXR - Setup secure connections for VR
Serving Dynamic Content - Add custom HTML routes

Robotics Visualization (4/4 complete)

Using URDF - Load and display robot models
MIT Mini Cheetah - Animated quadruped robot
Unitree Go1 with Stairs - Complex scene with fog effects
Camera Frustums - Visualize camera viewpoints

Virtual Cameras (3/6 complete)

Recording Camera Movements - Capture user camera movements
Manipulating Camera Pose - Programmatic camera control
Grab Render from Virtual Camera - Capture rendered images
Collecting Render from Multiple Browser Sessions - Not yet fetched
Transforming Points using Camera Matrix - Not yet fetched
Render Queue - Not yet fetched

Physics in Mixed Reality (3/4 complete)

MuJoCo WASM - Browser-based physics simulation
MoCap Control - VR motion controller integration
Hand Control - VR hand tracking with MuJoCo
MuJoCo Gallery - Not yet fetched

API Documentation

Python API reference - Not yet fetched
Component schemas - Not yet fetched
Event types - Not yet fetched

Completion Status

Completed and Saved: 16 pages Remaining to fetch: ~10+ pages Total Estimated: 25+ pages

What is Vuer?

Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. Key features:

Lightweight performance - Efficient 3D rendering
VR and AR compatibility - Works with virtual and augmented reality devices
WebSocket-based - Real-time communication between Python and browser
Robotics-focused - URDF support, physics simulation, camera tools
Extensible - Custom components and handlers
MIT License - Free and open source

Quick Start

pip install 'vuer[all]==0.0.67'

from vuer import Vuer
from vuer.schemas import Scene, Box

app = Vuer()

@app.spawn
async def main(session):
    session.set @ Scene(
        Box(
            args=[0.1, 0.1, 0.1],
            position=[0, 0, 0],
            key="box",
        ),
    )

app.run()

Use Cases

Robotics Visualization - Display robot models, trajectories, sensor data
VR/AR Applications - Interactive 3D environments
Data Visualization - 3D plots, point clouds, meshes
Physics Simulation - MuJoCo integration for browser-based physics
Camera Calibration - Visualize camera frustums and capture renders
Motion Capture - VR controller and hand tracking

Development

The project emerged from research at MIT and UCSD, with contributors specializing in robotics, computer vision, and computer graphics.

Next Steps

Source

All documentation fetched from: https://docs.vuer.ai/