]> jfr.im git - yt-dlp.git/blobdiff - README.md
Merge branch 'RedpointsBots-feature_subscriber_count'
[yt-dlp.git] / README.md
index 5386a086a06c7bbd7ba7a2ca6e239dafb01ca0f4..2a0cf3a48c3b0d88157236250521908810828cfb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,73 @@
+[![PyPi](https://img.shields.io/pypi/v/youtube-dlc.svg)](https://pypi.org/project/youtube-dlc)
 [![Build Status](https://travis-ci.com/blackjack4494/youtube-dlc.svg?branch=master)](https://travis-ci.com/blackjack4494/youtube-dlc)
+[![Downloads](https://pepy.tech/badge/youtube-dlc)](https://pepy.tech/project/youtube-dlc)
 
-youtube-dlc - download videos from youtube.com or other video platforms
+[![Gitter chat](https://badges.gitter.im/youtube-dlc/gitter.png)](https://gitter.im/youtube-dlc) 
+[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](https://github.com/blackjack4494/youtube-dlc/blob/master/LICENSE)
+
+youtube-dlc - download videos from youtube.com or other video platforms.
+
+youtube-dlc is a fork of youtube-dl with the intention of getting features tested by the community merged in the tool faster, since youtube-dl's development seems to be slowing down. (https://github.com/ytdl-org/youtube-dl/issues/26462)
 
 - [INSTALLATION](#installation)
 - [DESCRIPTION](#description)
 - [OPTIONS](#options)
-- [COPYRIGHT](#copyright)
+  - [Network Options:](#network-options)
+  - [Geo Restriction:](#geo-restriction)
+  - [Video Selection:](#video-selection)
+  - [Download Options:](#download-options)
+  - [Filesystem Options:](#filesystem-options)
+  - [Thumbnail images:](#thumbnail-images)
+  - [Verbosity / Simulation Options:](#verbosity--simulation-options)
+  - [Workarounds:](#workarounds)
+  - [Video Format Options:](#video-format-options)
+  - [Subtitle Options:](#subtitle-options)
+  - [Authentication Options:](#authentication-options)
+  - [Adobe Pass Options:](#adobe-pass-options)
+  - [Post-processing Options:](#post-processing-options)
+  - [Extractor Options:](#extractor-options)
 
 # INSTALLATION
 
-To install it right away for all UNIX users (Linux, macOS, etc.), type:
+**All Platforms**  
+Preferred way using pip:  
 You may want to use `python3` instead of `python`
 
     python -m pip install --upgrade youtube-dlc
 
-To build the Windows executable (a compiled version will be available online soon)
+**UNIX** (Linux, macOS, etc.)  
+Using wget:
+
+    sudo wget https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc -O /usr/local/bin/youtube-dlc
+    sudo chmod a+rx /usr/local/bin/youtube-dlc
+
+Using curl:
+
+    sudo curl -L https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc -o /usr/local/bin/youtube-dlc
+    sudo chmod a+rx /usr/local/bin/youtube-dlc
+
+
+**Windows** users can download [youtube-dlc.exe](https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc.exe) (**do not** put in `C:\Windows\System32`!).  
+
+**Compile**
+To build the Windows executable yourself (without version info!)
 
     python -m pip install --upgrade pyinstaller
-    pyinstaller.exe youtube_dl\__main__.py --onefile --name youtube-dlc
+    pyinstaller.exe youtube_dlc\__main__.py --onefile --name youtube-dlc
     
 Or simply execute the `make_win.bat` if pyinstaller is installed.
-There will be a `youtube-dlc.exe` in `/dist`
+There will be a `youtube-dlc.exe` in `/dist`  
+
+New way to build Windows is to use `python pyinst.py` (please use python3 64Bit)  
+For 32Bit Version use a 32Bit Version of python (3 preferred here as well) and run `python pyinst32.py`  
+
+For Unix:
+You will need the required build tools  
+python, make (GNU), pandoc, zip, nosetests  
+Then simply type this
+
+    make
+
 
 # DESCRIPTION
 **youtube-dlc** is a command-line program to download videos from YouTube.com and a few more sites. It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
@@ -46,19 +93,19 @@ # OPTIONS
                                      extractor
     --default-search PREFIX          Use this prefix for unqualified URLs. For
                                      example "gvsearch2:" downloads two videos
-                                     from google videos for youtube-dl "large
+                                     from google videos for youtube-dlc "large
                                      apple". Use the value "auto" to let
-                                     youtube-dl guess ("auto_warning" to emit a
+                                     youtube-dlc guess ("auto_warning" to emit a
                                      warning when guessing). "error" just throws
                                      an error. The default value "fixup_error"
                                      repairs broken URLs, but emits an error if
                                      this is not possible instead of searching.
     --ignore-config                  Do not read configuration files. When given
                                      in the global configuration file
-                                     /etc/youtube-dl.conf: Do not read the user
+                                     /etc/youtube-dlc.conf: Do not read the user
                                      configuration in ~/.config/youtube-
-                                     dl/config (%APPDATA%/youtube-dl/config.txt
-                                     on Windows)
+                                     dlc/config (%APPDATA%/youtube-
+                                     dlc/config.txt on Windows)
     --config-location PATH           Location of the configuration file; either
                                      the path to the config or its containing
                                      directory.
@@ -215,7 +262,7 @@ ## Filesystem Options:
                                      filenames
     -w, --no-overwrites              Do not overwrite files
     -c, --continue                   Force resume of partially downloaded files.
-                                     By default, youtube-dl will resume
+                                     By default, youtube-dlc will resume
                                      downloads if possible.
     --no-continue                    Do not resume partially downloaded files
                                      (restart from beginning)
@@ -233,11 +280,11 @@ ## Filesystem Options:
                                      option)
     --cookies FILE                   File to read cookies from and dump cookie
                                      jar in
-    --cache-dir DIR                  Location in the filesystem where youtube-dl
-                                     can store some downloaded information
+    --cache-dir DIR                  Location in the filesystem where youtube-
+                                     dlc can store some downloaded information
                                      permanently. By default
-                                     $XDG_CACHE_HOME/youtube-dl or
-                                     ~/.cache/youtube-dl . At the moment, only
+                                     $XDG_CACHE_HOME/youtube-dlc or
+                                     ~/.cache/youtube-dlc . At the moment, only
                                      YouTube player files (for videos with
                                      obfuscated signatures) are cached, but that
                                      may change.
@@ -283,8 +330,9 @@ ## 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-dl server for debugging
-    --no-call-home                   Do NOT contact the youtube-dl server for
+    -C, --call-home                  Contact the youtube-dlc server for
+                                     debugging
+    --no-call-home                   Do NOT contact the youtube-dlc server for
                                      debugging
 
 ## Workarounds:
@@ -323,6 +371,8 @@ ## Video Format Options:
                                      videos
     --youtube-skip-dash-manifest     Do not download the DASH manifests and
                                      related data on YouTube videos
+    --youtube-skip-hls-manifest      Do not download the HLS manifests and
+                                     related data on YouTube videos
     --merge-output-format FORMAT     If a merge is required (e.g.
                                      bestvideo+bestaudio), output to given
                                      container format. One of mkv, mp4, ogg,
@@ -345,7 +395,7 @@ ## Subtitle Options:
 ## Authentication Options:
     -u, --username USERNAME          Login with this account ID
     -p, --password PASSWORD          Account password. If this option is left
-                                     out, youtube-dl will ask interactively.
+                                     out, youtube-dlc will ask interactively.
     -2, --twofactor TWOFACTOR        Two-factor authentication code
     -n, --netrc                      Use .netrc authentication data
     --video-password PASSWORD        Video password (vimeo, smotri, youku)
@@ -356,8 +406,8 @@ ## Adobe Pass Options:
                                      a list of available MSOs
     --ap-username USERNAME           Multiple-system operator account login
     --ap-password PASSWORD           Multiple-system operator account password.
-                                     If this option is left out, youtube-dl will
-                                     ask interactively.
+                                     If this option is left out, youtube-dlc
+                                     will ask interactively.
     --ap-list-mso                    List all supported multiple-system
                                      operators
 
@@ -373,6 +423,10 @@ ## Post-processing Options:
                                      a value between 0 (better) and 9 (worse)
                                      for VBR or a specific bitrate like 128K
                                      (default 5)
+    --remux-video FORMAT             Remux the video to another container format
+                                     if necessary (currently supported: mp4|mkv,
+                                     target container format must support video
+                                     / audio encoding, remuxing may fail)
     --recode-video FORMAT            Encode the video to another format if
                                      necessary (currently supported:
                                      mp4|flv|ogg|webm|mkv|avi)
@@ -417,8 +471,6 @@ ## Post-processing Options:
     --convert-subs FORMAT            Convert the subtitles to other format
                                      (currently supported: srt|ass|vtt|lrc)
 
-# COPYRIGHT
-
-youtube-dl is released into the public domain by the copyright holders.
+## Extractor Options:
+    --ignore-dynamic-mpd             Do not process dynamic DASH manifests
 
-This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.