https://github.com/unrealcv/unrealcv
UnrealCV: Connecting Computer Vision to Unreal Engine
https://github.com/unrealcv/unrealcv
computer-vision embodied-ai machine-learning simulation synthetic-data ue4 virtual-worlds
Last synced: 9 days ago
JSON representation
UnrealCV: Connecting Computer Vision to Unreal Engine
- Host: GitHub
- URL: https://github.com/unrealcv/unrealcv
- Owner: unrealcv
- License: mit
- Created: 2016-09-08T18:03:51.000Z (about 9 years ago)
- Default Branch: 5.2
- Last Pushed: 2025-09-05T13:35:00.000Z (28 days ago)
- Last Synced: 2025-09-05T15:34:49.979Z (28 days ago)
- Topics: computer-vision, embodied-ai, machine-learning, simulation, synthetic-data, ue4, virtual-worlds
- Language: C++
- Homepage: https://unrealcv.org
- Size: 18.1 MB
- Stars: 2,048
- Watchers: 92
- Forks: 451
- Open Issues: 116
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-unreal - unrealcv - UnrealCV: Connecting Computer Vision to Unreal Engine (Graphics Compute Plugins)
- awesome-simulation - UnrealCV - Connecting Computer Vision to Unreal Engine ([Unreal Engine](https://www.unrealengine.com/en-US/))
- awesome_unreal_engine_4_-_5 - UnrealCV (opencv)
- awesome_unreal_engine_4_-_5 - UnrealCV (opencv)
README
# UnrealCV
[](https://gitter.im/unrealcv/unrealcv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](http://docs.unrealcv.org)
UnrealCV is a project to help computer vision researchers build virtual worlds using Unreal Engine (UE). It extends UE with a plugin by providing:
1. A set of UnrealCV commands to interact with the virtual world.
2. Communication between UE and an external program, such as Pytorch/Tensorflow.
UnrealCV can be used in two ways.
- The first one is using a compiled game binary with UnrealCV embedded. This is as simple as running a game, no knowledge of Unreal Engine is required.
- The second is installing the UnrealCV plugin into Unreal Engine and using the editor to build a new virtual world.
Please read [Tutorial: Getting Started](http://unrealcv.github.io/tutorial/getting_started.html) to learn using UnrealCV.
Images generated from the technical demo RealisticRendering
## New Features
- Support Unreal Engine 5.5.
- Call any Blueprint function from Python by `vbp [obj_name] [func_name] [arg1] [arg2] ...` command.
- Support RPC communication between Server and Client in Linux, higher FPS and more reliable.
- A set of new commands for camera control and object manipulation, please refer to [command system](https://docs.unrealcv.org/en/latest/reference/commands.html) for more details.
## How to install UnrealCV
To install the UnrealCV `Server`, you need:
1. Download the source code and place it on the ``Plugin`` folder of a C++ UE project.
2. Launch the C++ project with Visual Studio, UnrealCV will be compiled at the same time. Note that visual studio version should be compatible with your [UE version](https://dev.epicgames.com/documentation/en-us/unreal-engine/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine).
3. To check the success installation of UnrealCV, you can run ``vget /unrealcv/status`` in the console (Press **`** to display the console).
To install the UnrealCV `Client`, just run:
``pip install unrealcv``
> **🚩 Note:** More pre-built UE binaries with UnrealCV can be found in the [UnrealZoo](http://unrealzoo.site/).
## Citation
If you found this project useful, please consider citing our paper
```bibtex
@article{qiu2017unrealcv,
Author = {Weichao Qiu, Fangwei Zhong, Yi Zhang, Siyuan Qiao,Zihao Xiao, Tae Soo Kim, Yizhou Wang, Alan Yuille},
Journal = {ACM Multimedia Open Source Software Competition},
Title = {UnrealCV: Virtual Worlds for Computer Vision},
Year = {2017}
}
```
## Contact
If you have any suggestion or interested in using UnrealCV, please [contact us](http://unrealcv.github.io/contact.html).