@tireoz/spotify
v1.0.2
Published
A DisTube custom plugin for supporting Spotify with SoundCloud.
Downloads
1
Maintainers
Readme
@tireoz/spotify
A DisTube custom plugin for supporting Spotify URL.
Feature
This plugin grabs the songs on Spotify then searches on SoundCloud and plays with DisTube.
Installation
npm install @tireoz/spotify@latest
Usage
const Discord = require("discord.js");
const client = new Discord.Client();
const { DisTube } = require("distube");
const { SpotifyPlugin } = require("@tireoz/spotify");
const distube = new DisTube(client, {
plugins: [new SpotifyPlugin()],
});
or
import { Client } from "discord.js";
import { DisTube } from "distube";
import { SpotifyPlugin } from "@tireoz/spotify";
const client = new Client();
const distube = new DisTube(client, {
plugins: [new SpotifyPlugin()],
});
Documentation
SpotifyPlugin([SpotifyPluginOptions])
SpotifyPluginOptions.parallel
: Default istrue
. Whether or not searching the playlist in parallel.SpotifyPluginOptions.emitEventsAfterFetching
: Default isfalse
. EmitsaddList
andplaySong
event before or after fetching all the songs.If
false
, DisTube plays the first song -> emitsaddList
andplaySong
events -> fetches all the rest
Iftrue
, DisTube plays the first song -> fetches all the rest -> emitsaddList
andplaySong
eventsSpotifyPluginOptions.api
: (Optional) Spotify API options.SpotifyPluginOptions.api.clientId
: Client ID of your Spotify application (Optional - Used when the plugin cannot get the credentials automatically)SpotifyPluginOptions.api.clientSecret
: Client Secret of your Spotify application (Optional - Used when the plugin cannot get the credentials automatically)SpotifyPluginOptions.api.topTracksCountry
: Country code of the top artist tracks (ISO 3166-1 alpha-2 country code). Default isUS
.
Example
new SpotifyPlugin({
parallel: true,
emitEventsAfterFetching: false,
api: {
clientId: "SpotifyAppClientID",
clientSecret: "SpotifyAppClientSecret",
topTracksCountry: "VN",
},
});