Skip to content

physk/MediaButler

Repository files navigation

MediaButler

Discord Wiki Travis

Discord bot for use with PleX and several other apps that work with it. Still early dev, but active and welcomes any/all help

Prerequisites

  • NodeJS - The server framework
  • npm - Package manager

Features

  • Pull info for tv shows, films, anime, manga, books and music artists.
  • Pull user stats from Tautulli.
  • Pull user watched history from Tautulli.
  • Pull Plex now playing info from Tautulli.
  • Pull tonight's shows info from Sonarr.
  • Add tv shows to Sonarr.
  • Add movies to Radarr.
  • Kill Plex streams.
  • Have MediaButler remind you what and when.
  • Show bot uptime.

Installation

Complete configuration tutorial

git clone https://github.com/MediaButler/MediaButler.git
cd MediaButler
cp settings.example.json settings.json
nano settings.json
npm install

Docker Installation

The TOKEN utilized by the container is from the process of setting up the MediaButler app with your Discord Server. Instructions for doing this can be found HERE.

Usage

docker create \
  --name=mediabutler \
  --restart=on-failure \
  -e TOKEN=<discord token> \
  -e PREFIX=<command prefix> \
  -e CONFIG_PATH=<app data path> \
  mediabutler/mediabutler

Parameters

  • --name - The name of the container - Call it whatever you want.
  • --restart=on-failure Container restart mode - Docker attempts to restarts the container if the container returns a non-zero exit code. More info HERE on container restart policies.
  • -e TOKEN - Your Discord token - This is needed for the bot to work with your Discord Server.
  • -e PREFIX The command prefix character - This is what you want to prefix the commands for the bot, IE: !help, ?help, +help, -help, >help, etc.
  • -e CONFIG_PATH - App data path for persistently storing the settings, IE: /config.

Info

  • To monitor the logs of the container in realtime docker logs -f mediabutler.

Feature Requests

Please use our FeatHub to request and vote on features to make it's way to the bot here

Feature Requests

Support

The best place to get support is on our Discord channel, which you can get to by clicking Here

Authors

Trusted contributors

License

This is free software under the GPL v2 open source license. Feel free to do with it what you wish, but any modification must be open sourced.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published