Git Product home page Git Product logo

mmm-ff-genius-lyrics's Introduction

Magic Mirror² displaying lyrics for the currently playing track

MMM-FF-Genius-Lyrics

ISC License

A module for MagicMirror² that displays lyrics from the genius api (API key required).

This module complements the MMM-Spotify module and listens for it's song info notifications to automatically fetch the lyrics for the currently playing song.

Installation

Just navigate to the modules directory of your MagicMirror² installation and clone this repository.

git clone https://github.com/shin10/ MMM-FF-Genius-Lyrics.git
cd MMM-FF-Genius-Lyrics && npm i

Configuration

Example:

{
  module: "MMM-FF-Genius-Lyrics",
  position: "fullscreen_below",
  header: "Genius Lyrics",
  classes: "custom-genius-lyrics",
  config: {
    apiKey: "${GENIUS_LYRICS_CLIENT_ACCESS_TOKEN}", // your CLIENT ACCESS TOKEN from https://genius.com/api-clients
    lyricsClasses: ["medium" , "bold", "italic"]
  }
},

Configuration Options

Option Type Default Description
apiKey string null The client access token of your app.
lyricsClasses string[] ["medium", "thin"] A list of classes to format the lyrics.

apiKey

To access the genius lyrics database you'll need to create an account at Genius. Then go to https://genius.com/api-clients/new and create a new api client. Fill in a App Name and App website URL for example http://localhost:8080; hit save. Then click on the link labeled Generate Access Token to request the apiKey for your config.

mmm-ff-genius-lyrics's People

Contributors

shin10 avatar

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.