diff --git a/docs/source/prebuilt_presets/music.rst b/docs/source/prebuilt_presets/music.rst index 60552eea..23323c6b 100644 --- a/docs/source/prebuilt_presets/music.rst +++ b/docs/source/prebuilt_presets/music.rst @@ -1,3 +1,64 @@ ============= Music Presets -============= \ No newline at end of file +============= + +Music downloadable by yt-dlp comes in many flavors. ``ytdl-sub`` offers a suite +of various presets for handling some of the most popular forms of uploaded music +content. + +YouTube Releases +---------------- +Many artists, especially those auto-uploaded as ``Topics`` in YouTube have a section on +their channel named "Releases", or "Albums and Singles". The ``YouTube Releases`` preset aims to +scrape this *playlist of playlists*. + +Playlists are recognized as the album, and videos within it are tracks. + +.. code-block:: yaml + + YouTube Releases: + = Jazz: # Sets genre tag to "Jazz" + "Thelonious Monk": "https://www.youtube.com/@theloniousmonk3870/releases" + +.. hint:: + + The subscription *value* (denoted by =) will set the genre tag for all music scraped under its key. + +YouTube Full Albums +------------------- +In many cases, albums are uploaded to YouTube as a single video, where each track as separated by either +chapters or timestamps in a description. The ``YouTube Full Albums`` preset will take each video and split +it by the chapters to form an album. + +Videos are recognized as the album, and chapters within it are tracks. + +.. code-block:: yaml + + YouTube Full Albums: + = Lofi: + "Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i" + +Soundcloud Discography +---------------------- +SoundCloud tracks can be uploaded as either a single, part of an album, or a collaboration +with another artist. At this time, ``SoundCloud Discography`` only scrapes singles and albums. +It will attempt to group tracks into albums before falling back to single format. + +.. code-block:: yaml + + SoundCloud Discography: + = Chill Hop: + "UKNOWY": "https://soundcloud.com/uknowymunich" + = Synthwave: + "Lazerdiscs Records": "https://soundcloud.com/lazerdiscsrecords" + "Earmake": "https://soundcloud.com/earmake" + +Bandcamp +-------- +Bandcamp albums and singles can be scraped using the ``Bandcamp`` preset. + +.. code-block:: yaml + + Bandcamp: + = Lofi: + "Emily Hopkins": "https://emilyharpist.bandcamp.com/"