Skip to content

openxrlab/xrfeitoria

Repository files navigation


XRFeitoria

Documentation actions PyPI license

Introduction

XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations. It is a part of the OpenXRLab project.

XRFeitoria-Intro.mp4

Major Features

  • Support rendering photorealistic images with ground-truth annotations.
  • Support multiple engine backends, including Unreal Engine and Blender.
  • Support assets/camera management, including import, place, export, and delete.
  • Support a CLI tool to render images from a mesh file.

Installation

pip install xrfeitoria

Requirements

  • Python >= 3.8
  • (optional) Unreal Engine >= 5.1
    • Windows
    • Linux
    • MacOS
  • (optional) Blender >= 3.0
    • Windows
    • Linux
    • MacOS

Get-Started

CLI

xf-render --help

# render a mesh file
xf-render {mesh_file}

# for example
wget https://graphics.stanford.edu/~mdfisher/Data/Meshes/bunny.obj
xf-render bunny.obj
CLI-simple.mp4
CLI-complex.mp4