SponsorBlock README

The project's README from github.com/ajayyy/SponsorBlock. As one markdown file: README.md.

Logo
Logo by @munadikieh

SponsorBlock

Download: Chrome/Chromium | Firefox | Android | Edge | Safari for MacOS and iOS | Website | Stats

3rd-Party Ports: MPV | Kodi | Chromecast | iOS

Badge Badge Badge Badge Badge

SponsorBlock is an open-source crowdsourced browser extension to skip sponsor segments in YouTube videos. Users submit when a sponsor happens from the extension, and the extension automatically skips sponsors it knows about. It also supports skipping other categories, such as intros, outros and reminders to subscribe.

It also supports Invidious.

Translate: Crowdin

Important Links

See the Wiki for important links.

Server

The backend server code is available here: https://github.com/ajayyy/SponsorBlockServer

To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database (License). If you are planning on using the database in another project, please read the API Docs page for more information.

The dataset and API are now being used in some ports as well as a neural network.

API

You can read the API docs here.

Building

See CONTRIBUTING.md

Credit

The awesome Invidious API was previously used, and the server is now using NewLeaf to get video info from YouTube.

Originally forked from YTSponsorSkip, but very little code remains.

Icons made by:

License

This project is licensed under GNU GPL v3 or any later version

SponsorBlock (ajayyy/SponsorBlock)

Searching Database…

What is this?SponsorBlock is an open-source, crowdsourced browser extension that skips sponsor segments in YouTube videos. Users submit the timestamps where a sponsor plug happens, and the extension automatically skips those segments for everyone else.
Do I need an account or API key to use it?No signup is required to use the extension itself; it just needs to talk to the public SponsorBlock backend/database to fetch and submit segments.
Does skipping always work perfectly?Skipping relies on crowdsourced submissions, so coverage depends on whether a video's sponsor segments have already been reported by someone else; it's not a guaranteed universal filter.
Does it only work in the official browser, or on forks too?It works across Chromium-based browsers (Chrome, Opera) and Firefox, and it also integrates with Invidious, the alternative YouTube frontend.
Where does the backend server code live?The backend server code is maintained in a separate repository linked from the README, and it uses NewLeaf to fetch video info from YouTube.
Was this built from scratch?No, it was originally forked from YTSponsorSkip, though very little of the original code remains today.
Creator
ajayyy
Size
17 MB
Stars
13.9K
Age
7y
Commits · 90 Days