SponsorBlock/README.md
2020-08-31 10:12:40 -04:00

5.7 KiB

Logo
Logo by @munadikieh

SponsorBlock

Download: Chrome/Chromium | Firefox | Android | Website | Stats

Unofficial Ports: MPV | Kodi | iOS

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.

Also supports Invidio.us.

Translate: Crowdin

Important Links

See the Wiki for important links.

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 (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.

A previous project attempted 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 starting from a crowd-sourced system instead.

API

You can read the API docs here.

Building

Rename config.json.example to config.json and adjust configuration as desired.

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

Run npm run build to generate a Chrome extension.

Use npm run build:firefox to generate a Firefox extension.

The result is in dist. This can be loaded as an unpacked extension

Developing with a clean profile

Run npm run dev to run the extension using a clean browser profile with hot reloading. Use npm run dev:firefox for Firefox. This uses web-ext run.

Attribution Generation

If you contribute and add a dependency, update the attribution file using the following steps:

Make sure the attribution generator is installed: npm i -g oss-attribution-generator

generate-attribution
mv ./oss-attribution/attribution.txt ./public/oss-attribution/attribution.txt

Credit

The awesome Invidious API was previously used.

Originally forked from YTSponsorSkip, but zero code remains.

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