Photo-realistic virtual environments with 100+ scenes, 10+ agents real-time collaboration
๐บ๐ธ English | ๐จ๐ณ ไธญๆ
๐ Quick Start โข ๐ Website โข ๐ Paper โข ๐ Docs โข
UnrealZoo is a rich collection of photo-realistic 3D virtual worlds built on Unreal Engine, designed to reflect the complexity and variability of open worlds. There are various playable entities for embodied AI, including human characters, robots, vehicles, and animals.
Integrated with UnrealCV, UnrealZoo provides a suite of easy-to-use Python APIs and tools for various potential applications, such as data annotation and collection, environment augmentation, distributed training, and benchmarking agents.
๐ก This repository provides the gym interface based on UnrealCV APIs for UE-based environments, which is compatible with OpenAI Gym and supports the high-level agent-environment interactions in UnrealZoo.
UnrealZoo v3.0 is released! This is our biggest update yet, bringing complete heterogeneous multi-agent collaboration capabilities, out-of-the-box interaction systems, and a comprehensive upgrade to the UnrealCV+ Plugin.
| Feature | Status | Description |
|---|---|---|
| Heterogeneous Multi-Agent Collaboration | โ Released | Ground + UAV formation following (UE built-in navigation / Python external navigation API examples) |
| Template-based Agent Spawn | โ Released | Runtime dynamic agent generation with mixed category support |
| Enhanced Interaction System | โ Released | Door open / vehicle enter-exit / pickup / crouch / jump / climb, with API-keyboard mapping for easy understanding |
| NavMesh Path Planning | โ Released | Calculate shortest path waypoints via API, support autonomous agent navigation control and waypoint export |
| Feature | Description |
|---|---|
| Rendering Performance Boost | Image rendering speed improved by 120%, multi-agent scene FPS significantly enhanced |
| PAK Runtime Mounting | Dynamically extend content resources without rebuilding the project |
| Panoramic Camera Support | 360ยฐ equirectangular image/video export, supports VR preview |
| C++ Video Recording Pipeline | More efficient large-scale collection workflow |
| Object Spawning from Path | Spawn objects directly using full asset paths |
| Scene Annotation System | Supports semantic segmentation and object detection training workflows |
| Stable CID Camera Identifier | Long-term script configuration compatibility |
๐ก Solving User Pain Points: Panoramic export, NavMesh path planning, UAV simulation, complete interaction system โ UnrealZoo v3.0 is fully supported out-of-the-box
๐ View Full Changelog | ๐ View Notion Technical Docs
| Version | Content | Size | Download |
|---|---|---|---|
| UE5.6 Full Version (recommend) | 100+ scenes, Chaos physics | ~70GB | ModelScope |
| UE5 Demo Version (1.0 version, require v2.0 branch code) | 4 example scenes | ~10GB | ModelScope |
| UE4 Demo Version (1.0 version, require v2.0 branch code) | 6 example scenes | ~3GB | ModelScope |
Click to view historical updates
- ๐ Paper: UnrealZoo: Enriching Photo-realistic Virtual Worlds for Embodied AI
- ๐ Website: unrealzoo.github.io
- ๐ Notion Docs: Scene Gallery
- โ 100+ scenes, 67GB full package
- โ Chaos physics system (vehicles, collisions, explosions, fire)
- โ Object interaction system (pickup/drop)
- โ Appearance switching system (player/animal categories merged)
- โ Cross-platform binary support (Win/Mac/Linux auto-configuration)
- โ ModelScope China mirror (high-speed download channel)
- โ Heterogeneous multi-agent collaboration
- โ Template-based Agent Spawn
- โ Full enhanced interaction system demo code (API-keyboard mapping)
- โ NavMesh path planning and task application demo code
- โ UnrealCV+ Plugin comprehensive upgrade
# 1. Install
pip install -e .
# 2. Set environment path
export UnrealEnv=/path/to/UnrealEnv
# 3. Run multi-agent tracking demo
python example/multi_agent/baseline/multi_random_baseline.py \
-e UnrealTrack-Map_ChemicalPlant_1-ContinuousColor-v0๐ก Tip: First run requires downloading UE5 environment package (67GB), we recommend using ModelScope China mirror for faster download
| ๐๏ธ 100+ Scenes | ๐ฅ 10+ Agents | ๐ Vehicle Interaction | ๐ฆ Object Manipulation |
|---|---|---|---|
| Urban/Natural/Architectural/Industrial | Real-time collaboration in same scene | Enter/Drive/Exit | Pickup/Carry/Place |
| 16kmยฒ max scene size | Humanoid/Vehicle/Animal | Realistic vehicle animations | Spawn at arbitrary locations |
| โก UE5.6 Chaos | ๐ฎ Out of the Box | ๐ Diverse Entities | ๐ Cross-Platform |
|---|---|---|---|
| Collision/Explosion/Fire | pip install and run | Humanoid/Vehicle/Animal | Linux/Win/Mac |
| Physics-level realism | No UE knowledge required | Real-time appearance switching | Pre-compiled binaries |
๐น Video Data Recording
C++ video recording pipeline for efficient large-scale dataset collection
python example/DataRecording/VideoRecordingPipeline.pyNote: Before recording, open the binary and type vget /unrealcv/status to check the port number, ensure it matches the port parameter in the code
๐ฏ Multi-Agent Tracking
python example/tracking/basic/tracking_auto_basic.py \
-e UnrealTrack-Greek_Island-ContinuousColor-v0๐งญ Keyboard Navigation (with Interactions)
python example/navigation/keyboard/navigation_keyboard_human.py \
-e UnrealNavigation-Demo_Roof-MixedColor-v0Controls:
I/J/K/L- Moveโ/โ- Look up/downF- Open door |H- Enter/Exit vehicle |E- Pickup |Ctrl- Crouch |Space- Jump |Space x 2- Climb
๐ Heterogeneous Air-Ground Collaboration
python example/multi_agent/HeterogeneousCooperation/Aerial-Ground-Cooperative.py \
-e UnrealTrack-Map_ChemicalPlant_1-ContinuousColor-v03 ground agents + 1 UAV collaborative tracking
๐ฎ Drone Keyboard Control
python example/navigation/keyboard/navigation_keyboard_drone.py \
-e UnrealNavigation-Demo_Roof-ContinuousColor-v0Controls:
W/S- Forward/Back |A/D- Left/Right |E/Q- Ascend/Descend |J/L- Yaw
- Unreal Engine Environments (Binary): UE5.6 runtime environment containing scenes and playable entities
- UnrealCV+ Server: Plugin built into UE binary, including rendering, data capture, object/agent control, command parsing modules. We optimized the rendering pipeline and command system
- UnrealCV+ Client: Python-based utility functions for launching binaries, connecting to servers, and interacting with UE environments. Uses IPC sockets and batch commands for performance optimization
- OpenAI Gym Interface: Agent-level environment interaction interface, supports task customization via configuration files, includes Gym Wrappers toolkit for environment augmentation and population control
User Algorithm (Python) โโ Gym Interface โโ UnrealCV Client โโ UnrealCV Server โโ UE5.6 Environment
(Socket/WebSocket)
UE5 Example Scenes
More Scenes: Scene Gallery
๐ฎ UnrealZoo Custom Task Example
3D Spatial Navigation Task
| Metric | Value | Description |
|---|---|---|
| Scene Scale | 16 kmยฒ | Maximum single scene area |
| Scene Count | 100+ | Pre-built photo-realistic scenes |
| Agent Count | 10+ | Real-time interaction in same scene |
| Rendering Performance | 60+ FPS | Real-time multi-modal rendering |
| Physics Engine | Chaos | UE5.6 native physics |
| Package Size | 67 GB | UE5 full version |
| Download Channels | GitHub + ModelScope | China acceleration mirror |
git clone https://github.com/UnrealZoo/unrealzoo-gym.git
cd unrealzoo-gym
pip install -e .| Package | Download Link | Size |
|---|---|---|
| UE5 Full Version (Recommended) | ๐ค ModelScope | ~70GB |
| UE5 Demo Scenes (1.0 version, require v2.0 branch code) | ๐ค ModelScope | ~10GB |
| UE4 Demo Scenes (1.0 version, require v2.0 branch code) | ๐ค ModelScope | ~3GB |
Extract to UnrealEnv directory:
export UnrealEnv=/path/to/UnrealEnv# Multi-agent random policy
python example/multi_agent/baseline/multi_random_baseline.py \
-e UnrealTrack-Map_ChemicalPlant_1-ContinuousColor-v0
# Keyboard control navigation
python example/navigation/keyboard/navigation_keyboard_human.py \
-e UnrealNavigation-Demo_Roof-MixedColor-v0๐ก Tip: If mouse disappears, press
`(above Tab) to release mouse
Embodied Visual Tracking Agent
Active tracking algorithm based on Offline RL, trained and validated in UnrealZoo environments
๐ Paper โข ๐ป Code
Language-Guided UAV Control
Beihang University team uses UnrealZoo for simulation evaluation, supporting language-conditioned UAV imitation learning
Embodied Reasoning in Complex Environments
HKU, Tsinghua, and BNU jointly built 3,000+ language-guided task dataset based on UnrealCV-Zoo framework
Cross-View Goal Alignment
Peking University and UCLA team uses UnrealZoo for cross-view visuomotor policy simulation training
๐ก Your project also uses UnrealZoo? Welcome to submit a PR to add to this list!
| Document | Description |
|---|---|
| User Guide | Complete usage guide (v3.0) |
| Wrapper Guide | Environment wrapper APIs |
| Add Environment | Custom environment tutorial |
| CHANGELOG | Version update history |
| Example Index | All example code |
- โ Release an all-in-one package of the collected environments
- โ Add gym interface for heterogeneous multi-agent co-operation
- โ Expand the list of supported interactive actions
- Add more detailed examples for reinforcement learning agents
- Add more detailed examples for large vision-language models
- ๐ Official Website: http://unrealzoo.site/
- ๐ง Contact Email: [[[email protected], [email protected]]]
- ๐ฌ Discussions: GitHub Discussions
If you find this helpful, please give us a โญ Star!
If UnrealZoo helps your research, please cite our ICCV 2025 paper:
@inproceedings{zhong2025unrealzoo,
title={UnrealZoo: Enriching Photo-realistic Virtual Worlds for Embodied AI},
author={Zhong, Fangwei and Wu, Kui and Wang, Churan and Chen, Hao and Ci, Hai and Li, Zhoujun and Wang, Yizhou},
booktitle={Proceedings of the IEEE/CVF International Conference on Computer Vision (ICCV)},
year={2025}
}This project is open-sourced under Apache 2.0 license.
Acknowledgments:
- UnrealCV โ UE-Python communication bridge
- OpenAI Gym โ RL environment interface standard
- Unreal Engine โ Rendering engine
- Smart Locomotion โ Character animation
- Animal Pack โ Animal models
- Drivable Car โ Vehicle system
Made with โค๏ธ by UnrealZoo Team














