spotube Documentation

File: README.md Copy Chapter

🌃 Features Copy Chapter

• 🧩 Plugin powered, supports any platform or custom music service through plugins.
• 🗺️ Community driven plugins for popular platforms or create your own.
• ⬇️ Freely downloadable tracks with tagged metadata.
• 🖥️ 📱 Cross-platform support.
• 🪶 Small size & less data usage.
• 🕒 Time synced lyrics regardless of the plugin support.
• ✋ No telemetry, diagnostics or user data collection.
• 🚀 Native performance.
• 📖 Open source/libre software.
• 🔉 Playback control is done locally, not on the server.

📜 ⬇️ Installation guide Copy Chapter

New versions usually release every 3-4 months.
This handy table lists all the methods you can use to install Spotube:

With yay: `yay -Sy spotube-bin` |

| Fedora/OpenSuse | For Fedora: sudo dnf install ./Spotube-linux-x86_64.rpm
For OpenSuse: sudo zypper in ./Spotube-linux-x86_64.rpm |
| Linux (tarball) | |
| Macos - Homebrew | brew tap krtirtho/apps
brew install --cask spotube |
| Windows - Chocolatey | choco install spotube |
| Windows - Scoop | scoop bucket add extras
scoop install spotube |
| Windows - WinGet | winget install --id KRTirtho.Spotube |

🔄 Nightly Builds Copy Section

Grab the latest nightly builds of Spotube from the GitHub Releases.

🕳️ Building from source Copy Chapter

You can compile Spotube's source code by following these instructions.

👥 The Spotube team Copy Chapter

• Kingkor Roy Tirtho - The Founder, Maintainer and Lead Developer
• Owen Connor - The Cool Discord Moderator
• Piotr Rogowski - The MacOS Developer
• Rusty Apple - The Mysterious Unknown Guy

💼 License Copy Chapter

Spotube is open source and licensed under the BSD-4-Clause License.

If you are curious, you can read the reason of choosing this license.

<h2>`[Click to show]` 🙏 Services/Package/Plugin Credits</h2>

Services Copy Section

1. Flutter - Flutter transforms the app development process. Build, test, and deploy beautiful mobile, web, desktop, and embedded apps from a single codebase
2. MPV - mpv is a free (as in freedom) media player for the command line. It supports a wide variety of media file formats, audio and video codecs, and subtitle types.
3. Musicbrainz - MusicBrainz is a MetaBrainz project that aims to create a collaborative music database that is similar to the freedb project.
4. Listenbrainz - ListenBrainz is a open-source project by the MetaBrainz Foundation that allows users to crowdsource and publicly store their digital music listening data.
5. Piped - Piped is a privacy friendly alternative YouTube frontend, which is efficient and scalable by design.
6. Invidious - Invidious is an open source alternative front-end to YouTube.
7. yt-dlp - A feature-rich command-line audio/video downloader.
8. NewPipeExtractor - NewPipe's core library for extracting data from streaming sites.
9. YouTubeExplodeDart - A port in dart of the youtube explode library. Supports several API functions without the need of Youtube API Key.
10. LRCLib - A public synced lyric API.
11. Linux - Linux is a family of open-source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991, by Linus Torvalds. Linux is typically packaged in a Linux distribution
12. AUR - AUR stands for Arch User Repository. It is a community-driven repository for Arch-based Linux distributions users
13. Flatpak - Flatpak is a utility for software deployment and package management for Linux
14. SponsorBlock - SponsorBlock is an open-source crowdsourced browser extension and open API for skipping sponsor segments in YouTube videos.
15. Inno Setup - Inno Setup is a free installer for Windows programs by Jordan Russell and Martijn Laan
16. F-Droid - F-Droid is an installable catalogue of FOSS (Free and Open Source Software) applications for the Android platform. The client makes it easy to browse, install, and keep track of updates on your device
17. LastFM - Last.fm is a music streaming and discovery platform that helps users discover and share new music. It tracks users' music listening habits across many devices and platforms.

Dependencies Copy Section

