Matija Kecman
85b6194f91
PiperOrigin-RevId: 833336577 Change-Id: Ib5f5ef33abe820796559a9da352360f57ea64bc8
2.7 KiB
MuJoCo Studio
MuJoCo Studio is the next iteration of the simulate application. The UI has been reimplemented using Dear ImGui and the default renderer has been switched to Filament. The application is still WIP, see the Future Work section for details.
Usage
Configure and build MuJoCo Studio by running this command from the top-level directory. Then follow the printed instructions to run the executable.
bash build.sh
[!NOTE] For now
build.shscript works on windows in a git bash shell.
Development
The build.sh script is intended to get you up and running quickly.
If you intend to develop the application you may prefer to work from an IDE:
-
Clion. You should be able to set this up to work with the cmake files we provide.
-
VSCode. We have found that Microsoft's CMake Tools extension works well.
-
Visual Studio. Follow these instructions.
Filament Rendering
Studio uses legacy OpenGL rendering by default but there is an option to use
Physically Based Rendering via Filament.
To enable Filament you need to -DMUJOCO_USE_FILAMENT=ON during the cmake
configuration step. The Filament renderer has multiple rendering backends,
on Linux OpenGL is the default but Vulkan can be used by also providing
the -DMUJOCO_USE_FILAMENT_VULKAN=ON option.
Also note that you will need to run the application from the folder containing the executable so that the expected materials/assets can be found.
[!WARNING] Filament rendering currently supported on Linux. We are actively working on bugs and build issues we've encountered on MacOS and Windows. Contributions improving support on those platforms are very welcome, your fixes may need to be applied in the upstream Filament GitHub repository.
Known Bugs
- MuJoCo Studio does not yet work using Wayland on Linux, use X11 instead.
Future Work
-
Stability and Robustness. We need user feedback to find and fix bugs.
-
UI/UX improvements. We have ported the simulate UI to make it easier to users to switch. We will be making further changes to make use of the flexibility offered by Dear ImGui (examples).
-
Python integration. As with simulate, we would like to make Studio usable via Python.