Skip to main content

A CLI for processing composite Wavefront OBJ files for use in MuJoCo

Project description

obj2mjcf

PyPI Python Version PyPI version

obj2mjcf is a CLI for proccessing composite Wavefront OBJ files for use in MuJoCo. It automatically:

  • Splits an OBJ file into sub-meshes that are grouped by the materials referenced in the OBJ's MTL file
  • Generates an MJCF XML file that is pre-filled with materials, meshes and geom elements referencing these OBJ files
  • Optionally generates a collision mesh by performing a convex decomposition of the OBJ using CoACD

obj2mjcf was used to process model meshes for MuJoCo Menagerie:

Motivation

As of June 2022, MuJoCo does not support composite OBJ files consisting of groups or objects (o or g OBJ tags) and only 1 material can be assigned per mesh. This means that you have to manually split your OBJ file into sub-meshes, a process that is tedious and error-prone. This tool is meant to automate this process.

Installation

Important. MuJoCo support for OBJ files is only available in versions 2.1.2 and above. Make sure you upgrade to the latest version via the Releases page.

The recommended way to install this package is via PyPI:

pip install --upgrade obj2mjcf

Usage

Type the following at the command line for a detailed description of available options:

obj2mjcf --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obj2mjcf-0.0.24.tar.gz (11.4 kB view hashes)

Uploaded Source

Built Distribution

obj2mjcf-0.0.24-py3-none-any.whl (10.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page