An open API service indexing awesome lists of open source software.

https://github.com/pierregode/mmm-next-episode

Magic mirror module for TV shows and movies with next-episode. Track the TV show and movies you watch.
https://github.com/pierregode/mmm-next-episode

Last synced: about 1 year ago
JSON representation

Magic mirror module for TV shows and movies with next-episode. Track the TV show and movies you watch.

Awesome Lists containing this project

README

          

# MMM-next-episode

[MagicMirror²](https://magicmirror.builders/) module for tracking TV shows and movies provided from [next-episode](https://next-episode.net/).

Track the TV shows and movies you watch.

Update your shows from the mobile apps [![App Store](https://img.shields.io/badge/App_Store-0D96F6?style=for-the-badge&logo=app-store&logoColor=white)](https://apps.apple.com/se/app/next-episode-track-tv-shows/id347009526)
and [![Play Store](https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=net.nextepisode.android)

![GitHub Workflow Status](https://github.com/PierreGode/MMM-next-episode/actions/workflows/review.yml/badge.svg) ![Open Issues](https://img.shields.io/github/issues/PierreGode/MMM-next-episode) ![Open PRs](https://img.shields.io/github/issues-pr/PierreGode/MMM-next-episode) ![Tech Stack](https://img.shields.io/badge/stack-Node.js%20%7C%20JavaScript%20%7C%20Express-brightgreen) ![Known Vulnerabilities](https://snyk.io/test/github/PierreGode/MMM-next-episode/badge.svg) ![Activity](https://img.shields.io/github/commit-activity/y/PierreGode/MMM-next-episode)

## Screenshots

![image](img/episodeName.png) ![image](https://github.com/PierreGode/MMM-next-episode/assets/8579922/6181fc01-5953-4ff4-8084-10826dcb4bd8)

## How to install

```bash
cd MagicMirror/modules
git clone https://github.com/PierreGode/MMM-next-episode
cd MMM-next-episode
npm install
```

## Configuration

In `~/MagicMirror/config/config.js`:

```js
{
module: "MMM-next-episode",
position: "bottom_right",
header: "Next-Episode",
config: {
id: '',
hash_key: '',
username: '',
password '',
displaySeasonAndEpisode: false,
displayShowingOn: false,
displayEpisodeName: false,
maxdays: 7,
ShowThumbnail: true,
ThumbnailSize: 'small',
updateInterval: 180
}
},
```

### How to get your id and hash_key

Set username: '', and password '', in the config.js

When starting the module the first time without id and hash_key in the config, a QR code will be displayed on the mirror. Like this example:

![example QR code](img/screenshotqrcode.png)

Scan the QR code from your mirror and a page will show your id and hash They might come together as a one line but the first 9 digits are the id and the rest is the hash.

**Note: You only need to set username and password for Next-Episode in the config.js to get the id and hash, after you added the ID and Hash to the config.js the username and password can be removed from config.js**.

**Note:** Using special characters such as '+', '"', '^', '%', '$', '#', in your password can cause the link to break. You may consider temporarily changing your password for this purpose.

After adding values `id` and `hash_key` in the config above, restart the MagicMirror.

### Config description

| name | values | info |
| --- | --- | --- |
| `id` | `YOUR ID` | Insert your ID. |
| `hash_key` | `YOUR HASHKEY` | Insert your hashkey. |
| `username` | `YOUR next episode username` | Insert your username temporary. |
| `password` | `YOUR next episode password` | Insert your password temporary. |
| `displaySeasonAndEpisode` | `true` or `false` | Show or hide season and episode. |
| `displayShowingOn` | `true` or `false` | Show or hide channel/service. |
| `displayEpisodeName` | `true` or `false` | Show or hide episode name. |
| `maxdays` | example: `300` | Default `7`. How many days in the future to show shows from. minimum `0` but will always show Today and the next day. |
|`ShowThumbnail`| `true` or `false` | Show thumbnail of show or movie. |
|`ThumbnailSize`| `small`, `medium` or `large` | Change size of thumbnail. |
|`updateInterval`| example: `180` | 180 is default to update every 3 hours and is the lowest time allowed, set theUpdate interval in minutes. |

## Changes
- Added new easy QR hash generation from Sc4nd4l
- PR from ConfuciusZA to Show or hide channel/service
- Fixed show name display
- Added ability to show Channel/Service the show is airing on
- Added ability to show/hide episode name

## Development

Developed and maintained by [Pierre Gode](https://github.com/PierreGode)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J2EARPK)

## Special Thanks

Big thanks to SANTAH from [next-episode](https://next-episode.net/) for building API support and providing information for this module.

The API is free, but feel free to support [next-episode](https://next-episode.net/).