Ctrl+K

Initial Subscription

Initial Subscription#

Your first subscription should look something like this:

 1__preset__:
 2  overrides:
 3    tv_show_directory: "/tv_shows"
 4    music_directory: "/music"
 5
 6# Can choose between:
 7#  - Plex TV Show by Date:
 8#  - Jellyfin TV Show by Date:
 9#  - Kodi TV Show by Date:
10#
11Jellyfin TV Show by Date:
12  = Documentaries:
13    "NOVA PBS": "https://www.youtube.com/@novapbs"
14
15  = Kids | = TV-Y:
16    "Jake Trains": "https://www.youtube.com/@JakeTrains"
17
18YouTube Releases:
19  = Jazz:  # Sets genre tag to "Jazz"
20    "Thelonious Monk": "https://www.youtube.com/@theloniousmonk3870/releases"
21
22YouTube Full Albums:
23  = Lofi:
24    "Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i"

Lets break this down:

1__preset__:
2  overrides:
3    tv_show_directory: "/tv_shows"
4    music_directory: "/music"

The first __preset__ section is where we can set modifications that apply to every subscription in this file.

 6# Can choose between:
 7#  - Plex TV Show by Date:
 8#  - Jellyfin TV Show by Date:
 9#  - Kodi TV Show by Date:
10#

Lines 6-10 are comments that get ignored when parsing YAML since they are prefixed with #. It is good practice to leave informative comments in your config or subscription files to remind yourself of various things.

11Jellyfin TV Show by Date:

On line 11, we set the key to Jellyfin TV Show by Date. This is a prebuilt preset that configures subscriptions to look like TV shows in the Jellyfin media player (can be changed to one of the presets outlined in the comment above). Setting it as a YAML key implies that all subscriptions underneath it will inherit this preset.

11Jellyfin TV Show by Date:
12  = Documentaries:

Line 12 sets the key to = Documentaries. When keys are prefixed with =, it means we are setting the subscription indent variable. For TV Show presets, the first subscription indent variable maps to the TV show’s genre. Setting subscription indent variables as a key implies all subscriptions underneath it will have this variable set.

To better understand what variables are used in prebuilt presets, refer to the prebuilt preset reference. Here you will see the underlying variables used in prebuilt presets that can be overwritten. We already overwrote a few of the variables in the __preset__ section above to define our output directory.

11Jellyfin TV Show by Date:
12  = Documentaries:
13    "NOVA PBS": "https://www.youtube.com/@novapbs"

Line 13 is where we define our first subscription. We set the subscription name to NOVA PBS, and the subscription value to https://www.youtube.com/@novapbs. Referring to the TV show preset reference, we can see that {subscription_name} is used to set the tv_show_name variable.

11Jellyfin TV Show by Date:
12  = Documentaries:
13    "NOVA PBS": "https://www.youtube.com/@novapbs"
14
15  = Kids | = TV-Y:
16    "Jake Trains": "https://www.youtube.com/@JakeTrains"

Line 15 underneath Jellyfin TV Show by Date, but at the same level as = Documentaries. This means we’ll inherit the TV show preset, but not the documentaries indent variable. We instead set the indent variables to = Kids | = TV-Y. This sets two indent variables. We can set multiple presets and/or indent variables on the same key by using | as a separator.

Referring to the TV show preset reference, the first two indent variables map to the TV show genre and TV show content rating.

The above info should be enough to understand the rest of the subscription file.