If you would like to use `streamrip`'s conversion capabilities, download TIDAL videos, or download music from SoundCloud, install [ffmpeg](https://ffmpeg.org/download.html).
token_expiry: 'Tokens last 1 week after refresh. This is the Unix timestamp of the expiration time.'
deezer: "Deezer doesn't require login"
quality: '0, 1, or 2'
soundcloud:
quality: 'Only 0 is available'
database: 'This stores a list of item IDs so that repeats are not downloaded.'
filters: "Filter a Qobuz artist's discography. Set to 'true' to turn on a filter."
extras: 'Remove Collectors Editions, live recordings, etc.'
repeats: 'Picks the highest quality out of albums with identical titles.'
non_albums: 'Remove EPs and Singles'
features: 'Remove albums whose artist is not the one requested'
non_remaster: 'Only download remastered albums'
downloads:
folder: 'Folder where tracks are downloaded to'
source_subdirectories: "Put Qobuz albums in a 'Qobuz' folder, Tidal albums in 'Tidal' etc."
artwork:
embed: 'Write the image to the audio file'
size: "The size of the artwork to embed. Options: thumbnail, small, large, original. 'original' images can be up to 30MB, and may fail embedding. Using 'large' is recommended."
keep_hires_cover: 'Save the cover image at the highest quality as a seperate jpg file'
metadata: 'Only applicable for playlist downloads.'
set_playlist_to_album: "Sets the value of the 'ALBUM' field in the metadata to the playlist's name. This is useful if your music library software organizes tracks based on album name."
new_playlist_tracknumbers: "Replaces the original track's tracknumber with it's position in the playlist"
path_format: 'Changes the folder and file names generated by streamrip.'
folder: 'Available keys: "albumartist", "title", "year", "bit_depth", "sampling_rate", and "container"'
track: 'Available keys: "tracknumber", "artist", "albumartist", "composer", and "title"'
lastfm: 'Last.fm playlists are downloaded by searching for the titles of the tracks'
source: 'The source on which to search for the tracks.'
concurrent_downloads: 'Download (and convert) tracks all at once, instead of sequentially. If you are converting the tracks, and/or have fast internet, this will substantially improve processing speed.'
`streamrip` was designed to be used seamlessly with the macOS Music app. To set it up, you need to find the `Automatically Add to Music.localized` folder inside the file given at `Music.app -> Preferences -> Files -> Music Media folder location`. Set the downloads folder to the path in the config file.
Next, enable `conversion` and set the `codec` to `alac`. If you want to save space, set `sampling_rate` to `48000`. Finally, set `keep_hires_cover` to `false`.
Now, you can download anything and it will appear in your Library!
If you're getting an error that looks something like `command not found: rip`, make sure the location of the `rip` executable is on the `$PATH` (`PATH` for Windows) environment variable.
If you're having other issues with the tool, try the following:
I will not be responsible for how you use `streamrip`. By using `streamrip`, you agree to the terms and conditions of the Qobuz, Tidal, and Deezer APIs.
