# discord-music-core

> A discord.js bot music package.

Latest version **1.0.2** (published 2019-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install discord-music-core
pnpm add discord-music-core
yarn add discord-music-core
bun add discord-music-core
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-10-13 |
| First published | 2019-10-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=11.12.0 |
| Dependencies | 8 |
| Unpacked size | 91.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Absolute Development |
| Maintainers | absolute-development |
| Keywords | music, player, wrapper, discord, discord.js, YouTube |

## Links

- npm: https://www.npmjs.com/package/discord-music-core
- Repository: https://github.com/Absolute-Development/discord-music-core
- Homepage: https://github.com/Absolute-Development/discord-music-core#readme
- Issues: https://github.com/Absolute-Development/discord-music-core/issues
- npm.io page: https://npm.io/package/discord-music-core

## Dependencies (8)

- [ffmpeg](https://npm.io/package/ffmpeg.md) 0.0.4
- [ts-node](https://npm.io/package/ts-node.md) ^8.3.0
- [node-opus](https://npm.io/package/node-opus.md) ^0.3.2
- [ytdl-core](https://npm.io/package/ytdl-core.md) ^0.29.7
- [discord.js](https://npm.io/package/discord.js.md) ^11.5.1
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.138
- [ffmpeg-static](https://npm.io/package/ffmpeg-static.md) ^2.6.0
- [simple-youtube-api](https://npm.io/package/simple-youtube-api.md) ^5.2.1

## Recent versions

- 1.0.2 (latest) — 2019-10-13
- 1.0.1 — 2019-10-13
- 1.0.0 — 2019-10-13

## README

# discord-music-wrapper


[![NPM](https://nodei.co/npm/discord-music-core.svg)](https://nodei.co/npm/discord-music-core/)

_**This package is currently under heavy development.**_
If you encountered any bugs or have some feature requests/questions, please open a new issue and describe it briefly.  
As an alternative, you can join my discord server for further enquiries.

This package can help you with playing music in a discord.js bot.

## musicClientOptions

| Option |Default|Description|
|---|---|---|
|`earProtections`|`true`|Using `false` will by pass the limit on the volume command, accepting volumes higher than `100`.|
|`loop`|`false`|Using `true` will set the loop setting enabled upon queue creation.|
|`songChooseTimeout`|`10`|The song choose timeout after searching for a song, in terms of seconds. Default is `10` seconds.|
|`volume`|`30`|Volume based on `100`, such that the default setting will be `30/100` and thus make the volume safe for turning the music bot volume in discord to 100%. Tuning up the volume higher than `50` is not recommended.|

## Links

Github issues : <https://github.com/Absolute-Development/discord-music-core/issues>  
Github pull requesets : <https://github.com/Absolute-Development/discord-music-core/pulls>  
npm package page : <https://www.npmjs.com/package/discord-music-core>  

## Usage

```js
    const MusicClient = require("discord-music-core")
    const musicPlayer = new MusicClient("Youtube Api key")
    musicPlayer.play(message, searchArray) // Searches for and add the searched results to the queue.
    musicPlayer.playTop(message, searchArray) // Searches for and add the searched results to the top of the queue.
    musicPlayer.stop(message) // Stop the music, which includes clearing the queue.
    musicPlayer.nowPlaying(message) // Display the music title for now playing.
    musicPlayer.showQueue(message) // Displays the whole music queue.
    musicPlayer.skip(message) // Skip the song that is now playing.
    musicPlayer.remove(message) // Removes certain position of song in the song queue.
    musicPlayer.pause(message) // Pauses the music queue.
    musicPlayer.repeat(message) // Repeats the current song.
    musicPlayer.loop(message) // Loops the whole queue.
    musicPlayer.shuffle(message) // Shuffles the whole queue.
    musicPlayer.volume(message, volume) // Sets the volume to the certain amount. Using negative values will show the volume that is using now instead.
```

---
_Source: https://npm.io/package/discord-music-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._