Skip to content

Latest commit

 

History

History
161 lines (121 loc) · 8.72 KB

usage.md

File metadata and controls

161 lines (121 loc) · 8.72 KB
Raw
Logo of OnTheSpot

Getting Started

When launching the application for the first time you will receive a warning that no Spotify accounts are added.

  1. Dismiss the Warning

    • Click the close button on the warning dialog.

  2. Add Your Spotify Account(s)

    • Navigate to the Configuration tab.
    • Scroll to the bottom and add your Spotify account(s).

Tip

Adding multiple accounts allows you to download multiple songs simultaneously, speeding up the download process.

[WIP: Youtube Video Explaining the Usage]

2. Searching and Downloading Music

Search by Query

  1. Navigate to the Search Tab

    • Click on the Search tab within the application.

  2. Enter Your Search Terms

    • Type the name of a song, artist, album, or playlist into the search bar.

  3. Execute the Search

    • Click the Search button to retrieve results.

  4. Download Music

    • Single Download: Click the Download button next to the desired item.
    • Bulk Download: Use the buttons below the results table to download multiple items at once.

Note

Downloading large media types like albums or playlists may take longer. The application might appear unresponsive during this process. Please be patient.

Tip

You can also specify the path to a text file containing the links you want to download.

Download by URL

  1. Enter the URL

    • Paste the Spotify URL of a song, album, artist, or playlist into the search field.

  2. Start the Download

    • Click the Download button to begin downloading.

  3. Bulk URL Downloads

    • You can also provide a path to a text file containing multiple URLs. OnTheSpot will queue all listed URLs for downloading.

Important

Ensure each URL in the text file is on a separate line to avoid errors during the download process.

Note

Similar to bulk downloads via query, downloading media types other than 'Tracks' may take longer and cause the app to appear frozen temporarily.

4. Configuration

Customize OnTheSpot to fit your preferences by adjusting the settings in the Configuration tab.

General Configuration Options

Caution

Changing some settings may affect the organization and quality of your downloaded music. Proceed with adjustments only if you are familiar with the options.

Open Advanced Options
Option Description
Download Path Root folder where all downloaded media will be saved.
Theme Choose the application theme (light or dark).
Download Buttons Adds extra functionalities like copying song links, opening tracks in your local music player, and locating the download directory.
Show Thumbnails In Search/Downloads Display thumbnails on respective page.
Thumbnail Size Change the size of thumbnail icons.
Max Search Results Limits the number of search results displayed for each media type (e.g., songs, albums).
Explicit Label Customize how explicit content is labeled in file names and the app (default: 🅴).
Disable Bulk Download Notices Disables pop-up messages while downloading multiple songs or episodes.
Mirror Spotify Playback Download currently playing song on the selected spotify account
Windows 10 Explorer Thumbnails Embed thumbnails in a format that respects Windows 10 explorer and media player, this is an older format of ID3 and not widely supported.
Check for Updates Automatically check for application updates.
Track/Episode Format Select the audio format for your downloaded music or podcasts (e.g. mp3, flac, ogg, m4a).
Track/Episode Path Customize the file naming pattern for tracks, episodes, and playlists using variables like {artist}, {album}, etc.
Use Custom Playlist Path Enable the use of a custom path format for playlists.
Playlist Path Customize the file naming pattern for playlists using variables like {artist}, {album}, etc.
Create M3U Files for Playlists If enabled create an M3U file for downloaded tracks in a playlist.
M3U Path Customize the download path of created M3U files using variables like {artist}, {album}, etc.
EXTINF Seperator M3U EXTINF metadata / list seperator.
EXTINF Path Customize the M3U EXTINF label using variables like {artist}, {album}, etc.
Save Album Cover Save album cover as an image with a default format of cover.png
Album Cover Format The image format to save album covers in (default: png)
Illegal Character Replacement Replace illegal characters in the filepath with the value specified (e.g., /, \, <, >, *, etc.).
Download Lyrics* Enable downloading of lyrics for each track/episode. This feature requires a premium account.
Download Synced Lyrics Only* Only download synced lyrics for tracks. This feature requires a premium account.
Save LRC File* Save lyrics in an .lrc file alongside the track. This feature requires a premium account.
File Bitrate Set the bitrate of a converted file, default value is 320k
File Hertz Set the hertz of a converted file, default value is 44100
Rotate Active Account Automatically rotate between added accounts for downloading to minimize the chance of hitting rate limits.
Raw Media Download Downloads an unmodified file from whatever service is selected. With this enabled file conversion and the embedding of any metadata is skipped.
Download Delay Time (in seconds) to wait before initiating the next download. Helps prevent Spotify's rate limits.
Download Chunk Size The chunk size in which to download files.
Translate File Path Translate file paths into the application language.
Metadata Separator Set the separator for metadata fields with multiple values (default: ; ).
Overwrite Existing Collection If a file already exists re-embed metadata in your selected format.
Embed Metadata Tags Select which metadata tags to embed in downloaded files (e.g., artist, album, year, lyrics, etc.).

Track/Episode/Playlist Path Format

  • Customize File Names

    • Define how downloaded tracks are named using variables enclosed in {}.

  • Available Variables

    Open Variables Table
    Variable Description
    {service} The music service used to download your file
    {artist} Name of the artist(s).
    {album_artist} Name of the album artist(s).
    {album_type} Name of the artist type (single, album, etc).
    {album} Name of the album.
    {name} Name of the track.
    {year} Release year of the track.
    {track_number} Track number on the album.
    {trackcount} Total number of tracks in the album
    {disc_number} Disc number (if applicable).
    {discccount} Total number of discs in the album (if applicable).
    {genre} Genre of the song.
    {label} Name of the record label.
    {explicit} Displays 'Explicit Label' if the song is marked explicit (default: 🅴).
    {playlist_name} Name of the playlist (if part of a playlist).
    {playlist_owner} Name of the playlist owner (if part of a playlist).
    {playlist_number} Item number in a playlist (if part of a playlist).

Tip

Example: Setting the format to {artist} - {name}.mp3 will result in files named like Artist Name - Song Title.mp3.

6. Saving Your Configuration

  • Apply Changes
    • After adjusting any settings, click the Save Settings button on the right to apply your changes.

Important

Some configuration changes may require restarting OnTheSpot to take effect. Make sure to restart the application if prompted.