first config wip

This commit is contained in:
Jesse Bannon 2024-12-14 08:09:50 -08:00
parent c39fcdc254
commit 344aa3760e
3 changed files with 15 additions and 5 deletions

View file

@ -1,23 +1,33 @@
Basic Configuration Basic Configuration
=================== ===================
Your first configuration will look pretty simple: A configuration file serves two purposes:
1. Set advanced functionality that is not specifiable in a subscription file, such as working directory location. These
are set underneath ``configuration``.
2. Create custom presets, which can drastically simplify your subscription file. These are defined underneath ``presets``.
Below is a basic configuration:
.. code-block:: yaml .. code-block:: yaml
:linenos: :linenos:
configuration: configuration:
working_directory: '.ytdl-sub-downloads' working_directory: '/mnt/ssd/.ytdl-sub-downloads'
presets: presets:
TV Show: TV Show:
preset: preset:
- "Jellyfin TV Show by Date" - "Jellyfin TV Show by Date"
- "Only Recent"
overrides: overrides:
tv_show_directory: "/ytdl_sub_tv_shows" tv_show_directory: "/ytdl_sub_tv_shows"
TV Show Only Recent:
preset:
- "Only Recent"
The first two lines in this ``config.yaml`` file are the ``configuration``, and define the ``working_directory``, which is described near the bottom of :ref:`this section <guides/getting_started/index:quick overview of \`\`ytdl-sub\`\`>` The first two lines in this ``config.yaml`` file are the ``configuration``, and define the ``working_directory``, which is described near the bottom of :ref:`this section <guides/getting_started/index:quick overview of \`\`ytdl-sub\`\`>`

View file

@ -31,7 +31,7 @@ Your first subscription file should look something like this:
= Lofi: = Lofi:
"Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i" "Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i"
Lets break this down: Let's break this down:
.. code-block:: yaml .. code-block:: yaml
:lineno-start: 1 :lineno-start: 1

View file

@ -39,7 +39,7 @@ Intermediate terminology:
Advanced terminology: Advanced terminology:
- ``entry variables``: Variables that derive from a downloaded yt-dlp entry. - ``entry variables``: Variables that derive from a downloaded yt-dlp entry (media).
- ``static variables``: Variables that do not have a dependency to entry variables. - ``static variables``: Variables that do not have a dependency to entry variables.
- ``scripting``: Syntax that allows the use of entry variables, static variables, and functions in override variables. - ``scripting``: Syntax that allows the use of entry variables, static variables, and functions in override variables.