1. app_links - Android App Links, Deep Links, iOs Universal Links and Custom URL schemes handler for Flutter (desktop included).
2. args - Library for defining parsers for parsing raw command-line arguments into a set of options and values using GNU and POSIX style options.
3. audio_service - Flutter plugin to play audio in the background while the screen is off.
4. audio_service_mpris - audio_service platform interface supporting Media Player Remote Interfacing Specification.
5. audio_session - Sets the iOS audio session category and Android audio attributes for your app, and manages your app's audio focus, mixing and ducking behaviour.
6. auto_route - AutoRoute is a declarative routing solution, where everything needed for navigation is automatically generated for you.
7. auto_size_text - Flutter widget that automatically resizes text to fit perfectly within its bounds.
8. bonsoir - A Zeroconf library that allows you to discover network services and to broadcast your own. Based on Apple Bonjour and Android NSD.
9. cached_network_image - Flutter library to load and cache network images. Can also be used with placeholder and error widgets.
10. connectivity_plus - Flutter plugin for discovering the state of the network (WiFi & mobile/cellular) connectivity on Android and iOS.
11. device_info_plus - Flutter plugin providing detailed information about the device (make, model, etc.), and Android or iOS version the app is running on.
12. dio - A powerful HTTP networking package,supports Interceptors,Aborting and canceling a request,Custom adapters, Transformers, etc.
13. drift - Drift is a reactive library to store relational data in Dart and Flutter applications.
14. duration - Utilities to make working with 'Duration's easier. Formats duration in human readable form and also parses duration in human readable form to Dart's Duration.
15. encrypt - A set of high-level APIs over PointyCastle for two-way cryptography.
16. envied - Explicitly reads environment variables into a dart file from a .env file for more security and faster start up times.
17. file_picker - A package that allows you to use a native file explorer to pick single or multiple absolute file paths, with extension filtering support.
18. file_selector - Flutter plugin for opening and saving files, or selecting directories, using native file selection UI.
19. fluentui_system_icons - Fluent UI System Icons are a collection of familiar, friendly and modern icons from Microsoft.
20. flutter_cache_manager - Generic cache manager for flutter. Saves web files on the storages of the device and saves the cache info using sqflite.
21. flutter_discord_rpc - Discord RPC support for Flutter desktop platforms
22. flutter_displaymode - A Flutter plugin to set display mode (resolution, refresh rate) on Android platform. Allows to enable high refresh rate on supported devices.
23. flutter_feather_icons - Feather is a collection of simply beautiful open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency and usability.
24. flutter_form_builder - This package helps in creation of forms in Flutter by removing the boilerplate code, reusing validation, react to changes, and collect final user input.
25. flutter_hooks - A flutter implementation of React hooks. It adds a new kind of widget with enhanced code reuse.
26. flutter_inappwebview - A Flutter plugin that allows you to add an inline webview, to use an headless webview, and to open an in-app browser window.
27. flutter_native_splash - Customize Flutter's default white native splash screen with background color and splash image. Supports dark mode, full screen, and more.
28. flutter_riverpod - A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
29. flutter_sharing_intent - A flutter plugin that allow flutter apps to receive photos, videos, text, urls or any other file types from another app.
30. flutter_undraw - Undraw.co Illustrations for Flutter with customization options
31. form_builder_validators - Form Builder Validators set of validators for FlutterFormBuilder. Provides common validators and a way to make your own.
32. freezed_annotation - Annotations for the freezed code-generator. This package does nothing without freezed too.
33. fuzzywuzzy - An implementation of the popular fuzzywuzzy package in Dart, to suit all your fuzzy string matching/searching needs!
34. home_widget - A plugin to provide a common interface for creating HomeScreen Widgets for Android and iOS.
35. hooks_riverpod - A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
36. html - APIs for parsing and manipulating HTML content outside the browser.
37. html_unescape - A small library for un-escaping HTML. Supports all Named Character References, Decimal Character References and Hexadecimal Character References.
38. http - A composable, multi-platform, Future-based API for HTTP requests.
39. image_picker - Flutter plugin for selecting images from the Android and iOS image library, and taking new pictures with the camera.
40. intl - Contains code to deal with internationalized/localized messages, date and number formatting and parsing, bi-directional text, and other internationalization issues.
41. local_notifier - This plugin allows Flutter desktop apps to displaying local notifications.
42. logger - Small, easy to use and extensible logger which prints beautiful logs.
43. logging - Provides APIs for debugging and error logging, similar to loggers in other languages, such as the Closure JS Logger and java.util.logging.Logger.
44. lrc - A Dart-only package that creates, parses, and handles LRC, which is a format that stores song lyrics.
45. metadata_god - Plugin for retrieving and writing audio tags/metadata from audio files
46. mime - Utilities for handling media (MIME) types, including determining a type from a file extension and file contents.
47. open_file - A plug-in that can call native APP to open files with string result in flutter, support iOS(UTI) / android(intent) / PC(ffi) / web(dart:html)
48. package_info_plus - Flutter plugin for querying information about the application package, such as CFBundleVersion on iOS or versionCode on Android.
49. palette_generator - Flutter package for generating palette colors from a source image.
50. path - A string-based path manipulation library. All of the path operations you know and love, with solid support for Windows, POSIX (Linux and Mac OS X), and the web.
51. path_provider - Flutter plugin for getting commonly used locations on host platform file systems, such as the temp and app data directories.
52. permission_handler - Permission plugin for Flutter. This plugin provides a cross-platform (iOS, Android) API to request and check permissions.
53. riverpod - A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
54. scroll_to_index - Scroll to a specific child of any scrollable widget in Flutter
55. shadcn_flutter - Beautifully designed components from Shadcn/UI is now available for Flutter
56. shared_preferences - Flutter plugin for reading and writing simple key-value pairs. Wraps NSUserDefaults on iOS and SharedPreferences on Android.
57. shelf - A model for web server middleware that encourages composition and easy reuse.
58. shelf_router - A convenient request router for the shelf web-framework, with support for URL-parameters, nested routers and routers generated from source annotations.
59. shelf_web_socket - A shelf handler that wires up a listener for every connection.
60. simple_icons - The Simple Icon pack available as Flutter Icons. Provides over 1500 Free SVG icons for popular brands.
61. skeletonizer - Converts already built widgets into skeleton loaders with no extra effort.
62. sliding_up_panel - A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!
63. sliver_tools - A set of useful sliver tools that are missing from the flutter framework
64. smtc_windows - Windows SystemMediaTransportControls implementation for Flutter giving access to Windows OS Media Control applet.
65. sqlite3 - Provides lightweight yet convenient bindings to SQLite by using dart:ffi
66. sqlite3_flutter_libs - Flutter plugin to include native sqlite3 libraries with your app
67. timezone - Time zone database and time zone aware DateTime.
68. titlebar_buttons - A package which provides most of the titlebar buttons from windows, linux and macos.
69. tray_manager - This plugin allows Flutter desktop apps to defines system tray.
70. url_launcher - Flutter plugin for launching a URL. Supports web, phone, SMS, and email schemes.
71. uuid - RFC4122 (v1, v4, v5, v6, v7, v8) UUID Generator and Parser for Dart
72. version - Provides a simple class for parsing and comparing semantic versions as defined by http://semver.org/
73. very_good_infinite_list - A library for easily displaying paginated data, created by Very Good Ventures. Great for activity feeds, news feeds, and more.
74. visibility_detector - A widget that detects the visibility of its child and notifies a callback.
75. web_socket_channel - StreamChannel wrappers for WebSockets. Provides a cross-platform WebSocketChannel API, a cross-platform implementation of that API that communicates over an underlying StreamChannel.
76. wikipedia_api - Wikipedia API for dart and flutter
77. win32_registry - A package that provides a friendly Dart API for accessing the Windows Registry.
78. window_manager - This plugin allows Flutter desktop apps to resizing and repositioning the window.
79. youtube_explode_dart - A port in dart of the youtube explode library. Supports several API functions without the need of Youtube API Key.
80. http_parser - A platform-independent package for parsing and serializing HTTP formats.
81. collection - Collections and utilities functions and classes related to collections.
82. archive - Provides encoders and decoders for various archive and compression formats such as zip, tar, bzip2, gzip, and zlib.
83. hetu_script - Hetu is a lightweight scripting language for embedding in Flutter apps.
84. get_it - Simple direct Service Locator that allows to decouple the interface from a concrete implementation and to access the concrete implementation from everywhere in your App"
85. flutter_markdown_plus - A Markdown renderer for Flutter. Create rich text output, including text styles, tables, links, and more, from plain text data formatted with simple Markdown tags.
86. pub_semver - Versions and version constraints implementing pub's versioning policy. This is very similar to vanilla semver, with a few corner cases.
87. change_case - An extension on String for the missing methods for camelCase, PascalCase, Capital Case, snake_case, param-case, CONSTANT_CASE and others.
88. flutter_secure_storage - Flutter Secure Storage provides API to store data in secure storage. Keychain is used in iOS, KeyStore based solution is used in Android.
89. build_runner - A build system for Dart code generation and modular compilation.
90. envied_generator - Generator for the Envied package. See https://pub.dev/packages/envied.
91. flutter_gen_runner - The Flutter code generator for your assets, fonts, colors, … — Get rid of all String-based APIs.
92. flutter_launcher_icons - A package which simplifies the task of updating your Flutter app's launcher icon.
93. flutter_lints - Recommended lints for Flutter apps, packages, and plugins to encourage good coding practices.
94. json_serializable - Automatically generate code for converting to and from JSON by annotating Dart classes.
95. freezed - Code generation for immutable classes that has a simple syntax/API without compromising on the features.
96. process_run - Process run helpers for Linux/Win/Mac and which like feature for finding executables.
97. pubspec_parse - Simple package for parsing pubspec.yaml files with a type-safe API and rich error reporting.
98. pub_api_client - An API Client for Pub to interact with public package information.
99. io - Utilities for the Dart VM Runtime including support for ANSI colors, file copying, and standard exit code values.
100. drift_dev - Dev-dependency for users of drift. Contains the generator and development tools.
101. test - A full featured library for writing and running Dart tests across platforms.
102. auto_route_generator - AutoRoute is a declarative routing solution, where everything needed for navigation is automatically generated for you.
103. desktop_webview_window - Show a webview window on your flutter desktop application.
104. disable_battery_optimization - Flutter plugin to check and disable battery optimizations. Also shows custom steps to disable the optimizations in devices like mi, xiaomi, samsung, oppo, huawei, oneplus etc
105. draggable_scrollbar - A scrollbar that can be dragged for quickly navigation through a vertical list. Additional option is showing label next to scrollthumb with information about current item.
106. flutter_broadcasts - A plugin for sending and receiving broadcasts with Android intents and iOS notifications.
107. scrobblenaut - A deadly simple LastFM API Wrapper for Dart. So deadly simple that it's gonna hit the mark.
108. yt_dlp_dart - A starting point for Dart libraries or applications.
109. flutter_new_pipe_extractor - NewPipeExtractor binding for Flutter (Android only)
110. hetu_std - A sample command-line application.
111. hetu_otp_util - A sample command-line application.
112. hetu_spotube_plugin - A new Flutter package project.
113. media_kit - A cross-platform video player & audio player for Flutter & Dart. Performant, stable, feature-proof & modular.
114. media_kit_libs_audio - package:media_kit audio (only) playback native libraries for all platforms.

