discord-player-navidrome

Navidrome extractor for discord-player. Note: This uses the Subsonic-compatible API until the native Navidrome API is stable and documented.

Install

npm install discord-player-navidrome

Usage

import { Player } from "discord-player";
import { NavidromeExtractor } from "discord-player-navidrome";

const player = new Player(client);

await player.extractors.register(NavidromeExtractor, {
  username: "user",
  password: "secret",
  host: "https://navidrome.example.com",
  source: "arbitrary", // optional
  protocols: ["myapp"], // optional
});

Capabilities

• Search support for songs, albums ('album:' or 'al:') & playlist ('playlist:' or 'pl:') ✅
• Single tracks by ID ✅
• Playlist by URL or by playlist: name query ✅
• Album by URL or by album: name query ✅
• Streaming ✅
• Bridge support ✅ (not tested)
• Autoplay ✅

Options

• username: Navidrome username.
• password: Navidrome password.
• host: Base URL for your server. https://host or https://host/rest both work.
• source: Optional string. Default arbitrary.
• protocols: Optional list of additional protocols (added to defaults: navidrome, subsonic, nd, ss).
• usePlainPassword: Optional boolean. Default false (uses enc: hex).
• clientName: Optional string. Default discord-player.
• apiVersion: Optional string. Default 1.16.1.
• maxResults: Optional number. Default 10.

Notes

• Empty/public playlists are skipped in playlist: results.
• Playlist search only considers public playlists; direct playlist links can still resolve private playlists.
• playlist: with no query returns up to 25 public playlists; if none exist, a placeholder result is returned.
• UI links are only accepted when they match the configured host.
• Playlist links are detected by the /playlist/{id} path inside the URL hash or navidrome://playlist/{id}.
• Track links are detected by /song/{id} inside the URL hash.
• Album links are detected by the /album/{id} path inside the URL hash or navidrome://album/{id}.