TheFrenchGhostys-Ultimate-Y.../README.md

109 lines
4.7 KiB
Markdown
Raw Normal View History

<h1 align="center">TheFrenchGhosty's Ultimate YouTube-DL Scripts Collection</h1>
2019-08-04 19:38:55 +02:00
<p align="center">The ultimate collection of scripts for YouTube-DL.</p>
2021-02-17 00:26:53 +01:00
2024-09-24 01:57:37 +02:00
<p align="center">🎉 Thanks for 2000 stars! 🎉</p>
2021-02-22 03:32:26 +01:00
Associated Reddit /r/Datahoarder post: [Here for 3.1.0](https://redd.it/lx3ccm) | [Here for 3.0.0](https://redd.it/llw7zq) | [Here for 2.0.0](https://redd.it/h7q4nz) | [Here for 1.0.0](https://redd.it/dwhvq6).
2020-02-08 03:51:57 +01:00
2021-02-17 00:26:53 +01:00
## Features:
- [Copylefted libre software](https://github.com/TheFrenchGhosty/TheFrenchGhostys-YouTube-DL-Archivist-Scripts) (GPLv3 licensed)
2021-02-17 00:49:04 +01:00
- Download content in the best possible quality, better than every other software, period.
2021-02-17 00:26:53 +01:00
- Download all kind of content: channels, playlists and individual videos
- Download audio only content, in the best possible quality
- Content separated in two to be easier to archive
- Dedicated scripts to download videos destined to be watched and deleted on a PC
2021-02-19 01:45:00 +01:00
- Dedicated scripts to download videos destined to be watched and deleted on a Mobile device
2021-02-17 00:26:53 +01:00
- Easily expandable for users familiar with yt-dlp / youtube-dl
- [SponsorBlock](https://sponsor.ajay.app/) integration using [mpv_sponsorblock](https://github.com/po5/mpv_sponsorblock) by [@po5](https://github.com/po5)
- [Jellyfin](https://jellyfin.org/) integration using [Jellyfin YouTube Metadata Plugin](https://github.com/ankenyr/jellyfin-youtube-metadata-plugin) by [@ankenyr](https://github.com/ankenyr)
2021-02-17 00:26:53 +01:00
- No Contributor License Agreement
2021-02-17 00:49:04 +01:00
- No Code of Conduct
2021-02-17 00:26:53 +01:00
2021-02-17 00:36:40 +01:00
---
2021-02-17 00:29:44 +01:00
## Donate:
2022-08-16 18:45:45 +02:00
- Liberapay: https://liberapay.com/TheFrenchGhosty
2021-02-17 00:29:44 +01:00
2022-08-16 18:45:45 +02:00
- Ko-fi: https://ko-fi.com/TheFrenchGhosty
2021-02-17 00:29:44 +01:00
2022-08-16 18:45:45 +02:00
- Patreon: https://www.patreon.com/TheFrenchGhosty
- Monero (XMR): 87Ak7caLNYa7JKEQT4fYSDFsF5GeUZ21pFYtsNaEBSQZ7X8UcamThvvJeGo3ysuSDHcVAKz5JjX936K7cpJduHBZ5UzhgLZ (preferred)
- Wownero (WOW): WW3kVSN33A4AZN4EfT46nYVPVuhV2Mfby5oeuYbZZe34fECAGZgBcSiDuHD1crb2n97UqkgiJ1NWxCG7xgAqp8zU36fxcFATQ
- Bitcoin (BTC): bc1qvstl5gvkyx8er48lrpyxhlrdn7yrde0zj52rkz
- Litecoin (LTC): ltc1q6r6jhtktnvv8e80k6jaupe4dmmcxw7tcsrf0jt
2021-02-17 00:26:53 +01:00
---
# About the slow to non-existent updates:
As you can see, this project doesn't get a lot of updates, the reason is simple: this project is complete.
I've been using it a lot since I created it: tens of TB of videos were downloaded with the "Archivist Scripts (No Comments)", and I'm using the Watch scripts daily.
---
2021-02-17 00:49:04 +01:00
## Installation (Linux):
Install [yt-dlp](https://github.com/yt-dlp/yt-dlp) and [ffmpeg](https://www.ffmpeg.org/) (optionally, install the others [yt-dlp dependencies](https://github.com/yt-dlp/yt-dlp#dependencies)).
Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhostys-YouTube-DL-Archivist-Scripts/releases) and follow the included ReadMe, do not use the `master` branch unless you are ready to re-download EVERYTHING.
2021-02-17 00:36:40 +01:00
---
2021-02-17 00:36:40 +01:00
## Installation (Windows):
2020-12-01 18:49:16 +01:00
The Windows version, while it existed, required a lot of work to maintain because it needed specific changes compared to the linux version, and was never extensively tested. Windows users need to use the scripts in WSL, Cygwin, Git Bash, or some other Linux-on-Windows environment that enables Bash functionality in Windows.
2021-03-20 15:52:27 +01:00
Installation using WSL (recommended): [Here](docs/WSL.md)
Installation using Cygwin, Git Bash or similar: [Here](docs/Cygwin-Git-Bash.md)
2021-02-17 00:36:40 +01:00
2021-03-20 15:52:27 +01:00
Downloaded videos will likely exceed Windows' 260-character path length limit and not be playable out of the box. You should read more about [paths](docs/About-Paths.md) to familiarize yourself with the issue, as well as some potential workarounds.
2021-02-17 00:36:40 +01:00
---
2021-02-17 00:36:40 +01:00
## Usage:
2021-02-17 00:36:40 +01:00
Create a folder where you want your videos downloaded in a drive where you have enough space available.
2021-02-17 03:57:59 +01:00
Put the folders `Archivist Scripts`, `Audio-Only Scripts` and `Watch Scripts` in the created folder (See the documentation to understand the differences).
2021-02-17 00:36:40 +01:00
Add content to a 'Source - XXXXXX.txt' file depending of what type of content you want to download (See the documentation to understand the differences).
2021-02-17 00:36:40 +01:00
Open a terminal in the folder of the script you want to use and run `./[SCRIPT].sh`.
Done.
2021-02-17 00:36:40 +01:00
---
2021-02-17 00:03:01 +01:00
# Documentation:
2021-02-17 00:03:01 +01:00
## Basics:
- Scripts Type (Archivist, Audio-Only, Watch...): [Here](docs/Scripts-Type.md)
2021-02-17 00:03:01 +01:00
- Content Type (Channels, Playlists, Unique...): [Here](docs/Content-Type.md)
2021-02-17 00:03:01 +01:00
## Advanced:
- SponsorBlock implementation: [Here](docs/SponsorBlock.md)
2021-02-17 00:03:01 +01:00
- Region Restriction: [Here](docs/Region-Restriction.md)
2021-02-17 00:03:01 +01:00
- Details: [Here](docs/Details.md)
2021-02-17 17:04:15 +01:00
---
## Contact:
2021-02-17 17:07:09 +01:00
If you want to get in touch with me, or other users of my projects, feel free to join the Matrix room of one of my other project [PussTheCat.org](https://pussthecat.org): [#pussthecat.org:pussthecat.org](https://matrix.to/#/#pussthecat.org:pussthecat.org).
2021-02-17 17:04:15 +01:00
2021-02-18 02:55:06 +01:00
If you want to contact me privately, see: https://pussthecat.org/about/.