YouTube Playlist Downloader

A cross-platform tool for downloading entire YouTube playlists as MP3 or MP4 files, using yt-dlp, ffmpeg, and aria2. Includes Gitea CI/CD workflow for packaging and releasing Windows and Linux binaries.

Supports audio, video, or both download modes, music and videos are numbered as they are on your youtube playlist, playlist cleanup, and configurable parallel download options.

Features

• Download full YouTube playlists as high-quality MP3 (audio), MP4 (video), or both.
• Download mode: Choose audio, video, or both for each playlist.
• Max video quality: Select from 720p, 1080p, 1440p, 2160p, or best.
• Parallel downloads: Using aria2 for speed.
• Automatic renumbering: Tracks are renumbered to match playlist order after download.
• Cleanup of tracks: Option to remove files not in playlist anymore, with confirmation.
• Configurable output paths and archive tracking.
• Cross-platform: Windows and Linux support.
• GitHub Actions CI/CD workflow for automated packaging and release.

Requirements

• Python 3.8+

Installation

Quick Start

1. Download the latest release:

• Go to the Releases page.
  • Download the appropriate archive for your platform (Windows or Linux).

1. Unzip the archive:

• Extract the contents to a folder of your choice.

1. Edit configuration:

• Open yt-playlist-config.json and adjust paths, playlist URLs, download mode, and quality as needed.

1. Run ytpld:

• On Windows:

  yt-playlist-main.exe
  

• On Linux:

  python3 yt-playlist-main.py
  

Usage

Configuration

Edit yt-playlist-config.json to specify playlists, paths, and options:

{
  "playlists": [
    {
      "url": "https://www.youtube.com/playlist?list=playlistidhere",
      "download_mode": "audio",         
      "max_video_quality": "1080p",
      "save_path": "./music",
      "archive": "archive.txt",
    }
  ],
  "yt_dlp_path": "./bin/yt-dlp.exe",      // or "yt-dlp" for Linux
  "ffmpeg_path": "./bin/ffmpeg.exe",      // or "ffmpeg" for Linux
  "aria2c_path": "./bin/aria2c.exe",      // or "aria2c" for Linux
  "max_parallel_downloads": 10,
  "aria2c_connections": 8
}

• playlists: List of playlist objects. Each must have a url, save_path, and archive.
• yt_dlp_path, ffmpeg_path, aria2c_path: Paths to binaries (relative or absolute).
• download_mode: Choose audio, video, or both.
• max_video_quality: Set max video quality for downloads.
• max_parallel_downloads: Number of simultaneous downloads.
• aria2c_connections: Connections per download.

---

Running

• On Windows: yt-playlist-main.exe

• On Linux: python3 yt-playlist-main.py

• The downloader will:

  • Check for required tools and update yt-dlp automatically
  • Download new tracks or videos from your playlist(s)
  • Number and name files to match the playlist order
  • Skip deleted or private videos
  • Avoid re-downloading files you've already downloaded
  • Offer to clean up files that are no longer in the playlist

CLI flags

When running the script via python (for example python yt-playlist-main.py), you can pass the following flags:

• -c, --config <path> — Path to a configuration file (relative to the repository config/ directory by default)
• -d, --debug — Show verbose subprocess output (yt-dlp, ffmpeg, aria2c)
• -p, --prune — Run with pruning (deleting files not present in playlists)
• -y, --yes, --non-interactive — Auto-confirm prompts (used only with --pruneat the moment)

Examples:

# Run with debug output
python yt-playlist-main.py --debug

# Run non-interactive and prune
python yt-playlist-main.py --prune --yes

# Use a different config file
python yt-playlist-main.py --config custom-config.json

Docker Usage

You can run YouTube Playlist Downloader using the official Docker image.

Run the container

docker run -v /path/to/downloads:/app/downloads -v /path/to/config:/app/config ghcr.io/dark_zoul/ytpld:latest

Replace /path/to/downloads and /path/to/config with your local directories.

Required volumes:

• /app/downloads: Directory for downloaded audio/videos
• /app/config: Directory for the configuration file

Docker Compose example

Create a docker-compose.yml with the following content (replace the host paths as needed):

services:
  yt-downloader:
    image: ghcr.io/dark_zoul5/ytpld:latest
    container_name: yt-downloader
    restart: no
    volumes:
      - /path/to/downloads:/app/downloads
      - /path/to/config:/app/config

Run it with:

docker compose up -d

Docker Compose — environment variables

You can pass environment variables.

Environment variables

• YTPL_DEBUG (0/1): When set to 1 shows verbose output from external binaries (yt-dlp, ffmpeg, aria2c). Useful for diagnosing failures.
• YTPL_PRUNE (0/1): When set to 1 enables pruning — files that are not present in any configured playlist will be deleted (requires confirmation unless YTPL_YES is set).
• YTPL_YES (0/1): Auto-confirm prompts (use with YTPL_PRUNE in automated runs).
• YTPL_CONFIG: Path to a config file inside the container (defaults to /app/config/yt-playlist-config.json if present).
• YTPL_CONFIG_JSON: Full JSON payload for the entire config. When provided it overwrites /app/config/yt-playlist-config.json.
• YTPL_PLAYLISTS_JSON: JSON array used to populate the playlists field in the config.
• PLAYLIST_{N}_{FIELD}: Indexed playlist entries. For each playlist index N use PLAYLIST_N_URL, PLAYLIST_N_DOWNLOAD_MODE, PLAYLIST_N_SAVE_PATH, PLAYLIST_N_ARCHIVE, etc.
• YTPL_MAX_PARALLEL_DOWNLOADS: Integer, maximum concurrent downloads.
• YTPL_ARIA2C_CONNECTIONS: Integer, connections per download.
• YTPL_MAX_VIDEO_QUALITY: String, e.g., 1080p, 720p, best.
• YTPL_DOWNLOAD_MODE: audio, video, or both — default download mode applied to playlists that don't set it individually.

Tip

• Mount a config file for complex setups to avoid long environment variables. Example: - /host/config/yt-playlist-config.json:/app/config/yt-playlist-config.json.

Troubleshooting

• No binaries found: Ensure paths in yt-playlist-config.json are correct and binaries are present.
• No tracks downloaded: Check playlist URL and archive file.
• Download mode or quality issues: Make sure download_mode and max_video_quality are set to valid values.
• Network overload warning: If you set very high parallel/connections, the script will warn you.

---

License

See LICENSE.

---

Credits

• yt-dlp
• ffmpeg
• aria2