# discordjs-music-plugin > A simple Node.js based music extension/bot for Discord.js projects using YouTube. Latest version **14.1.0** (published 2020-04-25) · ISC license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install discordjs-music-plugin pnpm add discordjs-music-plugin yarn add discordjs-music-plugin bun add discordjs-music-plugin ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 14.1.0 | | Published | 2020-04-25 | | First published | 2020-04-25 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 104.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | TorrenTamm | | Maintainers | torrentamm | | Keywords | "discord", "discord.js", "music", "bot", "addon", "plugin" | ## Links - npm: https://www.npmjs.com/package/discordjs-music-plugin - Repository: https://github.com/TorrenTamm/discordjs-musicbot-plugin - Homepage: https://github.com/TorrenTamm/discordjs-musicbot-plugin#readme - Issues: https://github.com/TorrenTamm/discordjs-musicbot-plugin/issues - npm.io page: https://npm.io/package/discordjs-music-plugin ## Recent versions - 14.1.0 (latest) — 2020-04-25 ## README ## A Little Notice: As you may know, Discord.js recently updated to version 12, which lead to the previous plugin by [DarkoPendragon](https://github.com/DarkoPendragon/) to be deprecated. I have picked up his work and fully updated the plugin to Version 12. All credit for the pre-existing plugin goes to [DarkoPendragon](https://github.com/DarkoPendragon/) # Discord MusicBot Addon *** This module is a simple Node.js based music extension/bot for Discord.js projects using YouTube. This was originally an update of an older addon for newer versions of Discord.js but not serves as it's own module. __The commands available are: (default names)__ * `musichelp [command]`: Displays help text for commands by this addon, or help for a specific command. * `play |`: Play audio from YouTube. * `search `: Search's for up to 10 videos from YT. * `skip [number]`: Skip a song or multi songs with skip [some number]. * `queue [position]`: Display the current queue. * `pause`: Pause music playback. * `resume`: Resume music playback. * `remove [position]`: Remove a song from the queue by position. * `volume`: Adjust the playback volume between 1 and 200. * `leave`: Clears the song queue and leaves the channel. * `clearqueue`: Clears the song queue. * `np`: Show the current playing song. __Permissions:__ * If `anyoneCanSkip` is true, anyone can skip songs in the queue. * If `anyoneCanAdjust` is true, anyone can adjust the volume. * If `ownerOverMember` is true, the set ID of the user (`ownerID`) will over-ride permissions from the bot. *** # Installation *** __Pre-installation:__ 1. `npm install discord.js` It is recommended to have the stable branch. 2. `ffmpeg installed` __correctly__ for your OS/env. Allows the bot to join voice as well as speak. 3. `npm install node-opus` or `npm install opusscript` Required for voice. Discord.js _prefers_ node-opus. __Installation:__ * `npm install discord.js-musicbot-addon` Note that the NPM version will be *slightly behind* the GitHub version. # Examples *** See [this page](https://github.com/TorrenTamm/discord.js-musicbot-plugin/blob/master/examples/examples.md) on the repo for examples. # Options & Config. *** __Most options are optional and thus not needed.__ The options you can pass in `music.start(client, {options})` and their types is as followed: ## Basic Options. | Option | Type | Description | Default | | --- | --- | --- | --- | | youtubeKey | String | A YouTube Data API3 key. Required to run. | NaN | | botPrefix | String | The prefix of the bot. Defaults to "!". Can also be a Map of prefix's. | ! | | messageNewSong | Boolean | Whether or not to send a message when a new song starts playing. | true | | bigPicture | Boolean | Whether to use a large (true) image or small (false) for embeds. | false | | maxQueueSize | Number | Max queue size allowed. Defaults 100. Set to 0 for unlimited. | 50 | | defVolume | Number | The default volume of music. 1 - 200. | 50 | | anyoneCanSkip | Boolean | Whether or not anyone can skip. | false | | messageHelp | Boolean | Whether to message the user on help command usage. If it can't, it will send it in the channel like normal. | false | | botAdmins | Object/Array | An array of Discord user ID's to be admins as the bot. They will ignore permissions for the bot. | [ ] | | anyoneCanAdjust | Boolean | Whether anyone can adjust volume. | false | | ownerOverMember | Boolean | Whether the owner over-rides `CanAdjust` and `CanSkip`. | false | | anyoneCanLeave | Boolean | Whether anyone can make the bot leave the currently connected channel. | false | | ownerID | String | The ID of the Discord user to be seen as the owner. Required if using `ownerOverMember`. | NaN | | logging | Boolean | Some extra none needed logging (such as caught errors that didn't crash the bot, etc). | true | | requesterName | Boolean | Whether or not to display the username of the song requester. | true | | inlineEmbeds | Boolean | Whether or not to make embed fields inline (help command and some fields are excluded). | false | | musicPresence | Boolean | Whether or not to make the bot set its presence to currently playing music. | false | | clearPresence | Boolean | Whether or not to clear the presence instead of setting it to "nothing" | false | | insertMusic | Boolean | Whether or not to insert the music bot data into `.music` on start. | false | | channelWhitelist | Object/Array | Sets a list of ID's allow when running messages. | [ ] | | channelBlacklist | Object/Array | Sets a list of ID's ignore when running messages. | [ ] | | bitRate | String | Sets the preferred bitRate for the Discord.js stream to use. | "120000" | | nextPresence | [PresenceData](https://discord.js.org/#/docs/main/stable/typedef/PresenceData) | PresenceData to set after instead of clearing it (clearPresence). | null | ## Multi-Prefix Option Example ```js .guilds.forEach .start(, { youtubeKey: "Data Key", botPrefix: }); // Exmaple Map Structure {serverID: { prefix: "!" } } ``` See [examples](https://github.com/TorrenTamm/discord.js-musicbot-plugin/blob/master/examples/examples.md) for more info. ## Cooldown | Option | Type | Description | Default | | --- | --- | --- | --- | | cooldown | Object | The main cooldown object | | | cooldown.enabled | Boolean | Whether or not cooldowns are enabled. | true | | cooldown.timer | Number | Time in MS that cooldowns last. | 10000 | | cooldown.exclude | Object/Array | Array of command names to exclude. Uses default names, not set names | ["volume","queue","pause","resume","np"] | ## Command Options. Commands pass a bit different. Each command follows the same format as below. Valid entries are `play`, `remove`, `help`, `np`, `queue`, `volume`, `pause`, `resume`, `skip`, `clearqueue`, `loop`, `leave`, `shuffle`, `deletequeue`. ```js music.start(client, { : { enabled: false, // True/False statement. alt: ["name1","name2","name3"], // Array of alt names (aliases). help: "Help text.", // String of help text. name: "play" // Name of the command. usage: "{{prefix}}play bad memes", // Usage text. {{prefix}} will insert the bots prefix. exclude: false // Excludes the command from the help command. } }); ``` --- _Source: https://npm.io/package/discordjs-music-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._