简体中文
EnglishWhat Is ytdl-sub and What Is the ytdl-sub User Guide Website?
Updated
ytdl-sub is a tool whose official documentation is published at ytdl-sub.readthedocs.io, the "ytdl-sub User Guide." The site is documentation only: it explains how to install, configure, and run ytdl-sub. It is not a downloader, streaming service, or place to obtain media itself. Use it when you want to understand what ytdl-sub does and how to set it up; look elsewhere if you just want to download a single video without configuration.
What the User Guide Covers
The guide is organized into sections that map to the work of running ytdl-sub:
| Section | What it helps you do |
|---|---|
| Install by Platform | Get ytdl-sub running on your system |
| Getting Started | Move from installation to a first working setup |
| Prebuilt Presets | Use ready-made presets instead of writing configuration from scratch |
| TV Show, Music, and Music Video Presets | Apply presets suited to a specific media type |
| Media Quality and Helper Presets | Adjust quality settings and reuse supporting presets |
| Usage Reference | Look up how commands and options behave |
| Configuration File, Presets, Subscription File, Plugins, Scripting | Understand the building blocks of a setup |
| Prebuilt Preset Reference | Check details of the shipped presets |
| Debugging, FAQ, Deprecation Notices | Troubleshoot problems and track changes |
The guide also links to a Development and Contributing section for people working on the tool itself.
How the Pieces Fit Together
The section names reveal the core model. A subscription file defines what you want to track. Presets decide how that content is organized and named. The configuration file ties presets and subscriptions together, and plugins and scripting extend behavior beyond the defaults.
A practical example: someone who wants a TV-show-style library does not need to design a naming scheme from scratch. They start from a TV Show Preset, point a subscription file at the source, and adjust only what differs from the preset. The Prebuilt Preset Reference is where to confirm what a given preset actually does before relying on it.
Deciding Whether It Fits Your Task
Choose ytdl-sub when you want repeatable, organized handling of subscribed content and are willing to write or adapt a configuration. Choose a simpler single-video downloader when you have a one-off task and no interest in presets or subscription files.
Two cautions follow from the documentation's structure rather than from any claim on the site. First, the presence of a "Subscription File" section does not establish pricing or access terms for any source; the guide does not state them, so check the relevant service yourself. Second, because the guide maintains Deprecation Notices, configurations copied from older examples may need updating—check that section when an existing setup stops behaving as expected.
Where to Start
Begin with What is ytdl-sub? and Getting Started, then move to Install by Platform for your system. Once installed, pick the preset family matching your media type and consult the Prebuilt Preset Reference before customizing. Keep Debugging and FAQ open for the first run, since configuration errors are the most likely early obstacle.