Skip to content

Commit 5e36c79

Browse files
Update README.md (#14)
* Adding instructions to add URDF package to Unity Project and Importing a robot. * Adding images for README and updating the .gitignore
1 parent 2364f7c commit 5e36c79

File tree

5 files changed

+26
-10
lines changed

5 files changed

+26
-10
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
/[Ll]ogs/
1111
/[Uu]ser[Ss]ettings/
1212

13-
# VIM Auto-generated files
14-
*~
13+
1514
# MemoryCaptures can get excessive in size.
1615
# They also could contain extremely sensitive data
1716
/[Mm]emoryCaptures/

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,34 @@
22

33
URDF Importer allows you to import a robot defined in [URDF](http://wiki.ros.org/urdf/XML) format in a Unity scene. URDF defines the geometry, visual meshes, kinematic and dynamic attributes of a Robot. Importer parses a URDF file and imports it into Unity using PhyX 4.0 articulation bodies.
44

5-
# Integrate URDF Importer into Unity Project
5+
# Using the Package
66

7-
- Clone or download the URDF Importer Repo
8-
- In your Unity project create a directory named `Plugins` in `Assets`
9-
- Copy the `URDFLibrary` and `UnityEditorScripts` directories into the newly created `Assets/Plugins` directory
10-
- Confirm the integration succeded by selecting `Assets` from the menu bar and look for the `Import Robot from URDF` option
7+
## Adding the URDF package
118

12-
# Importing a URDF into a Unity scene
9+
1. Open the Package Manager from Unity Menu. Click `Window -> Package Manager`. A new package manager window will appear.
10+
11+
2. Click on the `+` sign on the top left corner of the package manager window and click on `Add Package from Git URL`.
12+
13+
<img src = "images~/Package_manager_add.png">
14+
15+
3. Paste the link to the URDF github, https://github.com/Unity-Technologies/URDF-Importer.git repository in the text box and press `Enter`.
16+
17+
4. Click `Import URDF`.
18+
19+
## Importing the robot using URDF file
20+
21+
1. Copy the URDF and the associated files in the assets folder in the Project window. Make sure the [location](https://github.com/Unity-Technologies/Unity-Robotics-Hub/blob/main/tutorials/urdf_importer/urdf_appendix.md#file-hierarchy) of the mesh files is correct.
22+
23+
2. Right Click on the URDF file and click `Import Robot from URDF`.
24+
25+
<img src = "images~/URDF%20Menu.png" width = 40% height = 40%>
26+
27+
3. A window will appear with the Import settings for the Robot. First setting mentions the orientation of the mesh files. The second setting is used to select the algorithm to be used in Collision mesh Decomposition. For more information click [here](https://github.com/Unity-Technologies/Unity-Robotics-Hub/blob/main/tutorials/urdf_importer/urdf_appendix.md#convex-mesh-collider)
28+
29+
<img src = "images~/URDF%20Menu.png" width = 40% height = 40%>
30+
31+
4. Click `Import URDF`
1332

14-
- Find the `urdf` file of the robot you want to import in the `Assets` folder and select it
15-
- From the menu click `Assets` -> `Import Robot from URDF` or in file explorer right click on the selected file and click `Import Robot from URDF`
1633

1734
# Tutorials
1835

images~/Package_manager_add.png

191 KB
Loading

images~/URDF Import Menu.png

71.4 KB
Loading

images~/URDF Menu.png

504 KB
Loading

0 commit comments

Comments
 (0)