Skip to content

Desktop Launcher Setup.md

Latest commit

 

History

History
59 lines (44 loc) · 2.25 KB

Desktop Launcher Setup.md

File metadata and controls

59 lines (44 loc) · 2.25 KB

🖥️ ROS 2 Jazzy Desktop Launcher Setup

This guide explains how to set up a professional "One-Click" desktop launcher for this ROS 2 development environment.

📦 1. Prerequisite: Dev Containers Extension

If you are using a fork of VS Code (like Antigravity) that uses Open VSX, you may need to install the Dev Containers extension manually via VSIX to avoid connection errors.

  • Download Link: Dev Containers v0.456.0
  • Installation: Download the file and in your IDE select Extensions > ... > Install from VSIX.

🚀 2. Automatic Setup (Recommended)

The easiest way to set up your desktop icon is to run the interactive installer. It will auto-detect your IDE and create the icon for you with all paths correctly configured.

  1. Open your terminal in the Install_scripts/ folder.
  2. Run the installer: 
    ./install.sh
  3. Follow the on-screen instructions to select your preferred IDE.

🛠️ 3. Manual Setup (Optional)

If you prefer to set up the icon manually:

  1. Create a new file on your desktop named ROS2_Jazzy.desktop.
  2. Paste the following code into it (replace YOUR_PROJECT_PATH with the actual path to this folder):
[Desktop Entry]
Version=1.0
Type=Application
Name=ROS 2 Jazzy
Comment=Launch ROS 2 Jazzy Development Environment
Exec="YOUR_PROJECT_PATH/Install_scripts/start_dev.sh" antigravity
Icon=YOUR_PROJECT_PATH/Install_scripts/ros2_icon.png
Terminal=true
Categories=Development;
StartupNotify=true
Path=YOUR_PROJECT_PATH/

⚙️ 4. Configuration

Customizing the Container Name

The script is now fully dynamic. If you change the container name in docker-compose.yml, you only need to update the CONTAINER_NAME variable at the top of start_dev.sh.

📄 File Overview (Inside Install_scripts/)

  • setup_nvidia_toolkit.sh: Automated host setup for the NVIDIA Container Toolkit.
  • install.sh: Interactive installer for easy setup.
  • start_dev.sh: The main engine that starts Docker and launches the IDE.
  • ros2_icon.png: The official icon for the desktop launcher.
  • Desktop Launcher Setup.md: This guide.