File: cli/README.md Copy Chapter

Spotube Configuration CLI Copy Chapter

This is used for building the project for multiple platforms and having utilities specific for the project.
Written in Dart

File: ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md Copy Chapter

Launch Screen Assets

You can customize the launch screen with your own desired assets by replacing the image files in this directory.

You can also do it by opening your Flutter project's Xcode project with open ios/Runner.xcworkspace, selecting Runner/Assets.xcassets in the Project Navigator and dropping in the desired images.

File: website/src/content/docs/reference/libraries.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: Libraries order: 1 Copy Chapter

• [hetu_std][hetu_std] (built-in) - A standard library for hetu_script that provides standard set of functions and utilities.
• [hetu_spotube_plugin][hetu_spotube_plugin] (built-in) - Access to Spotube Plugin API, which provides functions to interact with Spotube.
• [hetu_otp_util][hetu_otp_util] - A pure hetu_script library for OTP utilities, such as generating and verifying OTPs.

{/* Links */}
[hetu_std]: https://github.com/hetu-community/hetu_std
[hetu_spotube_plugin]: https://github.com/KRTirtho/hetu_spotube_plugin
[hetu_otp_util]: https://github.com/hetu-community/hetu_otp_util

File: website/src/content/docs/reference/models.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: Plugin Models order: 0 Copy Chapter

