Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 3.3 KB

README.md

File metadata and controls

84 lines (66 loc) · 3.3 KB
Raw

Grayjay YouTube source with DeArrow

Fork of https://gitlab.futo.org/videostreaming/plugins/youtube with DeArrow support.

Versions

Version Features QR Code
Standard
  • ✔ Replaces titles and thumbnails with crowdsourced ones from DeArrow
  • ✔ Works with FUTO's original Grayjay app
  • ❌ Cannot individually toggle DeArrow metadata per-video
Click to show/hide Scan to add source: standard release
Uses alternative metadata
Click to show/hide Scan to add source: uses-alternative-metadata release

QR Code

See Versions above.

Known Issues

  • Due to the way the Grayjay plugin API works, and limitations with the DeArrow API, this source will significantly slow down the time it takes to load videos. The subscriptions feed will take the biggest hit, with up to 30 API requests per channel subscribed.

Contributing

Thanks in taking interest on contributing to Grayjay YouTube source with DeArrow!

Please note that there are two main branches:

  • feature/dearrow is purely functional. It contains the logic to fetch data from DeArrow and replace video title and thumbnail accordingly.
    • This is meant to be as similar as possible with Grayjay's YouTube plugin to facilitate merging upstream changes.
  • with-dearrow is the true "main" branch. It integrates feature/dearrow, implements the split release type (standard and uses-alternative-metadata with Rollup builder), and has some other DX QoL features, CI/CD, etc.
    • It is the branch from which releases are based off.

If you wish to do changes to the DeArrow functionality for the standard release (new features, bug fixes), please target the feature/dearrow branch.
If you wish to do changes to the DeArrow functionality for the uses-alternative-metadata release, or do cosmetic/dev-centric changes (change source's logo, update GitHub workflow), please target the with-dearrow branch.

Commit messages

For both branches, we try to stick to conventional commits:

<type>[optional scope]: <description>

[optional body]

type can be: feat, fix, chore, docs, test, etc.