60ff645750
I've been running into variations in style in the docs I've edited so far. I've been including changes for consistency in with other commits but in many cases that makes one part of one doc more consistent with the rest but less consistent with itself. It seems like a bit of cleanup may be in order. This change applies the following conventions: - Section heading heirarchy: #. ``=`` with overline for document title, IOW first heading #. ``-`` #. ``~`` #. ``"`` - Two newlines before ``-`` sections for readability - A newline between every section of any level and the first line of text - Wrap paragraph lines at 88 characters to match Python's Black I've only applied these changes to those ``*.rst`` files that aren't generated. In the future, I might suggest another bulk change to match [the Sphinx conventions for section headings](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections).
227 lines
7.2 KiB
ReStructuredText
227 lines
7.2 KiB
ReStructuredText
===
|
|
FAQ
|
|
===
|
|
|
|
Since ytdl-sub is relatively new to the public, there has not been many question asked
|
|
yet. We will update this as more questions get asked.
|
|
|
|
.. contents:: Frequently Asked Questions
|
|
:depth: 3
|
|
|
|
|
|
How do I...
|
|
-----------
|
|
|
|
...remove the date in the video title?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The :ref:`config_reference/prebuilt_presets/tv_show:TV Show` presets by default include
|
|
the upload date in the ``episode_title`` override variable. This variable is used to set
|
|
the title in things like the video metadata, NFO file, etc, which is subsequently read
|
|
by media players. This can be overwritten as you see fit by redefining it:
|
|
|
|
.. code-block:: yaml
|
|
|
|
overrides:
|
|
episode_title: "{title}" # Only sets the video title
|
|
|
|
...get support or reach out to contribute?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If you need support, you can:
|
|
|
|
* :ytdl-sub-gh:`Open an issue on GitHub <issues/new>`
|
|
|
|
* `Join our Discord <https://discord.gg/v8j9RAHb4k>`_
|
|
|
|
If you would like to contribute, we're happy to accept any help, even non-coders! To
|
|
find out how you can help this project, you can:
|
|
|
|
* `Join our Discord <https://discord.gg/v8j9RAHb4k>`_ and leave a comment in
|
|
#development with where you think you can assist or what skills you would like to
|
|
contribute.
|
|
|
|
* If you just want to fix one thing, you're welcome to :ytdl-sub-gh:`submit a pull
|
|
request <compare>` with information on what issue you're resolving and it will be
|
|
reviewed as soon as possible.
|
|
|
|
...download age-restricted YouTube videos?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
See `yt-dl's recommended way
|
|
<https://github.com/ytdl-org/youtube-dl#how-do-i-pass-cookies-to-youtube-dl>`_ to
|
|
download your YouTube cookie, then add it to your :ref:`ytdl options
|
|
<config_reference/plugins:ytdl_options>` section of your config:
|
|
|
|
.. code-block:: yaml
|
|
|
|
ytdl_options:
|
|
cookiefile: "/path/to/cookies/file.txt"
|
|
|
|
...automate my downloads?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
:doc:`This page </guides/getting_started/automating_downloads>` shows how to set up
|
|
``ytdl-sub`` to run automatically on various platforms.
|
|
|
|
...download large channels?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
See the prebuilt preset :doc:`chunk_initial_download </prebuilt_presets/helpers>`.
|
|
|
|
...filter to include or exclude based on certain keywords?
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
See the prebuilt preset :doc:`Filter Keywords </prebuilt_presets/helpers>`.
|
|
|
|
...prevent creation of NFO file
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Creation of NFO files is done by the NFO tags plugin. It, as any other plugin, can be
|
|
disabled:
|
|
|
|
.. code-block:: yaml
|
|
|
|
nfo_tags:
|
|
enabled: False
|
|
|
|
...prevent download of images
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The :ref:`config_reference/prebuilt_presets/tv_show:TV Show` presets by default
|
|
downloads images corresponding to show and each episode. This can be prevented by
|
|
overriding following variables:
|
|
|
|
.. code-block:: yaml
|
|
|
|
overrides:
|
|
tv_show_fanart_file_name: "" # to stop creation of fanart.jpg in subscription
|
|
tv_show_poster_file_name: "" # to stop creation of poster.jpg in subscription
|
|
thumbnail_name: "" # to stop creation of episode thumbnails
|
|
|
|
...use only part of the media's title
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
ytdl-sub offers a range of functions that can be used to parse a subset of a title for
|
|
use in your media player. Consider the example:
|
|
|
|
* I want to remove "NOVA PBS - " from the title ``NOVA PBS - Hidden Cities All Around
|
|
Us``.
|
|
|
|
There are several solutions using ytdl-sub's scripting capabilities to override
|
|
``episode_title`` by manipulating the original media's ``title``.
|
|
|
|
.. code-block:: yaml
|
|
:caption: Replace exclusion with empty string
|
|
|
|
"~Nova PBS":
|
|
url: "https://www.youtube.com/@novapbs"
|
|
episode_title: >-
|
|
{
|
|
%replace( title, "NOVA PBS - ", "" )
|
|
}
|
|
|
|
.. code-block:: yaml
|
|
:caption: Split once using delimiter, grab last value in the split array.
|
|
|
|
"~Nova PBS":
|
|
url: "https://www.youtube.com/@novapbs"
|
|
episode_title: >-
|
|
{
|
|
%array_at( %split(title, " - ", 1), -1 )
|
|
}
|
|
|
|
.. code-block:: yaml
|
|
:caption:
|
|
Regex capture. Supports multiple capture strings and default values if captures
|
|
are unsuccessful.
|
|
|
|
"~Nova PBS":
|
|
url: "https://www.youtube.com/@novapbs"
|
|
captured_episode_title: >-
|
|
{
|
|
%regex_capture_many(
|
|
title,
|
|
[ "NOVA PBS - (.*)" ],
|
|
[ title ]
|
|
)
|
|
}
|
|
episode_title: >-
|
|
{ %array_at( captured_episode_title, 1 ) }
|
|
|
|
There is no single solution to this problem - it will vary case-by-case. See our full
|
|
suite of :ref:`scripting functions
|
|
<config_reference/scripting/scripting_functions:Scripting Functions>` to create your own
|
|
clever scraping mechanisms.
|
|
|
|
There is a bug where...
|
|
-----------------------
|
|
|
|
..ytdl-sub is not downloading
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Run with ``--log-level verbose`` to see all yt-dlp logs, to rule out whether it is a
|
|
yt-dlp or ytdl-sub issue.
|
|
|
|
Any logs showing failed downloads, 403 errors, signs of throttles, etc, are a yt-dlp
|
|
issue. A good strategy is to see if your same issue has been reported in `yt-dlp's
|
|
GitHub issues <https://github.com/yt-dlp/yt-dlp/issues>`_, and search to see if there is
|
|
a comment including a fix or workaround.
|
|
|
|
If it looks like a ytdl-sub issue, run with ``--log-level debug`` and make a `GitHub
|
|
issue in ytdl-sub <https://github.com/jmbannon/ytdl-sub/issues>`_ containing these logs
|
|
and other relevant info.
|
|
|
|
...date_range is not downloading older videos after I changed the range
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Your preset most likely has ``break_on_existing`` set to True, which will stop
|
|
downloading additional metadata/videos if the video exists in your download archive. Set
|
|
the following in your config to skip downloading videos that exist instead of stopping
|
|
altogether.
|
|
|
|
.. code-block:: yaml
|
|
|
|
ytdl_options:
|
|
break_on_existing: False
|
|
|
|
After you download your new date_range duration, re-enable ``break_on_existing`` to
|
|
speed up successive downloads.
|
|
|
|
...it is downloading non-English title and description metadata
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Most likely the video has a non-English language set to its 'native' language. You can
|
|
tell yt-dlp to explicitly download English metadata using.
|
|
|
|
.. code-block:: yaml
|
|
|
|
ytdl_options:
|
|
extractor_args:
|
|
youtube:
|
|
lang:
|
|
- "en"
|
|
|
|
...Plex is not showing my TV shows correctly
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
1. Set the following for your ytdl-sub library that has been added to Plex.
|
|
|
|
.. figure:: ../../images/plex_scanner_agent.png
|
|
:alt:
|
|
The Plex library editor, under the advanced settings, showing the required options
|
|
for Plex to show the TV shows correctly.
|
|
|
|
- **Scanner:** Plex Series Scanner
|
|
- **Agent:** Personal Media shows
|
|
- **Visibility:** Exclude from home screen and global search
|
|
- **Episode sorting:** Library default
|
|
- **YES** Enable video preview thumbnails
|
|
|
|
2. Under **Settings** > **Agents**, confirm Plex Personal Media Shows/Movies scanner has
|
|
**Local Media Assets** enabled.
|
|
|
|
.. figure:: ../../images/plex_agent_sources.png
|
|
:alt:
|
|
The Plex Agents settings page has Local Media Assets enabled for Personal Media
|
|
Shows and Movies tabs.
|