gazebosim/gz-gui
Plugins tutorial should be improved to be more new user friendly
Open
#643 opened on Sep 16, 2024
good first issue
Repository metrics
- Stars
- (103 stars)
- PR merge metrics
- (PR metrics pending)
Description
* **Test enviornment**
```text
CPU: Ryzen 5 5600x, Ram: 32GB @ 3200 Mhz, GPU: RTX 3080
Clean copy of Ubuntu 24.04 Humble
ROS 2 Jazzy Jalisco full desktop
```
- Summary
- In my humble opinion this tutorial may need to be presented in context of a more hands-on example. The current version was hard to follow, specially as a newcomer to Gazebo.
- Add a note stating if built from source,
GZ_GUI_PLUGIN_PATHcan be set as follows
cd ~/workspace/src/gz-gui export GZ_GUI_PLUGIN_PATH=${HOME}/workspace/src/gz-gui echo $GZ_GUI_PLUGIN_PATH gz gui -s ImageDisplay- Tutorial does not show how to set
GZ_GUI_PLUGIN_PATH. Nor it states the user had to change direcotry intosrc/gz-guidirectory before this command would work correctly
- Issues
- Users needs to change directory to
~/workspace/src/gz-gui. Without this step, invoking any of example commands withgz gui -cprefix throwsXMLErrorerror. - The tutorial page has multiple
\subpagereferences that leads to nowhere. - Commands for Topic Viewer, Topic Stats, Requesters and Responders did not work.
- Users needs to change directory to
Originally posted by @Mechazo11 in https://github.com/gazebosim/gazebo_test_cases/issues/1323#issuecomment-2333043686