MMM-PlexNowPlaying

This is a module for the MagicMirror² smart mirror project.

This module displays the list of playback sessions for a Plex Media Server.

Example

Dependencies

1. A Plex Media Server installation for the source of the data

Installation

To install the module, use your terminal to:

1. Navigate to your MagicMirror's modules folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules
2. Copy the module to your computer by executing the following command:
   git clone https://github.com/glitch452/MMM-PlexNowPlaying.git

Using the module

MagicMirror² Configuration

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        ...
        {
            module: "MMM-PlexNowPlaying",
            position: "top_left",
            header: "Plex: Now Playing",
            config: {
                serverProtocol: "http",
                serverAddress: "x.x.x.x",
                serverPort: 32400,
                xPlexToken: "xxxxxxxxxxxxxxxxxxxx"
                // See below for more Configuration Options
            }
        },
        ...
    ]
}

Configuration Options

Updates

To update the module to the latest version, use your terminal to:

1. Navigate to your MMM-PlexNowPlaying folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-PlexNowPlaying
2. Update the module by executing the following command:
   git pull

If you have changed the module on your own, the update will fail.
To force an update (WARNING! your changes will be lost), reset the module and then update with the following commands:

git reset --hard
git pull

Manually Choose a Version

To use an older version of this module, use your terminal to:

1. Navigate to your MMM-PlexNowPlaying folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-PlexNowPlaying
2. Fetch all the available tags
   git fetch
3. Show all the available tags
   git tag
4. Checkout one of the available tags
   git checkout {tag_name}
   Example: git checkout v1.0.0

To switch back to the latest version, use your terminal to:

1. Navigate to your MMM-PlexNowPlaying folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-PlexNowPlaying
2. Checkout the master branch
   git checkout master

License

The MIT License (MIT)

Copyright © 2019 David Dearden

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.