Skip to content

UnrealZoo/unrealzoo-gym

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

932 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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

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

๐Ÿ”Œ UnrealCV+ Plugin Upgrade

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

๐Ÿ“ฆ Environment Package Download

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

๐Ÿ“œ 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/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

๐ŸŽฌ System Interaction Demo

๐Ÿš— Vehicle Interaction

๐Ÿคธ Actions & Interactions

๐Ÿค– Diverse Controllable Agents

Drone Robot Dog Multi-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)

๐ŸŒ Scene Gallery

UE5 Example Scenes

More Scenes: Scene Gallery


๐ŸŽฎ UnrealZoo Custom Task Example

3D Spatial Navigation Task


๐Ÿ“Š Performance Metrics

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

๐Ÿš€ 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

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

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

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

๐Ÿ—“๏ธ 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

Releases

No releases published

Packages

 
 
 

Contributors

No contributors

Languages

  • Python 100.0%