# User Guide

<div style="text-align: center;">
    <video width="800" controls>
    <source src="../_static/imvr-sim.mp4" type="video/mp4">
    Your browser does not support the video tag.
    </video>
</div>

_ImVR_ is an **immersive** VR-based teleoperation system that enables precise and **intuitive** control of **both** simulated and real-world robots.

Core features:

- Full immersion in **3D virtual world**
- Smooth user experience: **60 Hz @ 4K rendering**
- Support mainstream VR devices: Meta Quest 3, Apple VisionPro, etc.
- User-friendly deployment: docker, docs, calibration tools, out-of-box examples, etc.
- Flexible, general purpose control modules: arm, hand, controller, etc.
- Unified sim & real teleoperation interface

This guide will walk you through everything from installation and basic usage, to running examples, setting up your own customized environments and robots, and advanced usage.

```{toctree}
:maxdepth: 1
:caption: Get started

getting_started/installation
getting_started/advanced
getting_started/hello_world
```

```{toctree}
:maxdepth: 1
:caption: Teleop in simulation

teleop_in_sim/general
teleop_in_sim/xarm_gripper
teleop_in_sim/floating_hand
teleop_in_sim/wheel
teleop_in_sim/custom_sim
teleop_in_sim/advanced_sim
```

```{toctree}
:maxdepth: 1
:caption: Advanced

tools/tools
tools/ik_config
tools/urdf
```

<!-- ```{toctree}
:maxdepth: 1
:caption: Teleop in Real World

teleop_in_real/general
``` -->