114 lines
4.1 KiB
Markdown
114 lines
4.1 KiB
Markdown
# 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](guides/introduction.md) - Overview and key features
|
|
- [Getting Started](guides/getting-started.md) - Installation and setup
|
|
|
|
### Tutorials
|
|
|
|
#### Vuer Basics (5/5 complete)
|
|
- [Setting Up Your First Scene](tutorials/basics/setting-a-scene.md) - Create basic 3D scenes
|
|
- [Async Programming](tutorials/basics/async-programming.md) - Handle parallel routines and callbacks
|
|
- [Simple Life Cycle](tutorials/basics/simple-life-cycle.md) - CRUD operations for components
|
|
- [SSL Proxy for WebXR](tutorials/basics/ssl-proxy-webxr.md) - Setup secure connections for VR
|
|
- [Serving Dynamic Content](tutorials/basics/serving-dynamic-content.md) - Add custom HTML routes
|
|
|
|
#### Robotics Visualization (4/4 complete)
|
|
- [Using URDF](tutorials/robotics/using-urdf.md) - Load and display robot models
|
|
- [MIT Mini Cheetah](tutorials/robotics/mini-cheetah.md) - Animated quadruped robot
|
|
- [Unitree Go1 with Stairs](tutorials/robotics/go1-stairs.md) - Complex scene with fog effects
|
|
- [Camera Frustums](tutorials/robotics/camera-frustums.md) - Visualize camera viewpoints
|
|
|
|
#### Virtual Cameras (3/6 complete)
|
|
- [Recording Camera Movements](tutorials/camera/recording-camera-movements.md) - Capture user camera movements
|
|
- [Manipulating Camera Pose](tutorials/camera/manipulating-camera-pose.md) - Programmatic camera control
|
|
- [Grab Render from Virtual Camera](tutorials/camera/grab-render-virtual-camera.md) - 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](tutorials/physics/mujoco-wasm.md) - Browser-based physics simulation
|
|
- [MoCap Control](tutorials/physics/mocap-control.md) - VR motion controller integration
|
|
- [Hand Control](tutorials/physics/hand-control.md) - 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
|
|
|
|
```bash
|
|
pip install 'vuer[all]==0.0.67'
|
|
```
|
|
|
|
```python
|
|
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
|
|
|
|
1. Read the [Getting Started Guide](guides/getting-started.md)
|
|
2. Follow the [Vuer Basics tutorials](tutorials/basics/)
|
|
3. Explore [Robotics examples](tutorials/robotics/)
|
|
4. Try [Camera tutorials](tutorials/camera/)
|
|
5. Experiment with [Physics simulation](tutorials/physics/)
|
|
|
|
## Source
|
|
|
|
All documentation fetched from: https://docs.vuer.ai/
|