Giter VIP home page Giter VIP logo

maestro's Introduction

Maestro

Build Status Code Climate

A Slack-Powered music bot for Spotify.

Install

๐Ÿ™ˆ You Must Use Node 0.10.x ๐Ÿ™ˆ
๐Ÿ™ˆ Only Works on OSX ๐Ÿ™ˆ

Configuring Spotify

  1. Create a Spotify Premium Account.
  2. brew install libspotify install libspotify
  3. Download a Spotify App Developers Key.

Configuring the Slack integration

  1. Create a Slack Outgoing Webhook.
  2. In URL(s) put <address_to_your_bot>/handle we use ngrok for this
  3. In Trigger Word(s) put play, pause, stop, skip, shuffle, vol, list, status, help, mute, unmute, banned, voteban, queue

Starting the Bot

  1. Download the latest release.
  2. Unzip and cd into the maestro directory
  3. cp config.example.json config.json
  4. npm install
  5. Put your Spotify login username and password into the config.json file.
  6. Put your spotify_appkey.key file in Maestro's root directory.
  7. Copy the token from the webhook into the config.json file.
  8. npm start.
  9. Plug your OSX machine into some speakers.
  10. Jam ๐ŸŽง

Running Test

๐Ÿ™ˆ You Must Use Node 0.10.x ๐Ÿ™ˆ

  1. git clone https://github.com/smashingboxes/maestro.git.
  2. cd maestro
  3. Follow the install steps to create a Spotify token and configure the app.
  4. npm install
  5. npm test

Commands

Commands

play [Spotify URI] - Starts/resumes playback
play [Spotify URI] - Immediately switches to the linked track.
pause - Pauses playback at the current time.
stop - Stops playback and resets to the beginning of the current track.
skip - Skips (or shuffles) to the next track in the playlist.
shuffle - Toggles shuffle on or off.
vol [up|down] Turns the volume either up/down one notch.
vol [0..10] Adjust volume directory to a step between 0 and 10.
mute - Same as vol 0.
unmute - Same as vol 0.
status - Shows the currently playing song, playlist and whether you're shuffling or not.
voteban - Cast a vote to have the current track banned
banned - See tracks that are currently banned
help - Shows a list of commands with a short explanation.

Queue

queue [Spotify URI] - Add a song to the queue
queue - See the tracks currently in the queue

Playlists

list add <name> <Spotify URI> - Adds a list that can later be accessed under .
list remove <name> - Removes the specified list.
list rename <old name> <new name> - Renames the specified list.
list <name> - Selects the specified list and starts playback.

(inspired by Crispify)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.