README.md

April 15, 2026 · View on GitHub

UnrealZoo Demo Video

▶️ Click to watch full demo video

UnrealZoo

Production-Ready Multi-Agent Embodied AI Training Platform

Photo-realistic virtual environments with 100+ scenes, 10+ agents real-time collaboration

🇺🇸 English | 🇨🇳 中文

🚀 Quick Start🌐 Website📄 Paper📚 Docs


📖 Overview

UnrealZoo Overview

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.


🔥 What's New

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.

🚀 v3.0 Core Updates

FeatureStatusDescription
Heterogeneous Multi-Agent Collaboration✅ ReleasedGround + UAV formation following (UE built-in navigation / Python external navigation API examples)
Template-based Agent Spawn✅ ReleasedRuntime dynamic agent generation with mixed category support
Enhanced Interaction System✅ ReleasedDoor open / vehicle enter-exit / pickup / crouch / jump / climb, with API-keyboard mapping for easy understanding
NavMesh Path Planning✅ ReleasedCalculate shortest path waypoints via API, support autonomous agent navigation control and waypoint export

🔌 UnrealCV+ Plugin Upgrade

FeatureDescription
Rendering Performance BoostImage rendering speed improved by 120%, multi-agent scene FPS significantly enhanced
PAK Runtime MountingDynamically extend content resources without rebuilding the project
Panoramic Camera Support360° equirectangular image/video export, supports VR preview
C++ Video Recording PipelineMore efficient large-scale collection workflow
Object Spawning from PathSpawn objects directly using full asset paths
Scene Annotation SystemSupports semantic segmentation and object detection training workflows
Stable CID Camera IdentifierLong-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

📦 Environment Package Download

VersionContentSizeDownload
UE5.6 Full Version (recommend)100+ scenes, Chaos physics~70GBModelScope
UE5 Demo Version (1.0 version, require v2.0 branch code)4 example scenes~10GBModelScope
UE4 Demo Version (1.0 version, require v2.0 branch code)6 example scenes~3GBModelScope

📜 Development History

Click to view historical updates

2024-12: Paper Release

2025-01: UE5.6 Full Environment Package

  • ✅ 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)

2025-04: v3.0 Official Release

  • ✅ 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

View Full Changelog


⚡ 30-Second Quick Start

# 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


🌟 Core Features

🏙️ 100+ Scenes👥 10+ Agents🚗 Vehicle Interaction📦 Object Manipulation
Urban/Natural/Architectural/IndustrialReal-time collaboration in same sceneEnter/Drive/ExitPickup/Carry/Place
16km² max scene sizeHumanoid/Vehicle/AnimalRealistic vehicle animationsSpawn at arbitrary locations
UE5.6 Chaos🎮 Out of the Box🐕 Diverse Entities🌐 Cross-Platform
Collision/Explosion/Firepip install and runHumanoid/Vehicle/AnimalLinux/Win/Mac
Physics-level realismNo UE knowledge requiredReal-time appearance switchingPre-compiled binaries

🎬 System Interaction Demo

🚗 Vehicle Interaction

🤸 Actions & Interactions

🤖 Diverse Controllable Agents

DroneRobot DogMulti-Agent Collaboration

🎮 Interaction Demo (Example Code)

📹 Video Data Recording

C++ video recording pipeline for efficient large-scale dataset collection

python example/DataRecording/VideoRecordingPipeline.py

Note: 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-v0

Controls:

  • I/J/K/L - Move
  • ↑/↓ - Look up/down
  • F - 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-v0

3 ground agents + 1 UAV collaborative tracking

🎮 Drone Keyboard Control
python example/navigation/keyboard/navigation_keyboard_drone.py \
  -e UnrealNavigation-Demo_Roof-ContinuousColor-v0

Controls:

  • W/S - Forward/Back | A/D - Left/Right | E/Q - Ascend/Descend | J/L - Yaw

🏗️ Technical Architecture

UnrealZoo Framework

Architecture Overview

  • 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

Data Flow

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


📊 Performance Metrics

MetricValueDescription
Scene Scale16 km²Maximum single scene area
Scene Count100+Pre-built photo-realistic scenes
Agent Count10+Real-time interaction in same scene
Rendering Performance60+ FPSReal-time multi-modal rendering
Physics EngineChaosUE5.6 native physics
Package Size67 GBUE5 full version
Download ChannelsGitHub + ModelScopeChina acceleration mirror

🚀 Quick Start

Step 1: Install Dependencies

git clone https://github.com/UnrealZoo/unrealzoo-gym.git
cd unrealzoo-gym
pip install -e .

Step 2: Download Environment Package

PackageDownload LinkSize
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

Step 3: Run Demos

# 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


📦 Applications

🏆 Offline EVT (ECCV 2024)

Embodied Visual Tracking Agent

Active tracking algorithm based on Offline RL, trained and validated in UnrealZoo environments

📄 Paper💻 Code


🚁 UAV-Flow: Flying-on-a-Word

Language-Guided UAV Control

Beihang University team uses UnrealZoo for simulation evaluation, supporting language-conditioned UAV imitation learning

🌐 Homepage📄 Paper


🧠 EmbRACE-3K: Embodied Reasoning

Embodied Reasoning in Complex Environments

HKU, Tsinghua, and BNU jointly built 3,000+ language-guided task dataset based on UnrealCV-Zoo framework

🌐 Homepage📄 Paper


🎯 ROCKET-2: Cross-View Goal Alignment

Cross-View Goal Alignment

Peking University and UCLA team uses UnrealZoo for cross-view visuomotor policy simulation training

🌐 Homepage📄 Paper

💡 Your project also uses UnrealZoo? Welcome to submit a PR to add to this list!


📖 Documentation

DocumentDescription
User GuideComplete usage guide (v3.0)
Wrapper GuideEnvironment wrapper APIs
Add EnvironmentCustom environment tutorial
CHANGELOGVersion update history
Example IndexAll example code

🗓️ TODO List

  • ✅ 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

🤝 Contributing & Support

If you find this helpful, please give us a ⭐ Star!


📄 Citation

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}
}

📜 License & Acknowledgments

This project is open-sourced under Apache 2.0 license.

Acknowledgments:


⬆ Back to Top

Made with ❤️ by UnrealZoo Team