chenlin/Mujoco_WASM
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the studio/README.md to summarize platform support.

Browse Source 
PiperOrigin-RevId: 837038187
Change-Id: I00882e0a9882947af7c684e2d5521356ad1468ce
This commit is contained in:
Matija Kecman
2025-11-26 02:56:57 -08:00
committed by Copybara-Service
parent 4ce0ee2011
commit 011166a13a
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/experimental/studio/README.md
+17 -8
View File
@@ -5,6 +5,21 @@ application. The UI has been reimplemented using [Dear ImGui](https://github.com
and the default renderer has been switched to Filament. The application is and the default renderer has been switched to Filament. The application is
still WIP, see the [Future Work](#future-work) section for details. still WIP, see the [Future Work](#future-work) section for details.
> [!CAUTION]
> Studio is a work in progress, the current state of platform support summarized
> in this table:
>
> | Renderer | Linux X11 | Linux Wayland | MacOS | Windows |
> | :------------- | :-------: | :-----------: | :---: | :-----: |
> | Filament | ✅ | ❌ | ❌ | ❌ |
> | Classic OpenGL | ✅ | ❌ | ❌ | ✅ |
>
> Note that Studio currently [compiles](../../../.github/workflows/build.yml)
> on all platforms but the crosses indicated crashes at runtime. We are actively
> working to support all the above platforms very soon, if you beat us too it
> contributions are very welcome! Note that your fixes may need to be applied in
> the upstream [Filament](https://github.com/google/filament) repository.
## Usage ## Usage
Configure and build MuJoCo Studio by running this command from the top-level Configure and build MuJoCo Studio by running this command from the top-level
@@ -14,8 +29,8 @@ directory. Then follow the printed instructions to run the executable.
bash build.sh bash build.sh
``` ```
> [!NOTE] For now [`build.sh`](build.sh) script works on windows in a git bash > [!NOTE]
> shell. > For now [`build.sh`](build.sh) script works on windows in a git bash shell.
## Development ## Development
@@ -44,12 +59,6 @@ the `-DMUJOCO_USE_FILAMENT_VULKAN=ON` option.
Also note that you will need to run the application from the folder containing 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. 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](https://github.com/google/filament)
> GitHub repository.
## Known Bugs ## Known Bugs
* MuJoCo Studio does not yet work using Wayland on Linux, use X11 instead. * MuJoCo Studio does not yet work using Wayland on Linux, use X11 instead.