Skip to content
This repository has been archived by the owner on Sep 2, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pukkandan committed Jan 13, 2021
1 parent 70464fa commit eda45a5
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 35 deletions.
36 changes: 32 additions & 4 deletions README.md
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 removed repo_images/before_after.png
Binary file not shown.
45 changes: 14 additions & 31 deletions src/sponskrub/sponskrub.d
Original file line number Diff line number Diff line change
Expand Up @@ -63,40 +63,23 @@ int main(string[] args)

if ("h" in parsed_arguments.flag_arguments || parsed_arguments.unrecognised_arguments.length > 0 || parsed_arguments.get_missing_arguments().length > 0) {
writeln(
"Usage: sponskrub [-h] [-chapter] [-exclude-sponsors] [-exclude-intros] [-exclude-outros] [-exclude-interactions] [-exclude-selfpromo] [-exclude-nonmusic] [-api-url url] video_id input_filename output_filename
"Usage: sponskrub [options] [--] video_id input_filename output_filename
SponSkrub is an application for removing sponsors from downloaded Youtube video
files, it requires an internet connection in order to consult the SponsorBlock
database and ffmpeg must be installed.
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.
Options:
-h
Display this help string
-chapter
Mark sponsor spots as chapters rather than removing them.
Faster but leads to bigger file sizes
-exclude-sponsors
Exclude sponsors from the categories to be cut or marked as chapters
-exclude-intros
Exclude introductions from the categories to be cut or marked as chapters
-exclude-outros
Exclude outros from the categories to be cut or marked as chapters
-exclude-interactions
Exclude interactions from the categories to be cut or marked as chapters
-exclude-selfpromo
Exclude self-promotion from the categories to be cut or marked as chapters
-exclude-nonmusic
Exclude non-music portions of music videos from the categories to be cut or marked as chapters
-api-url
Specify the url where the API is located, defaults to sponsor.ajay.app
-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
");
return 1;
}
Expand Down

0 comments on commit eda45a5

Please sign in to comment.