This repository has been archived by the owner on Sep 2, 2021. It is now read-only.
forked from faissaloo/SponSkrub
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
46 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,35 @@ | ||
# SponSkrub | ||
This is a command line utility to strip out in video YouTube advertisements from downloaded YouTube videos, such as those downloaded from [youtube-dl](https://ytdl-org.github.io/youtube-dl/index.html). This means that you both don't waste disk space on adverts and don't redistribute adverts. If you want to download and strip a video you can use the wrapper application `youtube-dl-sponsorblock` which uses youtube-dl to download the video and will then strip the video of sponsors for you. | ||
|
||
It makes use of the [SponsorBlock API](https://github.com/ajayyy/SponsorBlockServer#api-docs) and I'd recommend installing the extension and maybe contributing some sponsorship times when you're ever bored. | ||
You can build `youtube-dl-sponsorblock` and `sponskrub` by running `dub build`, to build only one of them use `dub build :youtube-dl-sponsorblock` and `dub build :sponskrub` respectively. | ||
This is a fork of [sponskrub](https://github.com/faissaloo/SponSkrub) primarily intended to provide a windows release and for use with [yt-dlp](https://github.com/pukkandan/yt-dlp) | ||
|
||
![before and after SponSkrub](repo_images/before_after.png) | ||
## Main Changes | ||
|
||
* Provide windows binary (only x86 for now) | ||
* All sections are included by default and all switches are changed to `--exclude-` | ||
* Removed `youtube-dl-sponskrub` since [yt-dlp](https://github.com/pukkandan/yt-dlp) has direct [sponskrub integraion](https://github.com/pukkandan/yt-dlp#sponSkrub-options-sponsorblock) | ||
|
||
## Description | ||
SponSkrub is a command line utility for removing sponsors from downloaded Youtube videos. It requires an internet connection in order to consult the SponsorBlock database and ffmpeg must be installed for modifying the video files. | ||
|
||
It makes use of the [SponsorBlock API](https://github.com/ajayyy/SponsorBlockServer#api-docs) and I'd recommend installing the extension and maybe contributing some sponsorship times when you're ever bored. | ||
|
||
You can build `sponskrub` by running `dub build`. | ||
|
||
## Usage | ||
|
||
sponskrub [options] [--] video_id input_filename output_filename | ||
|
||
## Options | ||
|
||
``` | ||
-h Display help | ||
-chapter Mark sections as chapters rather than removing them | ||
-exclude-sponsors Do not remove sponsors | ||
-exclude-intros Do not remove introductions | ||
-exclude-outros Do not remove outros | ||
-exclude-interactions Do not remove interactions | ||
-exclude-selfpromo Do not remove self-promotion | ||
-exclude-nonmusic Do not remove non-music portions of music videos | ||
-api-url Specify the url where the API is located, | ||
defaults to sponsor.ajay.app | ||
``` |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters