SponsorBlock/README.md
2019-12-29 20:52:40 -05:00

4.5 KiB

Logo
Logo by @munadikieh

SponsorBlock

Download: Chrome/Chromium | Firefox | Website | Stats

Unofficial Ports: MPV

Badge Badge Badge Badge Badge

SponsorBlock is an extension that will skip over sponsored segments of YouTube videos. SponsorBlock is a crowdsourced browser extension that lets anyone submit the start and end times of sponsored segments of YouTube videos. Once one person submits this information, everyone else with this extension will skip right over the sponsored segment.

Server

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

It is a simple Sqlite database that will hold all the timing data.

To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database.db. So, you can download a backup or get archive.org to take a backup for you if you want.

Hopefully this project can be combined with projects like this and use this data to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea.

API

You can read the API docs here.

Build Yourself

You can load this project as an unpacked extension. Make sure to rename the config.js.example file to config.js before installing.

There are also other build scripts available. Install npm, then run npm install in the repository.

Developing with a clean profile

Run npm run dev to run the extension using a clean browser profile with hot reloading (by default Firefox). This uses web-ext run.

Packing

Run npm run build to generate a packed extension.

Credit

The awesome Invidious API is used to grab the time the video was published.

Original code from YTSponsorSkip, but not much of the code is left.

Some icons made by Gregor Cresnar from www.flaticon.com and are licensed by CC 3.0 BY

Some icons made by Freepik from www.flaticon.com are licensed by CC 3.0 BY