Git Product home page Git Product logo

sponsorblock's Introduction

Logo
Logo by @munadikieh

SponsorBlock

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

3rd-Party Ports: MPV | Kodi | Safari for MacOS | 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 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.
Known chromium bug: Extension is not loaded properly on first start. Visit chrome://extensions/ and reload the extension.

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

sponsorblock's People

Contributors

ajayyy avatar ndevtk avatar joe-dowd avatar maximmax42 avatar joedowdcap avatar mruy avatar lartza avatar bershanskiy avatar jplsek avatar otiel avatar owendaprile avatar ptalmeida avatar isaackd avatar rafern avatar dependabot[bot] avatar deykun avatar strappazzon avatar immaax avatar grishka avatar commanderroot avatar fisheylp avatar thignus avatar marioortizmanero avatar omarroth avatar malmers avatar revadike avatar sircipherz avatar cherryblossom000 avatar doubouil avatar drlellinger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.