X-Git-Url: https://jfr.im/git/yt-dlp.git/blobdiff_plain/d9d045e2efee446b215cdc66cbe44a918e117707..17fa3ee25f8e40c49a48a5e34456d8965efbb21d:/README.md diff --git a/README.md b/README.md index e4f2dcf49..1a5dd3f6a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # YT-DLP -[![Release Version](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/pukkandan/c69cb23c3c5b3316248e52022790aa57/raw/version.json&color=brightgreen)](https://github.com/pukkandan/yt-dlc/releases/latest) -[![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](https://github.com/pukkandan/yt-dlc/blob/master/LICENSE) -[![Core Status](https://github.com/pukkandan/yt-dlc/workflows/Core%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlc/actions?query=workflow%3ACore) -[![CI Status](https://github.com/pukkandan/yt-dlc/workflows/Full%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlc/actions?query=workflow%3AFull) +[![Release Version](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/pukkandan/c69cb23c3c5b3316248e52022790aa57/raw/version.json&color=brightgreen)](https://github.com/pukkandan/yt-dlp/releases/latest) +[![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](https://github.com/pukkandan/yt-dlp/blob/master/LICENSE) +[![Core Status](https://github.com/pukkandan/yt-dlp/workflows/Core%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlp/actions?query=workflow%3ACore) +[![CI Status](https://github.com/pukkandan/yt-dlp/workflows/Full%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlp/actions?query=workflow%3AFull) A command-line program to download videos from youtube.com and many other [video platforms](docs/supportedsites.md) @@ -12,8 +12,8 @@ # YT-DLP * [NEW FEATURES](#new-features) * [INSTALLATION](#installation) - * [UPDATE](#update) - * [COMPILE](#compile) + * [Update](#update) + * [Compile](#compile) * [DESCRIPTION](#description) * [OPTIONS](#options) * [Network Options](#network-options) @@ -30,7 +30,7 @@ # YT-DLP * [Authentication Options](#authentication-options) * [Adobe Pass Options](#adobe-pass-options) * [Post-processing Options](#post-processing-options) - * [SponSkrub Options (SponsorBlock)](#sponSkrub-options-sponsorblock) + * [SponSkrub Options (SponsorBlock)](#sponskrub-options-sponsorblock) * [Extractor Options](#extractor-options) * [CONFIGURATION](#configuration) * [Authentication with .netrc file](#authentication-with-netrc-file) @@ -48,39 +48,39 @@ # YT-DLP # NEW FEATURES The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are: -* **[SponSkrub Integration](#sponSkrub-options-sponsorblock)**: You can use [SponSkrub](https://github.com/faissaloo/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API +* **[SponSkrub Integration](#sponSkrub-options-sponsorblock)**: You can use [SponSkrub](https://github.com/pukkandan/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API -* **[Format Sorting](#sorting-format)**: The default format sorting options have been changed so that higher resolution and better codecs will be now prefered instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S`. This allows for much easier format selection that what is possible by simply using `--format` ([examples](#format-selection-examples)) +* **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S`. This allows for much easier format selection that what is possible by simply using `--format` ([examples](#format-selection-examples)) -* Merged with youtube-dl **v2020.01.08**: You get all the latest features and patches of [youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of [youtube-dlc](https://github.com/blackjack4494) +* **Merged with youtube-dl v2021.01.08**: You get all the latest features and patches of [youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) * **Youtube improvements**: * All Youtube Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`) works correctly and support downloading multiple pages of content * Youtube search works correctly (`ytsearch:`, `ytsearchdate:`) along with Search URLs * Redirect channel's home URL automatically to `/video` to preserve the old behaviour -* **New extractors**: AnimeLab, Rcs, Gedi, bitwave.tv +* **New extractors**: AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv -* **Fixed extractors**: archive.org, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina +* **Fixed extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina -* **New options**: `--list-formats-as-table`, `--write-link`, `--force-download-archive` etc +* **New options**: `--list-formats-as-table`, `--write-link`, `--force-download-archive`, `--force-overwrites` etc -and many other features and patches. See [changelog](Changelog.md) or [commits](https://github.com/pukkandan/yt-dlc/commits) for the full list of changes +and many other features and patches. See [changelog](Changelog.md) or [commits](https://github.com/pukkandan/yt-dlp/commits) for the full list of changes -**PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details +**PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](Changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details If you are coming from [youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare [options](#options) and [supported sites](docs/supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated. # INSTALLATION -To use the latest version, simply download and run the [latest release](https://github.com/pukkandan/yt-dlc/releases/latest). +To use the latest version, simply download and run the [latest release](https://github.com/pukkandan/yt-dlp/releases/latest). Currently, there is no support for any package managers. If you want to install the current master branch - python -m pip install git+https://github.com/pukkandan/yt-dlc + python -m pip install git+https://github.com/pukkandan/yt-dlp ### UPDATE **DO NOT UPDATE using `-U` !** instead download binaries again @@ -250,8 +250,10 @@ ## Video Selection: --download-archive FILE Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it. - --break-on-existing Stop the download process after attempting - to download a file that's in the archive. + --break-on-existing Stop the download process when encountering + a file that's in the archive. + --break-on-reject Stop the download process when encountering + a file that has been filtered out. --no-download-archive Do not use archive file (default) --include-ads Download advertisements as well (experimental) @@ -319,7 +321,11 @@ ## Filesystem Options: filenames --no-restrict-filenames Allow Unicode characters, "&" and spaces in filenames (default) - -w, --no-overwrites Do not overwrite files + -w, --no-overwrites Do not overwrite any files + --force-overwrites Overwrite all video and metadata files. + This option includes --no-continue + --no-force-overwrites Do not overwrite the video, but overwrite + related files (default) -c, --continue Resume partially downloaded files (default) --no-continue Restart download of partially downloaded files from beginning @@ -412,7 +418,8 @@ ## Verbosity / Simulation Options: files in the current directory to debug problems --print-traffic Display sent and read HTTP traffic - -C, --call-home Contact the youtube-dlc server for debugging + -C, --call-home [Broken] Contact the youtube-dlc server for + debugging --no-call-home Do not contact the youtube-dlc server for debugging (default) @@ -551,9 +558,10 @@ ## Post-Processing Options: ExtractAudio, VideoRemuxer, VideoConvertor, EmbedSubtitle, Metadata, Merger, FixupStretched, FixupM4a, FixupM3u8, - SubtitlesConvertor, SponSkrub and Default. - You can use this option multiple times to - give different arguments to different + SubtitlesConvertor, EmbedThumbnail, + XAttrMetadata, SponSkrub and Default. You + can use this option multiple times to give + different arguments to different postprocessors -k, --keep-video Keep the intermediate video file on disk after post-processing @@ -600,7 +608,7 @@ ## Post-Processing Options: --convert-subs FORMAT Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc) -## [SponSkrub](https://github.com/faissaloo/SponSkrub) Options ([SponsorBlock](https://sponsor.ajay.app)): +## [SponSkrub](https://github.com/pukkandan/SponSkrub) Options ([SponsorBlock](https://sponsor.ajay.app)): --sponskrub Use sponskrub to mark sponsored sections with the data available in SponsorBlock API. This is enabled by default if the