Skip to content

dutchdronesquad/rh-youtube-chapters

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

196 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Project Stage Project Maintenance License

RHCP Badge RHFest

YouTube Chapters

When you publish a video on YouTube, you have the option to add a chapters list in the description, which divides the video timeline into chapters for easier navigation.

This RotorHazard plugin will help you to generate a chapters list based on the start time of each heat. Ideal for when you want to publish the VOD of your livestream afterwards and make it easier for viewers to navigate to a specific round / heat of the race.

Functionality

alt plugin overview

  • Every time a heat starts it will be logged as a chapter entry.
  • Based on the start time, the plugin will generate a list of chapters for YouTube.
  • Export a txt file where you can copy/paste the chapters into your YouTube video description.

Installation

Warning

This plugin is still in development and only works currently with the dev branch of RotorHazard.

Community Plugins (GUI)

This method is the easiest way to install the plugin.

The YouTube Chapters plugin is available as a community plugin for RotorHazard. You can install it directly from the RotorHazard web interface.

  1. Go to the Settings page in RotorHazard.
  2. Click on the Plugins tab and click on the Browse Community Plugins (online only) button.
  3. Search for YouTube Chapters in the list of available plugins.
  4. Click on the Install button to install the plugin.
  5. After the installation is complete, restart RotorHazard to load the plugin.

Install script (CLI)

This method is for more advanced users who are comfortable with the command line.

  1. Install the YouTube Chapters plugin, by running the following command in your terminal at the device where RotorHazard is installed:
bash -c "$(curl -fsSL https://short.dutchdronesquad.nl/install-youtube-chapters)"
  1. You'll be prompted to choose between stable or development:
    • stable: Choose this option if you want to install a stable release.
      • The script will fetch the last 5 stable releases from GitHub.
      • Choose the version you want to install and press enter.
    • development: Choose this option if you want to install the latest development version.
      • The script will fetch the main branch from GitHub.
  2. If the plugin is already in RotorHazard, you'll be prompted to update it.
    • Choose y (yes) to update the plugin.
    • Choose n (no) to exit the script.
  3. When the installation is finished, restart RotorHazard to load the plugin.

Getting started

  1. Note when you started live streaming (local time).
  2. Do the race timing as you are used to, each heat start will be logged automatically.
  3. When you are done, fill in the start time and confirm with the Set Start Time button.
  4. Click on Export Chapters to generate a txt file with the chapters.
    • You will see the download link after page refresh under Exported Chapters List.
  5. Don't forget to reset the logging every time you have a new event.

Setting up development environment

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

You need the following tools to get started:

  • uv - A python virtual environment/package manager
  • Python 3.11 (or higher) - The programming language

Installation

  1. Clone the repository
  2. Install all dependencies with UV. This will create a virtual environment and install all dependencies
uv sync --all-groups

Prek check

As this repository uses the prek framework, all changes are linted and tested with each commit.

To install the prek check, run:

uv run prek install

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

uv run prek run --all-files

To manual run only on the staged files, use the following command:

uv run prek run

Credits

This plugin has been requested by Dutch Drone Racing (DDR) and developed by Dutch Drone Squad (DDS).

License

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

About

πŸ“‹ YouTube chapters plugin made for RotorHazard

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors