Skip to content

Installation

Install the Stream Overlays plugin using one of two methods: the RotorHazard web interface (recommended) or a command-line script.

The easiest way to install Stream Overlays is through RotorHazard's built-in plugin manager.

Prerequisites

  • RotorHazard 4.0.x or newer
  • Internet connection on the RotorHazard device
  • Admin access to RotorHazard web interface

Installation Steps

  1. Open RotorHazard web interface in your browser
  2. Navigate to Settings → Plugins tab
  3. Click Browse Community Plugins (requires internet connection)
  4. Search for Stream Overlays in the plugin list
  5. Click the Install button next to the plugin
  6. Wait for installation to complete (progress bar will appear)
  7. Restart RotorHazard to activate the plugin

Installation Complete

After restarting, you should see Stream Overlays listed in the Plugins tab. Navigate to the Streams page to access overlay URLs.

Verification

To verify the plugin is working:

  1. Go to the Streams page in RotorHazard
  2. Look for Stream Overlays panels (Apex, DDS, LCDR)
  3. Click any overlay link to test it in your browser

Method 2: Install Script (Advanced)

For users comfortable with the command line or deploying to headless systems.

Prerequisites

  • SSH/terminal access to the RotorHazard device
  • curl installed (usually pre-installed on Linux/macOS)
  • Internet connection

Installation Steps

  1. Connect to your RotorHazard device via SSH or open a terminal

  2. Run the installation script:

    bash -c "$(curl -fsSL https://short.dutchdronesquad.nl/install-overlays-plugin)"

  3. Choose a version:

    • Select stable when prompted
    • The script shows the last 5 releases from GitHub
    • Choose your desired version (usually the latest)
    • Press Enter to confirm
    • Select development when prompted
    • Installs the latest main branch code
    • May include unreleased features but less stable
    • Use for testing or contributing

  4. Update existing installation (if applicable):

    • If the plugin is already installed, you'll be asked to update
    • Choose y (yes) to overwrite with the new version
    • Choose n (no) to exit without changes

  5. Restart RotorHazard:

    sudo systemctl restart rotorhazard

    Or manually stop/start RotorHazard if not using systemd.

What the Script Does

The install script automates:

  • Fetching release data from GitHub
  • Downloading the plugin files
  • Extracting to RotorHazard's plugins/ directory
  • Cleaning up temporary files
  • Verifying installation integrity

Troubleshooting Script Installation

Script fails to download:

Check internet connectivity and GitHub availability:

curl -I https://api.github.com

Permission errors:

Run the script with appropriate permissions or use sudo:

sudo bash -c "$(curl -fsSL https://short.dutchdronesquad.nl/install-overlays-plugin)"

Plugin directory not found:

Ensure RotorHazard is installed in the default location. The script looks for:

  • /home/pi/RotorHazard/ (Raspberry Pi)
  • ~/RotorHazard/ (generic Linux)

Post-Installation

After installing the plugin, configure your overlays:

🚀 Quick Start

Follow the Quick Start guide for a 5-minute setup walkthrough

🖥️ OBS Setup

Configure browser sources and optimize settings

🎨 Browse Themes

Explore the overlay catalog with all available themes

Updating the Plugin

Via Community Plugins

  1. Go to Settings → Plugins → Browse Community Plugins
  2. Find Stream Overlays
  3. If an update is available, click Update
  4. Restart RotorHazard

Via Install Script

Simply re-run the installation script and choose y (yes) to overwrite:

bash -c "$(curl -fsSL https://short.dutchdronesquad.nl/install-overlays-plugin)"

Uninstalling

Via RotorHazard Interface

  1. Go to Settings → Plugins
  2. Find Stream Overlays in the installed plugins list
  3. Click Uninstall
  4. Restart RotorHazard

Manual Removal

Delete the plugin directory:

rm -rf ~/RotorHazard/src/server/plugins/stream_overlays

Then restart RotorHazard.

Stream Displays (4.2.x+)

RotorHazard 4.2.x+ Feature

Stream Overlays automatically adds panels to the Streams page for easy URL access.

Finding Overlay URLs

Instead of manually constructing URLs, use the built-in Stream Displays:

  1. Navigate to Streams page in RotorHazard
  2. Scroll to the Stream Overlays section
  3. Click any overlay link to preview it
  4. Copy the URL from your browser's address bar
  5. Paste into OBS browser source

Stream displays showing overlay panels

This feature simplifies setup by providing clickable links for all available overlays organized by theme.

Need Help?