About

This plugin adds new designed stream overlays to RotorHazard, which can be used in OBS (Open Broadcaster Software). A showcase of all overlays can be found here.

Do you have any wishes for a new overlay? Then leave your ideas, sketches or mood board in the discussions tab and maybe, we can develop it into something beautiful 😍

Documentation

Important

Please note, the default branch shows development code and may be ahead of the released version. For the latest stable version, switch to the release branch or use the installation instructions on the website.

The full documentation can be found at overlays.dutchdronesquad.nl. Where you can find all the information about the overlays, how to install them and how to use them in OBS.

Setting up development environment

This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

• Python 3.11+
• Poetry

Installation

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages.

Pre-commit

This repository uses the pre-commit framework, all changes are linted and tested with each commit. To setup the pre-commit check, run:

poetry run pre-commit install

And to run all checks and tests manually, use the following command:

poetry run pre-commit run --all-files

License

Distributed under the MIT License. See LICENSE for more information.