Image Copy Chapter

Following is the structure of the SpotubeImageObject:

User Copy Chapter

Structure of the SpotubeUserObject, which is used to represent a user in Spotube returned by Spotube Plugins.

externalUri is a URL that points to the user's profile on the external service (e.g. Listenbrainz)

Artist Copy Chapter

SpotubeSimpleArtistObject Copy Section

Following is the structure of the SpotubeArtistObject:

SpotubeFullArtistObject Copy Section

Following is the structure of the SpotubeFullArtistObject:

Album Copy Chapter

SpotubeSimpleAlbumObject Copy Section

Following is the structure of the SpotubeAlbumObject:

SpotubeFullAlbumObject Copy Section

Following is the structure of the SpotubeFullAlbumObject:

Track Copy Chapter

Following is the structure of the SpotubeFullTrackObject:

isrc stands for International Standard Recording Code, which is a unique identifier for tracks.
It is used to identify recordings and is often used in music distribution and royalty collection. The format is typically a 12-character alphanumeric code.

Playlist Copy Chapter

SpotubeSimplePlaylistObject Copy Section

Following is the structure of the SpotubeSimplePlaylistObject:

SpotubeFullPlaylistObject Copy Section

Following is the structure of the SpotubeFullPlaylistObject:

Search Response Copy Chapter

