This project is NO LONGER SUPPORTED and does NOT function. Do not use this. This repo serves as an archive of my work. If anyone wishes to re-upload this project, re-do it, or use it in any way you have my full permission. I am no longer supporting or working on this or any other projects not listed on my personal Discord. You may still join the Discord by clicking here.

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 <url>|<search string>: Play audio from YouTube.
• search <search string>: 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.

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
  If you have troubles installing, see this link or join the discord server. Note that the NPM version will be slightly behind the GitHub version.

See this page on the repo for examples.

Most options are optional and thus not needed.
The options you can pass in music.start(client, {options}) and their types is as followed:

<Client>.guilds.forEach
<Music>.start(<Client>, {
  youtubeKey: "Data Key",
  botPrefix: <MapObject>
});

// Exmaple Map Structure
{serverID: { prefix: "!" } }

See examples for more info.

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.

music.start(client, {
  <command>: {
    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.
  }
});