# discord-yt-player

> Fully Automated Music Bot for the Discord Servers Edit

Latest version **1.1.1** (published 2017-11-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install discord-yt-player
pnpm add discord-yt-player
yarn add discord-yt-player
bun add discord-yt-player
```

## 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.1.1 |
| Published | 2017-11-25 |
| First published | 2017-11-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Mateusz Czernal |
| Maintainers | mateusz_pm |
| Keywords | discord, music-bot, bot, youtube-player, songrequest |

## Links

- npm: https://www.npmjs.com/package/discord-yt-player
- Repository: https://github.com/mtthev/discord-yt-player
- Homepage: https://github.com/mtthev/discord-yt-player#readme
- Issues: https://github.com/mtthev/discord-yt-player/issues
- npm.io page: https://npm.io/package/discord-yt-player

## Recent versions

- 1.1.1 (latest) — 2017-11-25
- 1.1.0 — 2017-11-05

## README

# discord-yt-player
Fully Automated Music Bot for the Discord Servers

![alt text](https://i.imgur.com/SSERZ4M.png)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine.

### Prerequisites

What things you need to install the software and how to install them

```
npm install discord.js
npm install ytdl-core
npm install request
```

### Installing

A step by step series of examples that tell you have to get a development env running

Download discord-yt-player.js and declare it

```
const DM = require('discord-yt-player')
```

### Setup & Options

First of all you need to create a Discord client object e.g.

```
const client = new Discord.Client({
    autoReconnect: true, 
    max_message_cache: 0
});
```
Next up create a bot object based on the client
```
const bot = new DM.DiscordMusic(client);
```

Simple settings and setup
```
bot.setup({
    token_key: '', // Individual App Bot User Token
    server_id: '', // Server ID
    channels: {
        voice_channel_id: '', // Voice Channel ID
        text_channel_id: '' // Text Channel ID
    },
    yt_api_key: '' // Youtube Api Key
});
```
or you can use much more simpler version dedicated for command line
```
bot.setup({
    token_key: process.argv[2], // Individual App Bot User Token
    server_id: process.argv[3], // Server ID
    channels: {
        voice_channel_id: process.argv[4], // Voice Channel ID
        text_channel_id: process.argv[5] // Text Channel ID
    },
    yt_api_key: process.argv[6] // Youtube Api Key
});
```
and simply run it
```
node YOUR_APP.js <TOKEN> <SERVER_ID> <VOICE_CHANNEL_ID> <TEXT_CHANNEL_ID> <YOUTUBE_API_KEY>
```


__Available commands list: (default names)__  
* `songrequest [youtube-url]`: Adds new YouTube song to the queue
* `skip`: Skips a song //TO-DO List
* `queue`: Displays all songs in queue //TO-DO List
* `stop`: Stops music playback. //TO-DO List
* `start`: Resumes music playback. //TO-DO List
* `clear`: Clears queue. //TO-DO List

![alt text](https://i.imgur.com/Xr0tR7p.png)

## Running the tests
Force add songs to the queue
```
setTimeout(function() {

  if(bot.isConnected) {
    bot.listing(
    "YOUTUBE_VIDE_URL_1", 
    "YOUTUBE_VIDE_URL_2",
    "YOUTUBE_VIDE_URL_3",
    "YOUTUBE_VIDE_URL_4");
  } else {
    console.log("not connected");
  }
  
}, 3000);
```



## Built With
* [node-ytdl-core](https://github.com/fent/node-ytdl-core/) - Youtube downloader in javascript.
* [discord.js](https://github.com/fent/node-ytdl-core/) - Youtube downloader in javascript.


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* This is a very simple project of script in node.js, made for purposes of trying new things in ES6.

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