Following is the structure of the SpotubeSearchResponseObject:

Browse Section Copy Chapter

Following is the structure of SpotubeBrowseSectionObject:

The items property array can contain multiple type of Object in it but it will always be

• SpotubeFullPlaylistObject
• SpotubeFullAlbumObject
• SpotubeFullArtistObject

Pagination Response Copy Chapter

SpotubePaginationResponseObject is generic model. The items property can contain any type of Object in it.

This is the structure of SpotubePaginationResponseObject:

File: website/src/content/docs/plugin-apis/forms.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: Forms order: 1 Copy Chapter

Spotube provides a Forms API that allows plugin developers to create and manage forms within the Spotube application.

Usage Copy Chapter

Following will show a form with 2 text fields and text in between them:

import "module:spotube_plugin" as spotube

spotube.SpotubeForm.show(
  "The form page title",
  [
    {
      objectType: "input",
      id: "name",
      variant: "text",
      placeholder: "Enter your name",
      required: true,
    }.toJson(),
    {
      objectType: "input",
      id: "password",
      variant: "password", // This will obfuscate the input
      placeholder: "Enter your password",
      required: true,
    }.toJson(),
    {
      objectType: "text",
      text: "This is some text after the two fields.",
    }.toJson(),
  ]
).then((result) {
  // Handle the result
  print(result)
})

The method spotube.SpotubeForm.show takes a title and a list of form field declaration map. The map should be, well obviously a Map.
Following are field map properties:

The method spotube.SpotubeForm.show returns a following format:

[
  {
    "id": "name",
    "value": "John Doe"
  },
  {
    "id": "password",
    "value": "12345678"
  }
]

File: website/src/content/docs/plugin-apis/localstorage.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: LocalStorage order: 2 Copy Chapter

The LocalStorage API is a plain text key/value holding persistent storage for spotube plugins. It's similar to the localStorage API in web browsers.
The API is a 1:1 port of [shared_preferences][shared_preferences] package from pub.dev (Flutter package registry)

The only difference is that the LocalStorage API is 100% asynchronous. So every method returns a Future

Usage Copy Chapter

Get values

Retrieve stored information by key:

import "module:spotube_plugin" as spotube

var LocalStorage = spotube.LocalStorage

// Get a string value by key
LocalStorage.getString("key").then((value) {
    print("Value for 'key': $value")
})

// Get an integer value by key
LocalStorage.getInt("key").then((value) {
    print("Value for 'key': $value")
})

// Get a double value by key
LocalStorage.getDouble("key").then((value) {
    print("Value for 'key': $value")
})

// Get a boolean value by key
LocalStorage.getBool("key").then((value) {
    print("Value for 'key': $value")
})

// Get a list of strings by key
LocalStorage.getStringList("key").then((value) {
    for (var item in value) {
        print("Item in list: $item")
    }
})

Set values

To set or store data in the local storage, you can use the following methods:

// Set a string value by key
LocalStorage.setString("key", "value")

// Set an integer value by key
LocalStorage.setInt("key", 42)

// Set a double value by key
LocalStorage.setDouble("key", 3.14)

// Set a boolean value by key
LocalStorage.setBool("key", true)

// Set a list of strings by key
LocalStorage.setStringList("key", ["item1", "item2", "item3"])

Key operations

To remove a value from the local storage, you can use the remove method:

