https://github.com/funnbot/music.d.js

A music library for discord.js
https://github.com/funnbot/music.d.js

discord discord-js music music-library

Last synced: 3 days ago
JSON representation

A music library for discord.js

• Host: GitHub
• URL: https://github.com/funnbot/music.d.js
• Owner: funnbot
• Created: 2017-01-28T06:46:16.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-17T23:42:17.000Z (almost 8 years ago)
• Last Synced: 2024-10-31T23:17:42.854Z (2 months ago)
• Topics: discord, discord-js, music, music-library
• Language: JavaScript
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#music.d.js

A music library for discord.js.

Now it's even easier for the Discord community to make amazing music bots!

[![NPM](https://nodei.co/npm/music.d.js.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/music.d.js/)

#_**⚠️️ DO NOT DOWNLOAD; STILL IN DEVELOPMENT ⚠️️**_

###Example

```js

const Player = require('music.d.js')

let options = {

    scKey: "1234567",

    ytKey: "7654321",

    autoPlay: true

}

let player = Player(options)

voiceChannel.join().then(connection => {

  

   player.addConnection(connection, message)

  

}

```

####options

Value|Default|Description

:---|:---|:---

scKey|false|The SoundCloud API Key (if no key is provided, SoundCloud functionality is disabled)

ytKey|false|The YouTube API Key (if no key is provided, YouTube *playlist* and *search* is disabled)

autoPlay|true|When enabled, will start playing music on queue without having to run `play()`

####Song Object

returned from `queue(song url)` and nextSong event

Value|Description

:---|:---

title|The song title

owner|The song uploader

stream|Streaming url *ignore*

url|The songs url

duration|The song duration in milliseconds

regionsAllowed|Array of regions allowed, `true` if no restrictions

requester|The provided requester info in `queue()` or false if not provided

####Playlist Object

return from `queue(playlist url)`

Value|Description

:----|:----

title|The playlist title

owner|The playlist uploader

tracks|An array of Song Objects

##Player

####.setup({options})

Set up the music player.

>returns Promise\

```js

Player.setup(options)

.then(options => {

    //The options set

})

.catch(err => {

    //Invalid api keys or options were simply incorrect

})

```

####.addConnection(connection, message)

Add a voiceConnection. 

>returns GuildPlayer Class of id, else returns false on error

```js

voiceChannel.join().then(connection => {

    let GuildPlayer = Player.addConnection(connection, message)

})

//connection: The VoiceChannel connection object

//message: The standard d.js Message Object

```

####.get(id)

Get a GuildPlayer by ID, if it exists.

>returns GuildPlayer Class of id, else returns false

```js

let GuildPlayer = Player.get('12345678899')

```

After calling Player.get, you can use the following functions with the returned object:

##GuildPlayer

####.queue(url [, requester)

Queue a song, playlist, or search query.

Requester argument optional. If given, however, it will be returned in the nextSong event.

If autoplay is `true` then this will trigger music to start playing if it isn't already.

>returns Promise\

```js

GuildPlayer.queue('http://youtube.com/yoyoma2', requester).then(song => {

    //Song Object

}.catch(err => //something went wrong)

```