unrealcv

library1.2.0pypypi✓ verified 85d ago

UnrealCV is a Python client for communicating with the UnrealCV plugin inside Unreal Engine, enabling computer vision research in photorealistic virtual environments. Current version 1.2.0, released irregularly.

ai-ml testing

pip install unrealcv

github ↗homepage ↗

INSTALL

IMPORT

SIG · UNREALCV

unrealcv

ai-mlpythonv1.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Client

✓ from unrealcv import Client

✗ from unrealcv.client import Client

In older versions (pre-1.0), Client was in the 'client' submodule. Now it's re-exported from the top-level package.

Connects to the UnrealCV plugin running in Unreal Engine (default port 9000) and requests the plugin status.

from unrealcv import Client client = Client(('localhost', 9000)) # If plugin is running in UE, connect and send hello client.connect() response = client.request('vget /unrealcv/status') print(response)

Debug

Known issues

gotchaClient.connect() may hang if no UE instance with UnrealCV plugin is running on the target host:port. Always use a timeout or check the connection.

fix

Use client.connect(timeout=5.0) or set socket timeout manually.

affects: all

breakingIn version 1.2.0, the 'Client' class no longer inherits from threading.Thread. Code relying on client.start() will break.

fix

Use client.connect() instead of client.start().

affects: >=1.2.0

gotchaThe request method returns a string, not a dict. You must parse JSON yourself if needed.

fix

import json; response = json.loads(client.request('vget /object/1/location'))

affects: all

Errors

Common errors & fixes

UnrealCV is not installed. Please install it using: pip install unrealcv

Missing dependency. The error is thrown by the import statement.

fix

Run 'pip install unrealcv' in your environment.

OSError: [WinError 10061] No connection could be made because the target machine actively refused it

Unreal Engine with UnrealCV plugin is not running or listening on the specified host:port.

fix

Start UE and ensure the UnrealCV plugin window shows 'Server started on port 9000' (default).

AttributeError: 'Client' object has no attribute 'start'

Code written for pre-1.2.0 API using client.start() instead of client.connect().

fix

Replace client.start() with client.connect().

Upgrade

Version history

1.2.0latest on PyPI · released Apr 15, 2026

Audit

Dependencies

pythonnetoptionalRequired on Windows for .NET interop with Unreal Engine (if using UE4/5 binaries). Use pip install pythonnet before importing.

PillowoptionalFor image processing utilities in examples.

numpyoptionalOften used for array manipulation of images and data received from UnrealCV.

Agent activity

18 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/unrealcv/unrealcv ↗

homepagehttps://github.com/unrealcv/unrealcv ↗