This release is a pre-release and may not be stable for production use.
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
News
- 2026-06-02: Adopted for the MuscleMimic live demo [Demo]
- 2026-05-06: Adopted for the GentleHumanoid live demo [Demo, X]
- 2026-04-08: Featured in the MuJoCo README
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 bundled demo with the mjswan CLI (after installing mjswan[examples]):
mjswan demo # runs the default demo
mjswan demo --list # see all available demos
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mjswan-0.8.1b0.tar.gz.
File metadata
- Download URL: mjswan-0.8.1b0.tar.gz
- Upload date:
- Size: 22.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0acc05d129d908473efee9e0047023369ee9b3794726a507e25613fac4e363be
|
|
| MD5 |
9eb6d7980c7e13e5df98e077c98009f7
|
|
| BLAKE2b-256 |
1c77e3529d8ff2fd457fd4431cc2f84ffb2a7aa8e41d508b827f5950e4743e8a
|
File details
Details for the file mjswan-0.8.1b0-py3-none-any.whl.
File metadata
- Download URL: mjswan-0.8.1b0-py3-none-any.whl
- Upload date:
- Size: 23.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e6355d3f6786e497e858a67e521608266034be68e1112215ed2bf2f72ea175f
|
|
| MD5 |
2c748b90148d596e7cdd2a4eaf105307
|
|
| BLAKE2b-256 |
9b4a9d78f1d3b612380babf8c62a891d22ffb38b310dbb1fde8dbd4a2ce6a553
|
