XRFeitoria is a rendering toolbox for generating synthetic data photorealistic with ground-truth annotations. It is a part of the OpenXRLab project.
https://github.com/openxrlab/xrfeitoria/assets/35397764/1e83bcd4-ae00-4c20-8188-3fe73f7c9c01
pip install xrfeitoria
Python >= 3.8
Unreal Engine >= 5.1
Blender >= 3.0
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
https://github.com/openxrlab/xrfeitoria/assets/35397764/430a7264-9337-4327-838d-08e9a354c277
https://github.com/openxrlab/xrfeitoria/assets/35397764/9c029eb7-a8be-4d11-890e-b2499ff22caa
The reference documentation is available on readthedocs.
There are several tutorials. You can read them here.
There are several samples. Please follow the instructions here.
Details can be found here.
If you want to publish plugins of your own, you can use the following command:
# install xrfeitoria first
cd xrfeitoria
pip install .
# build plugins for UE 5.1, UE 5.2, and UE 5.3 on Windows
python -m xrfeitoria.utils.publish_plugins build-unreal `
-u "C:/Program Files/Epic Games/UE_5.1/Engine/Binaries/Win64/UnrealEditor-Cmd.exe" `
-u "C:/Program Files/Epic Games/UE_5.2/Engine/Binaries/Win64/UnrealEditor-Cmd.exe" `
-u "C:/Program Files/Epic Games/UE_5.3/Engine/Binaries/Win64/UnrealEditor-Cmd.exe"
# build plugins for Blender
python -m xrfeitoria.utils.publish_plugins build-blender
Please refer to FAQ.
The license of our codebase is Apache-2.0. Note that this license only applies to code in our library, the dependencies of which are separate and individually licensed. We would like to pay tribute to open-source implementations to which we rely on. Please be aware that using the content of dependencies may affect the license of our codebase. Refer to LICENSE to view the full license.
If you find this project useful in your research, please consider cite:
@misc{xrfeitoria,
title={OpenXRLab Synthetic Data Rendering Toolbox},
author={XRFeitoria Contributors},
howpublished = {\url{https://github.com/openxrlab/xrfeitoria}},
year={2023}
}