// Remove a value by key
LocalStorage.remove("key")

To clear all values from the local storage, you can use the clear method:

// Clear all values from local storage
LocalStorage.clear()

To check if a key exists in the local storage, you can use the containsKey method:

// Check if a key exists
LocalStorage.containsKey("key").then((exists) {
    if (exists) {
        print("Key 'key' exists in local storage")
    } else {
        print("Key 'key' does not exist in local storage")
    }
})

{/* Links */}
[shared_preferences]: https://pub.dev/packages/shared_preferences

File: website/src/content/docs/plugin-apis/timezone.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: TimeZone order: 3 Copy Chapter

The TimeZone API provides access to the current time zone of the device running Spotube. This can be useful for plugins that need to display
or handle time-related information based on the user's local time zone.

Usage Copy Chapter

To use the TimeZone API, you can import the spotube_plugin module and access the TimeZone class.

import "module:spotube_plugin" as spotube

var TimeZone = spotube.TimeZone

To get current local time zone for the device, you can use the getLocalTimeZone method:

TimeZone.getLocalTimeZone().then((timeZone) {
    print("Current local time zone: $timeZone") // e.g., "America/New_York"
})

To get all available time zones, you can use the getAvailableTimeZones method:

TimeZone.getAvailableTimeZones().then((timeZones) {
    for (var tz in timeZones) {
        print("Available time zone: $tz") // e.g., "America/New_York", "Europe/London", etc.
    }
})

File: website/src/content/docs/plugin-apis/webview.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: WebView order: 0 Copy Chapter

The [hetu_spotube_plugin][hetu_spotube_plugin] is a built-in module that plugin developers can use in their plugins.

import "module:spotube_plugin" as spotube

WebView API Copy Chapter

The WebView API allows plugins to create and manage web views within the Spotube application.

Usage Copy Section

First, an WebView instance needs to be created with uri.

import "module:spotube_plugin" as spotube

let webview = spotube.Webview(uri: "https://example.com")

To open the webview, you can use the open method:

webview.open() // returns Future<void>

To close the webview, you can use the close method:

webview.close() // returns Future<void>

Listening to URL changes Copy Section

You can listen to url change events by using the onUrlRequestStream method. It's emitted when the URL of the webview changes,
such as when the user navigates to a different page or clicks a link.

// Make sure to import the hetu_std and Stream
import "module:hetu_std" as std

var Stream = std.Stream

// ... created webview instance and other stuff

var subscription = webview.onUrlRequestStream().listen((url) {
    // Handle the URL change
    print("URL changed to: $url")
})

// Don't forget to cancel the subscription when it's no longer needed
subscription.cancel()

Retrieving cookies Copy Section

To get cookies from the webview, you can use the getCookies method:

webview.getCookies("https://example.com") // returns Future<List<Cookie>>

You can find the [Cookie class][spotube_plugin_cookie] and all it's methods and properties in the
hetu_spotube_plugin module source code

{/* Links */}
[hetu_spotube_plugin]: https://github.com/KRTirtho/hetu_spotube_plugin
[spotube_plugin_cookie]: https://github.com/KRTirtho/hetu_spotube_plugin/blob/main/lib/assets/hetu/webview.ht

File: website/src/content/docs/get-started/installing-plugins.mdx Copy Chapter

layout: "layouts/DocLayout.astro" title: Installing plugins order: 1 Copy Chapter

Let's first learn how to install plugins in Spotube. It's pretty simple.

1. Open Spotube (duh!)
2. Go to Settings
3. Then go to the top option, "Metadata provider plugins"
4. You can see a list of all the plugins that are available to install

More ways to install new plugins Copy Chapter

Usually, Spotube will list public repositories of plugins from github and codeberg in the Available plugins section.
This is a non curated list, so be careful when installing plugins. Always check the source before installing.
A malicious plugin given full access can easily steal your credentials. So be careful!

Try to use the Official tagged plugins all the time if you don't want to deal with potential security risks.

• Upload plugin from local file: You can also install plugins from local file (plugin.smplug) using the Orange Upload button on the top right beside the text field.
• Install plugin from URL: If you have a direct link to a plugin file, you can just paste the URL in the text field and use the gray download button beside it

If you're a developer, you can create your own plugins and share them with the community. Check out the Plugin Development Guide for more information.