# @frogebot/music

> Discord music bot module, designed for FrogeBot

Latest version **1.0.0** (published 2021-03-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install @frogebot/music
pnpm add @frogebot/music
yarn add @frogebot/music
bun add @frogebot/music
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-03-02 |
| First published | 2021-03-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 62 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | barnab_why |

## Links

- npm: https://www.npmjs.com/package/@frogebot/music
- npm.io page: https://npm.io/package/@frogebot/music

## Dependencies (6)

- [ytdl](https://npm.io/package/ytdl.md) ^1.4.1
- [ytpl](https://npm.io/package/ytpl.md) ^2.0.5
- [ytsr](https://npm.io/package/ytsr.md) ^3.3.1
- [discord.js](https://npm.io/package/discord.js.md) ^12.5.1
- [opusscript](https://npm.io/package/opusscript.md) 0.0.8
- [@discordjs/opus](https://npm.io/package/@discordjs/opus.md) ^0.4.0

## Recent versions

- 1.0.0 (latest) — 2021-03-02

## README

# @frogebot/music
Discord music bot module, designed for FrogeBot

----

## Installation
```bash
$ npm i @frogebot/music
```
## Use
```js
let frogeMusic = require("@frogebot/music")(options);
```
### Options
`BOT_NAME` (str, optional) - The name of the bot to show in embeds (default: `FrogeBot`)

`EMBED_COLOUR` (int, optional) - The colour to use in embeds (rgb int) (default: `3394611`)

`MSG_VIBING` (str, optional) - What to append to embed descriptions when something succeeds

`MSG_UNVIBING` (str, optional) - What to append to embed descriptions when something fails

`SKIP_PERCENT` (int, optional) - (default: `50`),

`USE_MUSIC_ROLE` (bool, optional) - Whether to use a role for DJ permissions or just allow all users (default: `true`)

`MUSIC_ROLE_NAME` (str, optional) - The name of the role to be used for DJ permissions (default: `DJ`)

`TOKEN` (str) - The Discord bot token

## Executing commands
`msg` is the discord.js message object

`args` is the content of the message with the prefix and command removed from the start

To ensure frogeBot compatability a `cmd` object is passed, the only accessed key is `action` (it can be any one of `execute`, `skip`, `stop`, `disconnect`, `getQueue`, `nowPlaying`, `remove`, `shuffle`)

**Example**
```json
let cmd = {
  "action": "play"
}
frogeMusic(msg, args, cmd)
```

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