Skip to content

Commit be93fa6

Browse files
authored
Updated Ubuntu instructions, added troubleshooting
1 parent dda3861 commit be93fa6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README-UBUNTU.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,24 @@ This readme contains information specific to Ubuntu 20.04. For general informati
66

77
### Prerequisites
88

9-
To prepare your machine for `ROS2 For Unity` build please follow step by step the `ros2cs` [Prequisites section](https://github.com/RobotecAI/ros2cs/blob/master/README-UBUNTU.md#prequisites).
10-
Prepairing environment with `ros2cs` instruction is ***crucial*** for failure-free Unity Asset generation.
11-
12-
**Ommitting any of the steps mentioned above will result in a build failure!**
9+
Start with installation of dependencies. Make sure to complete each step of `ros2cs` [Prequisites section](https://github.com/RobotecAI/ros2cs/blob/master/README-UBUNTU.md#prequisites).
1310

1411
### Steps
1512

1613
* Clone this project.
1714
* You need to source your ROS2 installation (`source /opt/ros/foxy/setup.bash`) before you proceed, for each new open terminal. It is convenient to include this command in your `~/.profile` file.
18-
* Run `pull_repositories.sh`. This will pull `ros2cs` as well as your custom messages. You will be asked for gitlab credentials, so please fill your information.
15+
* Run `pull_repositories.sh`. This will pull `ros2cs` as well as your custom messages. You might be asked for gitlab credentials. Remember to **pull this repository with each update** (e.g. with `vcs pull`).
1916
* Run `build.sh` script.
2017
* You can build tests by adding `--with-tests` argument to `build` command.
2118
* It invokes `colcon_build` with `--merge-install` argument to simplify libraries installation.
2219
* It deploys built plugins into the Asset directory. Note that only plugins built for the current platform will be deployed (there is no cross-compilation).
2320
* It prepares Unity Asset that is ready to import into your Unity project.
2421
* Run `create_unity_asset.sh -u <your-path-to-unity-editor-executable>` to generate .unitypackage file in `install/unity_package`
2522

23+
#### Troubleshooting
24+
25+
If you see `"No ROS environment sourced. You need to source your ROS2 (..)"` message in Unity3D Editor, it means your environment was not sourced properly. This could happen if you run Unity but it redirects to Hub and ignores your console environment variables (this behavior can depend on Unity3D version). In such case, run project directly with `-projectPath` or add ros2 sourcing to your `~/.profile` file (you need to re-log for it to take effect).
26+
2627
## OS-Specific usage remarks
2728

2829
You can run Unity Editor or App executable from GUI (clicking) or from terminal as long as ROS2 is sourced in your environment.

0 commit comments

Comments
 (0)