Skip to content

Commit

Permalink
Release 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
eritislami committed Jun 23, 2020
1 parent cada2b8 commit 445398b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
## Requirements

1. Discord Bot Token **[Guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)**
2. YouTube Data API v3 Key **[Guide](https://developers.google.com/youtube/v3/getting-started)**
2. YouTube Data API v3 Key **[Guide](https://developers.google.com/youtube/v3/getting-started)**
2.1 **(Optional)** Soundcloud Client ID **[Guide](https://github.com/zackradisic/node-soundcloud-downloader#client-id)**
3. Node.js v12.0.0 or newer

## 🚀 Getting Started
Expand All @@ -25,6 +26,8 @@ If you are planning to use ***Glitch.com*** please read [#27](https://github.com

Copy or Rename `config.json.example` to `config.json` and fill out the values:

⚠️ **Note: Never commit or share your token or api keys publicly** ⚠️

```json
{
"TOKEN": "",
Expand All @@ -42,15 +45,23 @@ Copy or Rename `config.json.example` to `config.json` and fill out the values:
* 🎶 Play music from YouTube via url

`/play https://www.youtube.com/watch?v=GLvohMXgcBo`

* 🔎 Play music from YouTube via search query

`/play under the bridge red hot chili peppers`

* 🎶 Play music from Soundcloud via url **(Requires Soundcloud Client Id)**

`/play https://soundcloud.com/blackhorsebrigade/pearl-jam-alive`

* 🔎 Search and select music to play

`/search Pearl Jam`

* 📃 Play youtube playlists via url

`/playlist https://www.youtube.com/watch?v=YlUKcNNmywk&list=PL5RNCwK3GIO13SR_o57bGJCEmqFAwq82c`

* 🔎 Play youtube playlists via search query

`/playlist linkin park meteora`
Expand Down
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,10 @@
"simple-youtube-api": "^5.1.1",
"soundcloud-downloader": "0.0.9",
"ytdl-core": "^3.1.0",
"ytdl-core-discord": "amishshah/ytdl-core-discord"
"ytdl-core-discord": "amishshah/ytdl-core-discord",
"ffmpeg-static": "^4.2.3"
},
"scripts": {
"start": "node index.js"
},
"optionalDependencies": {
"ffmpeg-static": "^4.2.3"
}
}

0 comments on commit 445398b

Please sign in to comment.