Contribute

We will be grateful if you help us mature UnrealCV.

Bug Reporting

If you find a bug in UnrealCV, you can search for similar issues in the Github first. If you still cannot solve the problem, please open an issue and describe the bug you encountered.

Requesting A New Feature

UnrealCV is still developing and we really want to make it more helpful to computer vision researchers. Please tell us your expectation about what can be done with UnrealCV. You are welcomed to open an issue and tell us what you want.

Pull Request

If you make improvements to UnrealCV,like fixing a bug or adding a new feature, please submit a pull request. Please make sure that you follow the syntax of UnrealCV. You will be greatly appreciated if you can fully describe the changes you have made.

Development Environment (Recommended)

To reduce setup differences between contributors, UnrealCV provides a VS Code dev container and workspace tasks.

Open the repository in VS Code.
Run Dev Containers: Reopen in Container.
Run the task Bootstrap: Dev Workspace from Terminal > Run Task.

This setup installs Python dependencies used by the client, docs, and tests, and provides consistent editor defaults and recommended extensions for C++/Python workflows.