Crate mujoco_rs

Crate mujoco_rs 

Source
Expand description

§MuJoCo-rs

A wrapper around the MuJoCo C library with a Rust-native viewer. If you’re familiar with MuJoCo, this should be pretty straightforward to use as the wrappers mainly encapsulate some C structs or just rename them to match the Rust’s PascalCase style.

The main structs are wrappers::mj_model::MjModel and wrappers::mj_data::MjData. These two structs (and some other) wrap the C structure in order to achieve memory safety.

Their fields aren’t publicly exposed and can instead be manipulated through views (e.g., MjData::joint and then wrappers::mj_data::MjJointDataInfo::view). To access the wrapped attributes directly, call the corresponding ffi() methods (e.g., MjData::ffi)

§MuJoCo version

MuJoCo-rs relies on MuJoCo 3.3.7.

§Documentation

A more guided documentation can be obtained here.

§Missing library errors

Guided documentation also contains information on how to configure MuJoCo. MuJoCo-rs cannot fully configure it itself due to MuJoCo being a shared C library. As a result you may encounter load-time errors about missing libraries.

Information on how to configure MuJoCo and resolve these issues is available here.

§3D viewer

The Rust-native viewer is available (viewer::MjViewer), as well as the MuJoCo’s original C++ one (cpp_viewer::MjViewerCpp). The C++ viewer however requires manual compilation of a patched MuJoCo repository, like described here.

§Model editing

MjModel can be procedurally generated through the model editing module. The specification representing the model is wrappers::mj_editing::MjSpec

§Functions

Most functions are wrapped under methods at different structs. Some functions are available under the wrappers::fun module.

If a certain function can’t be found, you can use the raw FFI bindings, available under the mujoco_c module. Note that to access the lower-level ffi structs inside of wrappers, ffi() or ffi_mut() must be called (e.g., MjData::ffi and MjModel::ffi).

§Cargo features

This crate has the following public features:

  • viewer: enables the Rust-native MuJoCo viewer.

    • viewer-ui: enables the (additional) user UI within the viewer. This also allows users to add custom egui widgets to the viewer.

  • cpp-viewer: enables the Rust wrapper around the C++ MuJoCo viewer. This requires static linking to a modified fork of MuJoCo, as described in installation.

  • renderer: enables offscreen rendering for writing RGB and depth data to memory or file.

    • renderer-winit-fallback: enables the invisible window fallback (based on winit) when offscreen rendering fails to initialize. Note that true offscreen rendering is only available on Linux platforms when the video driver supports it. On Windows and MacOS, this feature must always be enabled when the renderer feature is enabled.

  • auto-download-mujoco: MuJoCo dependency will be automatically downloaded to the specified path.

    • This is only available on Linux and Windows.
    • The environmental variable MUJOCO_DOWNLOAD_DIR must be set to the absolute path of the download location.
    • Downloaded MuJoCo library is still a shared library. See installation for information on complete configuration.

By default, viewer, viewer-ui, renderer, and renderer-winit-fallback are enabled.

Modules§

cpp_viewer
mujoco_c
prelude
Commonly used items.
renderer
Module related to implementation of the MjRenderer.
util
Utility related data
viewer
Module related to implementation of the MjViewer. For implementation of the C++ wrapper, see crate::cpp_viewer::MjViewerCpp.
wrappers
A set of wrappers around the MuJoCo types and functions.

Functions§

get_mujoco_version
Returns the version string of the MuJoCo library.