|
1 | 1 | Ros2 For Unity
|
2 |
| -============= |
| 2 | +=============== |
3 | 3 |
|
4 | 4 | ROS2 For Unity is a high-performance communication solution to connect Unity3D and ROS2 ecosystem in a ROS2 "native" way. Communication is not bridged as in several other solutions, but instead it uses ROS2 middleware stack (rcl layer and below), which means you can have ROS2 nodes in your simulation.
|
5 | 5 | Advantages of this module include:
|
@@ -41,13 +41,17 @@ Please see OS-specific instructions:
|
41 | 41 |
|
42 | 42 | ## Usage
|
43 | 43 |
|
44 |
| -0. Perform building steps described in the OS-specific readme or download pre-built Unity package. |
45 |
| -1. Open or create Unity project. |
46 |
| -1. Go to Assets in the menu bar (at the top of the Unity Window). |
47 |
| -2. Select `Import Package` → `Custom Package`. |
48 |
| -3. In the file browser, select the .unitypackage file built by `create_unity_asset` script (by default located in `install/unity_package`) and follow the instructions on the screen. |
49 |
| -4. In the project tab, navigate to `Assets/Ros2ForUnity/Scripts`, select any object in the hierarchy tab, and add a script component by dragging `ROS2TalkerExample.cs` to the inspector tab. ROS2UnityComponent dependency will be added automatically (see the screenshot below). |
50 |
| -5. Select another object in the hierarchy tab and add repeat the previous step using `ROS2ListenerExample.cs`. |
51 |
| -6. Once you start the project in Unity, you should be able to see two nodes talking with each other in Unity Editor's console or use `ros2 node list` and `ros2 topic echo /chatter` to verify ros2 communication. |
| 44 | +1. Perform building steps described in the OS-specific readme or download pre-built Unity package. |
| 45 | +2. Open or create Unity project. |
| 46 | +3. Go to Assets in the menu bar (at the top of the Unity Window). |
| 47 | +4. Select `Import Package` → `Custom Package`. |
| 48 | +5. In the file browser, select the .unitypackage file built by `create_unity_asset` script (by default located in `install/unity_package`) and follow the instructions on the screen. |
| 49 | +6. In the project tab, navigate to `Assets/Ros2ForUnity/Scripts`, select any object in the hierarchy tab, and add a script component by dragging `ROS2TalkerExample.cs` to the inspector tab. ROS2UnityComponent dependency will be added automatically (see the screenshot below). |
| 50 | +7. Select another object in the hierarchy tab and add repeat the previous step using `ROS2ListenerExample.cs`. |
| 51 | +8. Once you start the project in Unity, you should be able to see two nodes talking with each other in Unity Editor's console or use `ros2 node list` and `ros2 topic echo /chatter` to verify ros2 communication. |
52 | 52 |
|
53 | 53 | 
|
| 54 | + |
| 55 | +## Acknowledgements |
| 56 | + |
| 57 | +Open-source release of ROS2 For Unity was made possible through cooperation with [Tier IV](https://tier4.jp). Thanks to encouragement, support and requirements driven by Tier IV the project was significantly improved in terms of portability, stability, core structure and user-friendliness. |
0 commit comments