{"id":20563279,"url":"https://github.com/gazebosim/gz-rviz","last_synced_at":"2025-04-14T14:42:35.672Z","repository":{"id":40422613,"uuid":"243482979","full_name":"gazebosim/gz-rviz","owner":"gazebosim","description":"ROS 2 visualization using Gazebo Libraries","archived":false,"fork":false,"pushed_at":"2023-05-31T16:48:23.000Z","size":387,"stargazers_count":59,"open_issues_count":13,"forks_count":9,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-28T03:41:16.195Z","etag":null,"topics":["3d","gazebo","hacktoberfest","ign","ign-gui","ign-rendering","ign-rviz","ignition","ignition-rendering","ignition-rviz","plugin","rendering","robot","robotics","ros","ros2","rviz","visualization"],"latest_commit_sha":null,"homepage":"https://gazebosim.org","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gazebosim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-27T09:40:32.000Z","updated_at":"2025-03-19T10:25:37.000Z","dependencies_parsed_at":"2022-08-09T20:00:47.272Z","dependency_job_id":null,"html_url":"https://github.com/gazebosim/gz-rviz","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-rviz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-rviz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-rviz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazebosim%2Fgz-rviz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gazebosim","download_url":"https://codeload.github.com/gazebosim/gz-rviz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248898612,"owners_count":21179804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","gazebo","hacktoberfest","ign","ign-gui","ign-rendering","ign-rviz","ignition","ignition-rendering","ignition-rviz","plugin","rendering","robot","robotics","ros","ros2","rviz","visualization"],"created_at":"2024-11-16T04:17:26.891Z","updated_at":"2025-04-14T14:42:35.642Z","avatar_url":"https://github.com/gazebosim.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ignition RViz\n\n[RViz](http://wiki.ros.org/rviz) is a 3D visualization tool for robots using ROS.\n\nIgnition RViz offers functionality similar to RViz, and is developed using\n[Ignition](https://ignitionrobotics.org/) libraries.\n\n### Build Status\n\n* ROS versions: Rolling (Humble)\n* Ignition versions: Fortress\n\n[![Ignition RViz CI](https://github.com/ignitionrobotics/ign-rviz/actions/workflows/ci.yml/badge.svg)](https://github.com/ignitionrobotics/ign-rviz/actions/workflows/ci.yml)\n\nHead over to the [wiki](https://github.com/ignitionrobotics/ign-rviz/wiki) to get detailed description of the project.\n\n### Requirements\n\n- [ROS 2 Foxy or Rolling](https://docs.ros.org/en/rolling/Releases.html)\n- [Ignition Fortress](https://ignitionrobotics.org/docs/)\n\t- [Ignition Common](https://ignitionrobotics.org/libs/common)\n\t- [Ignition GUI](https://ignitionrobotics.org/libs/gui)\n\t- [Ignition Math](https://ignitionrobotics.org/libs/math)\n\t- [Ignition Rendering](https://ignitionrobotics.org/libs/rendering)\n- [Qt5](https://www.qt.io/)\n- Additional QML modules required for GPS Plugin\n  - [QtPositioning](https://doc.qt.io/qt-5/qtpositioning-index.html) (`qml-module-qtpositioning`)\n  - [QtLocation](https://doc.qt.io/qt-5/qtlocation-index.html) (`qml-module-qtlocation`)\n\n### Setup the repository\n\n**Create a colcon workspace**\n\n```bash\nmkdir -p ~/colcon_ws/src\ncd ~/colcon_ws/src\n```\n\n**Clone the repository**\n\n```bash\ngit clone https://github.com/ignitionrobotics/ign-rviz.git\n```\n\n**Choose an Ignition version**\n\n```bash\nexport IGNITION_VERSION=\u003cignition\u003e\n```\n\nWhere `\u003cignition\u003e` should be `fortress`.\n\n\u003e You only need to set this variable when compiling, not when running.\n\n**Build ign-rviz**\n\nGo to the root of your colcon workspace\n\n```bash\ncd ../\n```\n\nSource ROS2, where `\u003cdistro\u003e` is `rolling`:\n\n```bash\nsource /opt/ros/\u003cdistro\u003e/setup.bash  # If using bash\nsource /opt/ros/\u003cdistro\u003e/setup.zsh   # If using zsh\n```\n\nBuild ign-rviz\n\n```bash\ncolcon build\n```\n\n### Launch ign-rviz\n\nIgnition Rviz can be launched using the following command\n\n```bash\n# Source the workspace\nsource install/setup.zsh\n\n# Launch ign-rviz\nros2 launch ign_rviz rviz.launch.py\n```\n\n### Instruction to generate documentation\n\nProject documentation can be generated with the help of doxygen using the following commands.\n\n```bash\ncd ~/colcon_ws/src/ign-rviz/docs/\n\n# Generate documentation\ndoxygen rviz.doxyfile\n\n# View documentation\nfirefox ./html/index.html\n```\n\n### Instruction to use plugins\n- **ImageDisplay plugin**\n    1. Launch a `sensor_msgs/msg/Image` publisher. For example\n       ```bash\n       # Source ROS2\n       ros2 run image_tools cam2image\n       ```\n    2. Launch ign-rviz as mentioned above\n    3. Load an `ImageDisplay` plugin and select the published topic.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazebosim%2Fgz-rviz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgazebosim%2Fgz-rviz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazebosim%2Fgz-rviz/lists"}