containers/mumbledj
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README with note about SoundCloud, other small changes

Browse source
This commit is contained in:
Matthieu Grieger 2015-10-02 23:10:38 -07:00
parent d45d576c72
commit fb7d6dea98
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -7,7 +7,7 @@ MumbleDJ
* [Commands](#commands) * [Commands](#commands)
* [Installation](#installation) * [Installation](#installation)
* [YouTube API Keys](#youtube-api-keys) * [YouTube API Keys](#youtube-api-keys)
* [Soundcloud API Keys](#soundcloud-api-keys) * [SoundCloud API Keys](#soundcloud-api-keys)
* [Setup Guide](#setup-guide) * [Setup Guide](#setup-guide)
* [Update Guide](#update-guide) * [Update Guide](#update-guide)
* [Troubleshooting](#troubleshooting) * [Troubleshooting](#troubleshooting)
@ -31,7 +31,7 @@ All commandline parameters are optional. Below are descriptions of all the avail
* `-accesstokens`: List of access tokens for the bot separated by spaces. Defaults to no access tokens. * `-accesstokens`: List of access tokens for the bot separated by spaces. Defaults to no access tokens.
## FEATURES ## FEATURES
* Plays audio from YouTube and Soundcloud! * Plays audio from YouTube and SoundCloud!
* Supports playlists and individual videos/tracks. * Supports playlists and individual videos/tracks.
* Displays thumbnail, title, duration, submitter, and playlist title (if exists) when a new song is played. * Displays thumbnail, title, duration, submitter, and playlist title (if exists) when a new song is played.
* Incredible customization options. Nearly everything is able to be tweaked in `~/.mumbledj/mumbledj.gcfg`. * Incredible customization options. Nearly everything is able to be tweaked in `~/.mumbledj/mumbledj.gcfg`.
@ -89,17 +89,19 @@ Effective April 20th, 2015, all requests to YouTube's API must use v3 of their A
**8)** Close your current terminal window and open another one up. You should be able to use Youtube on MumbleDJ now! **8)** Close your current terminal window and open another one up. You should be able to use Youtube on MumbleDJ now!
###SOUNDCLOUD API KEYS ###SOUNDCLOUD API KEYS
A soundcloud API key is required for soundcloud integration. If no soundcloud api key is found, then the service will be disabled (youtube links will still work however). A SoundCloud API key is required for SoundCloud integration. If no SoundCloud API key is found, then the service will be disabled (YouTube links will still work however).
**1)** Login/signup for a soundcloud account on [https://soundcloud.com](https://soundcloud.com) **1)** Login/signup for a SoundCloud account on [https://soundcloud.com](https://soundcloud.com)
**2)** Now to get the API key create a new app here: [http://soundcloud.com/you/apps/new](http://soundcloud.com/you/apps/new) **2)** Now to get the API key create a new app here: [http://soundcloud.com/you/apps/new](http://soundcloud.com/you/apps/new)
**3)** Copy the Client ID (not the Client Secret) **3)** Copy the Client ID (not the Client Secret).
**4)** Open up `~/.bashrc` with your favorite text editor (or `~/.zshrc` if you use `zsh`). Add the following line to the bottom: `export SOUNDCLOUD_API_KEY="<your_key_here>"`. Replace \<your_key_here\> with your API key. **4)** Open up `~/.bashrc` with your favorite text editor (or `~/.zshrc` if you use `zsh`). Add the following line to the bottom: `export SOUNDCLOUD_API_KEY="<your_key_here>"`. Replace \<your_key_here\> with your API key.
**5)** Close your current terminal window and open another one up. You should be able to use soundcloud on MumbleDJ now! **5)** Close your current terminal window and open another one up. You should be able to use SoundCloud on MumbleDJ now!
**NOTE:** If you get errors when trying to play SoundCloud audio, make sure to update `youtube-dl` with `youtube-dl -U`!
###SETUP GUIDE ###SETUP GUIDE
**1)** Install and correctly configure [`Go`](https://golang.org/) (1.4 or higher). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly. **1)** Install and correctly configure [`Go`](https://golang.org/) (1.4 or higher). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly.