[Unity plugin] Reference the tutorial in the Unity plugin docs #2249
Conversation
…on of the existing sections.
doc/unity.rst
Outdated
| complete scene recreation. This can be expensive for large models or if it happens frequently. We expect this | ||
| performance limitation to be lifted in future versions of MuJoCo. | ||
| MuJoCo library has functionality for dynamic scene editing (through `mjSpec | ||
| <https://mujoco.readthedocs.io/en/stable/programming/modeledit.html#model-editing>`_), however, this is not yet |
There was a problem hiding this comment.
There was a problem hiding this comment.
No, sorry. You should use an RST link here. Like this
Line 30 in e9a2f05
There was a problem hiding this comment.
Thanks, pushed it
doc/unity.rst
Outdated
| ______________ | ||
|
|
||
| The current version of the Unity package does not support loading MJCF scenes that use MuJoCo plugins such as | ||
| ``elasticity``. Adding basic functionality to do this will be part of an upcoming release. |
There was a problem hiding this comment.
There was a problem hiding this comment.
Could you please take a look at the current state? I tried to include an RST link for the engine plugin page and a html link to the repo readme.
I also added a warning as promised in #2261.
doc/unity.rst
Outdated
| @@ -10,6 +10,9 @@ runtime to use the MuJoCo physics engine. Users can import MJCF files and edit | |||
| relies on Unity for most aspects -- assets, game logic, simulation time -- but uses MuJoCo to determine how objects | |||
| move, giving the designer access to MuJoCo's full API. | |||
|
|
|||
| An example project using MuJoCo's Unity plugin in a set of introductory tutorials is available at | |||
| https://github.com/Balint-H/mj-unity-tutorial. | |||
There was a problem hiding this comment.
please make this a proper RST link
There was a problem hiding this comment.
There are a couple other places in the original file that uses direct urls, should I swap those as well?
There was a problem hiding this comment.
Better late than never, finally added the RST links.
There was a problem hiding this comment.
Can you remove the trailing whitespaces in unity.rst? There are 3, I believe
Add a link to the mj-unity tutorial, and update the information provided to reflect the features added over time.