mjswan 0.5.1

Browser-based MuJoCo simulation with real-time policy control

Real-time Interactive RL Simulation in Your Browser

mjswan is a powerful framework for creating interactive MuJoCo simulations with real-time policy control, running entirely in the browser. Built on top of mujoco wasm, onnxruntime, and three.js, it enables easy sharing of RL simulation demos as static sites, perfect for GitHub Pages hosting.

Check out the demo ― ttktjmt.github.io/mjswan

     

---

Features

• Real-time: Run mujoco simulations and policy control in real time.
• Interactive: Change the state of objects by applying forces.
• Cross-platform: Works seamlessly on desktop and mobile devices.
• VR Support: Native VR viewer support with WebXR.
• Client-only: All computation runs in the browser. No server for simulation is required.
• Easy Sharing: Host as a static site for effortless demo distribution (e.g., GitHub Pages).
• Portable: Embed the simulation in a web page or Google Colab notebook.
• Customizable: Visualize your mujoco models and onnx policies quickly.

Quick Start

mjswan can be installed with pip:

pip install mjswan  # or 'mjswan[dev]', 'mjswan[examples]'

or with npm:

npm install mjswan

You can run the demo using the uv command with the python package mjswan[examples]:

uv run main

The minimum python script for a sanity check:

import os, mujoco, mjswan

model_path = os.path.join(os.path.dirname(mujoco.__file__), "testdata", "model.xml")
mjspec = mujoco.MjSpec.from_file(model_path)

builder = mjswan.Builder()
builder.add_project(name="Sanity Check").add_scene(name="Test Model", spec=mjspec)
app = builder.build()
app.launch()

For detailed instructions, visit the documentation.

Third-Party Assets

mjswan incorporates mujoco models from the external sources in its demo. See the respective submodule for full details, including individual model licenses and copyrights. All models are used under their respective licenses. Please review and comply with those terms for any use or redistribution.

Robot Descriptions License ･ MuJoCo Playground License ･ MyoSuite License

Acknowledgments

This project was greatly inspired by the Facet project demo from the research group at Tsinghua University.
It is also built upon the excellent work of zalo/mujoco_wasm, one of the earliest efforts to run MuJoCo simulations in a browser.

License

This project is licensed under the Apache-2.0 License. When using mjswan, please retain attribution notices in the app to help other users discover this project.