https://github.com/Kiina/MMM-trakt

A MagicMirror Module to show your upcoming tv shows from trakt.tv
https://github.com/Kiina/MMM-trakt

Last synced: about 2 months ago
JSON representation

A MagicMirror Module to show your upcoming tv shows from trakt.tv

• Host: GitHub
• URL: https://github.com/Kiina/MMM-trakt
• Owner: Kiina
• License: mit
• Created: 2017-08-16T15:29:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T02:25:14.000Z (over 1 year ago)
• Last Synced: 2024-06-29T09:30:32.046Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 88.9 KB
• Stars: 13
• Watchers: 4
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-mmm - **MMM-Trakt**

README

        
# [Trakt.tv]-Module for the [MagicMirror](https://github.com/MichMich/MagicMirror/)

_If you'd like to contribute, pull requests are welcome!_

![Screenshot](screenshot.png)

### Todo

- [x] CSS

- [ ] Pictures for the shows

- [x] More configuration options

### Creating a [Trakt.tv] API [application]

To get your API keys you need to first create an [application]. Give it a name, and enter `http://localhost/` in the callback field _(it's a required field but not used for our purpose)_.

## Installation

Clone the repository into your MagicMirror's modules folder, and install dependencies:

```sh

  cd ~/MagicMirror/modules

  git clone https://github.com/Kiina/MMM-trakt

  cd MMM-trakt

  npm install

```

## Configuration

To run the module, you need to add the following data to your ` ~/MagicMirror/config/config.js` file:

```js

{

  module: 'MMM-trakt',

  position: 'top_center', // you may choose any location

  header: 'TV-Shows', // optional

  config: {

    client_id: 'YOUR_API_CLIENT_ID',

    client_secret: 'YOUR_API_CLIENT_SECRET',

    days: 1, // optional, default: 1. 1 = today's episodes, 2 = today's and tomorrow's, 3 = etc...

    styling : {

        moduleSize: "small", // optional, possible value: (xsmall, small, medium, large, xlarge), default: small

        daysUntil: false, // optional, shows 'today' and 'tomorrow' insted of date, default: false

        daysUntilFormat: "hh:mm", // optional, default: "hh:mm", time format after 'today'. Leave empty ("") to hide, possible values: https://momentjs.com/docs/#/displaying/format/

        dateFormat: "D.M hh:mm", // optional, default: "D.M hh:mm", possible values: https://momentjs.com/docs/#/displaying/format/

        showEpisodeTitle: true, // optional, default: true

    },

    debug: false // optional, default: false

  }

}

```

[Trakt.tv]:(https://trakt.tv/)

[application]: (https://trakt.tv/oauth/applications/new)