UESynth Documentation

Welcome to the UESynth documentation! UESynth is a powerful and user-friendly Unreal Engine plugin for synthetic data generation, inspired by UnrealCV.

Overview

UESynth provides a comprehensive API for controlling scenes, manipulating objects, and capturing a wide variety of data modalities for use in computer vision and machine learning research.

Key Features

• Multi-modal Data Capture: Capture RGB, depth, segmentation masks, surface normals, and more
• Scene and Object Manipulation: Programmatically control objects, lighting, and materials
• gRPC-based API: A modern, robust, and easy-to-use API for external clients (Python)
• Bidirectional Streaming: High-performance streaming for real-time simulation and data capture
• Scene Randomization: Tools for domain randomization to create diverse datasets
• Editor Integration: User-friendly interface within the Unreal Editor

Documentation Structure

This documentation is organized into the following sections:

🚀 Getting Started

• Installation
• Quick Start
• Configuration

📖 User Guides

• Basic Usage
• Advanced Features
• Scene Randomization
• Data Collection Workflows

📚 API Reference

• Synchronous Client
• Asynchronous Client
• Camera Controls
• Object Manipulation
• Data Capture

💡 Examples

• Basic Examples
• Async Streaming
• Batch Processing
• Real-time Simulation

⚡ Performance

• Optimization Guide
• Benchmarks
• Best Practices

🤝 Contributing

Guidelines for contributing to the UESynth project.

Quick Links

• GitHub Repository
• Installation Guide
• Quick Start Tutorial
• API Reference

Support

If you encounter any issues or have questions, please:

• Check the documentation
• Search existing issues
• Create a new issue