forked from casualsnek/onthespot
-
-
Notifications
You must be signed in to change notification settings - Fork 14
USAGE
ungaul edited this page Jan 23, 2025
·
1 revision
This guide provides basic usage instructions for each interface. For detailed information, refer to the respective wiki files:
- config: For configuration options.
- installation: For installation steps and requirements.
- integration: For integration details.
- variables: For installation steps and requirements.
- wiki-cli: For command-line interface usage.
- wiki-gui: For graphical user interface usage.
- wiki-webui: For web user interface usage.
- Open your terminal.
- Run commands directly:
- Example:
search "Daft Punk" - Example:
download --url https://example.com/media
- Example:
- Automate tasks by creating and running batch scripts.
- Access help:
--helporcommand --helpfor usage instructions.
Refer to wiki-cli for detailed CLI commands and features.
- Launch the WebUI in your browser by navigating to
http://localhost:PORT. - Log in or configure your account via the settings panel.
- Search and manage downloads interactively:
- Use the search bar for queries or paste URLs.
- View organized results and initiate downloads.
- Adjust settings and manage accounts from the dashboard.
Refer to wiki-webui for more details on WebUI features.
- Open the application.
- Navigate through the intuitive interface:
- Use the navigation menu for quick access.
- Perform searches, manage downloads, and customize settings.
- Add accounts or adjust configurations from the settings panel.
- Use visual indicators and controls to monitor downloads and system status.
Refer to wiki-gui for more information on GUI features.
For further questions or support, consult the respective wiki files or community resources.
<<<<<<< Updated upstream
-
Crunchyroll: To login to your Qobuz account simply enter your email and password, 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'.
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.
| Option | Description |
|---|---|
| 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. |
| Illegal Character Replacement | Replace illegal characters in the filepath with the value specified (e.g., /, \, <, >, *, etc.). |
| 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. |
| Option | Description |
|---|---|
| Audio Download Path | Root folder where all downloaded audio will be saved. |
| 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. |
| 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) |
| 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 |
| Use Custom File Bitrate | Use the user specified 'File Bitrate' field, if disabled the app will use the maximum value allowed by your account. |
| 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.
|
| Translate File Path | Translate file paths into the application language. |
| 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.). |
| Option | Description |
|---|---|
| Video Download Path | Root folder where all downloaded video will be saved. |
| Movie/Episode Format | Select the file format to output your downloaded movies or episodes (e.g. mp4, mkv). For a complete list of supported codecs please see the following list. |
| Movie/Episode Path | Customize the file naming pattern for movies and episodes using variables like {artist}, {album}, etc. |
| Preferred Video Resolution | If available, videos downloaded will use the resolution specified. |
| Download Subtitles | Specify whether you would like to download subtitles if available. |
| Preferred Audio/Subtitle Language | Preferred download language for the specified media format, formatted as en-US. |
| Download All Available Audio/Subtitles | Download all available audio or subtitles for a given video. |
-
Customize File Names
- Define how downloaded media is named using variables enclosed in
{}.
- Define how downloaded media is named using variables enclosed in
-
Universal Variables
Variable Description {service}The music service used to download your file. {service_id}The tracks native id on the selected music service. {name}Name of the track. {year}Release year of the track. {explicit}Displays 'Explicit Label' if the song is marked explicit (default: 🅴). -
Audio Variables
Variable Description {artist}Name of the artist(s). {album_artist}Name of the album artist(s). {album_type}Name of the artist type (single, album, etc). {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. {track_number}Track number on the album. {trackcount}Total number of tracks in the album {isrc}ISRC of the currently playing track. {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). -
Show Variables
Variable Description {show_name}Name of the playlist (if part of a playlist). {season_number}Name of the playlist owner (if part of a playlist). {episode_number}Item number in a playlist (if part of a playlist).
Tip
Example:
Setting the format to {artist} - {name} will result in files named like Artist Name - Song Title.mp3.
-
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. =======
Stashed changes
Footer