-
Notifications
You must be signed in to change notification settings - Fork 16
Config Keys
Default values of config are:
{
"sp_dc": "",
"download_path": "downloads",
"create_folder": true,
"album_folder_name": "{name} - {artists}",
"play_folder_name": "{name} - {owner}",
"file_name": "{track_number}. {name}",
"synced_lyrics": true,
"force_download": false,
"force_synced": false
}| Key | Defintion |
|---|---|
| sp_dc | To authenticate against Spotify and get the lyrics. |
| download_path | Path to save the generated lrc files. |
| create_folder | Should the program create a new folder when downloading album or playlist. |
| album_folder_name | Album folder name format, to be used for folders. |
| play_folder_name | Playlist folder name format, to be used for folders. |
| file_name | File (LRC) name format, to be used while creating the file. |
| synced_lyrics | Download synced lyrics that is lyrics with timestamp. |
| force_download | Skips checking if it's already downloaded and available in local storage. |
| force_synced | Only download lyrics if they available in synced format in Spotify. |
Format variables are {name}, {artists}, {label}, {release_date}, {total_tracks}, {popularity}, {uri}, {id}.
Don't forget to add curly brackets in the variables otherwise they will consider as strings and won't be formatted.
-
{popularity}is an extremely important value that Spotify uses internally to rank all artists and tracks on a scale from 0 to 100. -
{uri}and{id}are unique values used by Spotify, to identify the album.
album_folder_name is config key which used to set album name format.
defaults to:
"album_folder_name": "{name} - {artists}"Format variables are {name}, {owner}, {description}, {total_tracks}, {collaborative}, {uri}, {id}.
Don't forget to add curly brackets in the variables otherwise they will consider as strings and won't be formatted.
-
{owner}is the name of the person who created the playlist. -
{description}is description about the playlist provided by the owner. -
{collaborative}if the playlist is collaborative then it will add[C]. -
{uri}and{id}are unique values used by Spotify, to identify the playlist.
play_folder_name is config key which used to set album name format.
defaults to:
"play_folder_name": "{name} - {owner}"Format variables are {name}, {artist}, {album_artist}, {album_name}, {explicit}, {track_number}, {release_date}, {total_tracks}, {disc_number}, {popularity}, {uri}, {id}.
Don't forget to add curly brackets in the variables otherwise they will consider as strings and won't be formatted.
-
{explicit}if the track is explicit then it will add[E]. -
{popularity}is an extremely important value that Spotify uses internally to rank all artists and tracks on a scale from 0 to 100. -
{uri}and{id}are unique values used by Spotify, to identify the track.
file_name is config key which used to set track name format.
defaults to:
"file_name": "{track_number}. {name}"