From fb7d6dea983bdc1f72708f575a3425a33a6a741e Mon Sep 17 00:00:00 2001 From: Matthieu Grieger Date: Fri, 2 Oct 2015 23:10:38 -0700 Subject: [PATCH] Update README with note about SoundCloud, other small changes --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bcab76a..0bdc979 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ MumbleDJ * [Commands](#commands) * [Installation](#installation) * [YouTube API Keys](#youtube-api-keys) - * [Soundcloud API Keys](#soundcloud-api-keys) + * [SoundCloud API Keys](#soundcloud-api-keys) * [Setup Guide](#setup-guide) * [Update Guide](#update-guide) * [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. ## FEATURES -* Plays audio from YouTube and Soundcloud! +* Plays audio from YouTube and SoundCloud! * Supports playlists and individual videos/tracks. * 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`. @@ -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! ###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) -**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=""`. Replace \ 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 **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.