Skip to content

Latest commit

 

History

History
149 lines (120 loc) · 11.1 KB

USAGE.md

File metadata and controls

149 lines (120 loc) · 11.1 KB

Usage Guide

1. Logging into your accounts

OnTheSpot supports various accounts and instructions for each are listed below, for further assistance please reach out for support on the community discord here.

  • Apple Music: Enter your media-user-token. It can be obtained in chrome by logging into https://music.apple.com, pressing ctrl + shift + i to open inspect element, clicking the 'Application' or 'Storage' header, opening the music.apple.com cookie, and copying the media-user-token value. Please note a premium account is required to download music.

  • Bandcamp: Bandcamp offers public downloads and does not require an account, simply click 'Add Bandcamp Account' and restart the app.

  • Deezer: Paste your arl into the bar provided and click add account. To get your arl log into the deezer website, press ctrl + shift + i to open inspect element, navigate to the 'Application' or 'Storage' header, and open the www.deezer.com cookie. Your arl should be listed under one of the values provided.

  • Qobuz: To login to your Qobuz account simply enter your email and password, and restart the app. If you would like to login using your user_auth_token you can append the following to the accounts section of your config file.

    {
       # Random string of numbers and letters
       "uuid": UUID,
       "service": "qobuz",
       "active": true,
       "login": {
             # Email is not used during token logins
             "email": "[email protected]",
             # Password is not used during token logins
             "password": "n/a",
             "app_id": APP_ID,
             "app_secrets": [
                APP_SECRET
             ],
             "user_auth_token": USER_AUTH_TOKEN
       }
    }
  • Soundcloud: Soundcloud offers public downloads and does not require an account, simply click 'Add Soundcloud Account' and restart the app. If you have a GO+ account and would like to support development please reach out.

  • Spotify: Ensure that both OnTheSpot and the Spotify Desktop App are not restricted by a firewall or vpn so that they can communicate. Click add account and then head over to devices in the Spotify app. Under devices you should see 'OnTheSpot', select it. Once complete the app will prompt you to restart.

  • Tidal: The app will provide you a link, open the link and login in your browser.

  • Youtube Music: Youtube Music offers public downloads and does not require an account, simply click 'Add Youtube Music Account' and restart the app.

  • Generic Downloader: Generic Downloader uses yt-dlp to rip any available music or videos from a given webpage. A list of supported services is available in the app or here. Even if your given website is not listed the generic downloader may be able to rip media anyway, just paste your url in the search bar. To activate generic downloader simply click 'Add Generic Downloader'.

2. Searching and Downloading Music

The search bar is able to parse queries, urls, and text files.

If a query is provided, say 'Daft Punk' for instance, the app will provide results to the query seperated into categories: Tracks, Albums, Artists, Playlists, and depending on the music service Episodes, Podcasts, and Audiobooks.

If a url is provided the app will parse the url and immediately begin downloading.

If a file path is provided the app will parse each line in the file for urls beginning in either http:// or https:// and begin downloading the items listed.

4. Configuration

General Settings

Option Description
Download Path Root folder where all downloaded media will be saved.
Theme Choose the application theme (light or dark).
Explicit Label Customize how explicit content is labeled in file names and the app (default: 🅴).
Download Buttons Adds extra functionalities to the download queue.
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).
Disable Download Popups Disables pop-up messages while downloading items.
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.
Close To Tray Close application to tray on exit.
Check for Updates Automatically check for application updates.

Audio Download Settings

Option Description
Track/Episode Format Select the file format to output your downloaded tracks or podcasts (e.g. mp3, m4a, flac, ogg, wav). For a complete list of supported codecs please see the following list.
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.
File Bitrate Set the bitrate of a converted file, default value is 320k. This setting is not respected by some lossless codecs, results may vary depending on your chosen filetype.
File Hertz Set the hertz of a converted file, default value is 44100
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 may require a premium account.
Download Synced Lyrics Only* Only download synced lyrics for tracks. This feature may require a premium account.
Save LRC File* Save lyrics in an .lrc file alongside the track. This feature may require a premium account.
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. Lyrics and cover art will still be downloaded.
Download Delay (s) The time,in seconds, to wait before initiating the next download. Helps prevent rate limits.
Download Chunk Size (b) The chunk size, in bytes, in which to download files.
Maximum Queue Workers Set the maximum number of queue workers. Setting a higher number will queue songs faster, only change this setting if you know what you're doing. Changes to this setting require you to restart the app take effect.
Maximum Download Workers Set the maximum number of download workers. Only change this setting if you know what you're doing. Changes to this setting require you to restart the app to take effect.
Enable Retry Worker Creates a worker that automatically retries failed downloads after a specified amount of time. Changes to this setting require you to restart the app to take effect.
Retry Delay (m) The time, in minutes, for the retry worker to wait before retrying failed items.
Translate File Path Translate file paths into the application language.

Metadata Settings

Option Description
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.).

Video Download Settings

Option Description
Video Download Path Videos downloaded using the Generic Downloader account will be downloaded to the following path
Download Youtube Videos If this setting is enable OnTheSpot will download https://music.youtube.com/... as audio and https://www.youtube.com/... as a video. If this setting is disabled both will be downloaded using your Youtube Music account.
Preferred Video Resolution If available, videos downloaded using the Generic Downloader account will use the resolution specified.

Track/Episode/Playlist Path Format

  • Customize File Names

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

    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).
    {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 to apply your changes. Some configuration changes may require restarting the app to take effect.