Where to Find ytdl-sub Configuration and Preset Reference Documentation

Updated

The ytdl-sub User Guide at ytdl-sub.readthedocs.io organizes its reference material into distinct sections: Configuration File, Presets, Subscription File, Plugins, Scripting, and a separate Prebuilt Preset Reference. Use the Configuration File and Presets pages when you are writing or editing your own config, the Prebuilt Preset Reference when you want to see what presets already exist, and the Plugins and Scripting pages only when built-in options are not enough. The FAQ and Debugging pages are the place to check when something behaves unexpectedly.

What Each Reference Section Covers

The guide's navigation lists the following reference-oriented pages, each aimed at a different task:

Section Consult it when you need to…
Configuration File Understand the structure and options of the main config file
Presets Learn how presets are defined and applied in your configuration
Subscription File Set up and manage the file that lists what to download
Plugins Extend behavior through plugin support
Scripting Add custom logic beyond standard configuration
Prebuilt Preset Reference Look up the presets that ship with ytdl-sub
Debugging Diagnose problems with a configuration or run
FAQ Check common questions before troubleshooting further

The Prebuilt Preset Reference is listed as its own top-level entry, separate from the general Presets page. Treat the Presets page as the explanation of how presets work and the Prebuilt Preset Reference as the catalog of what is available.

How the Guide Is Organized Around Tasks

The documentation is structured by stage of use rather than as a single alphabetical reference:

  • Install by Platform and Getting Started come first, for setup.
  • Prebuilt Presets groups ready-made presets by media type: TV Show Presets, Music Presets, Music Video Presets, Media Quality Presets, and Helper Presets.
  • Usage Reference collects the Configuration File, Presets, Subscription File, Plugins, and Scripting pages.
  • Prebuilt Preset Reference, Debugging, FAQ, and Deprecation Notices sit at the end as lookup and troubleshooting material.

So the practical path is: pick a prebuilt preset category that matches your media, then move into the Usage Reference pages to adapt the configuration, and fall back to Debugging or FAQ if the result is not what you expected.

A Practical Way to Use the Reference

  1. Start with Getting Started to confirm your install works.
  2. Choose the closest preset category (for example, TV Show Presets or Music Presets) and read its page.
  3. Open the Prebuilt Preset Reference to confirm the exact preset names available to you.
  4. Write or edit your configuration using the Configuration File and Presets pages, and define what to download in the Subscription File page.
  5. Only if the built-in options fall short, read Plugins and Scripting.
  6. If a run fails or output is wrong, check Debugging and FAQ before changing your setup further.

The guide also offers the documentation in .rst and .pdf formats alongside the HTML pages, which is useful if you want an offline copy of the reference while editing configuration.

Common Sticking Points

  • Confusing the two preset pages. The Presets page explains the mechanism; the Prebuilt Preset Reference lists what exists. Check the reference first to avoid inventing preset names.
  • Skipping the Subscription File. Configuration and subscription are separate concerns in this guide; a correct config still needs the subscription file to define what gets downloaded.
  • Reaching for Plugins and Scripting too early. These are advanced customization pages; most setups are covered by prebuilt presets plus configuration.
  • Ignoring Deprecation Notices. Options change over time, and the notices page flags what has been retired, which prevents debugging a setting that no longer applies.

The guide is maintained by Jesse Bannon, and the site footer carries a 2026 copyright notice, so check the Deprecation Notices page if you are following older examples from elsewhere.