Add movies to your couchpotato wanted list with just a simple slack message!
Mr. Potato has these features:
- Search for movies
- Add a movie to the wanted list by title ('download movie Frozen')
- Add a movie to the wanted list by IMDB id ('download movie tt2788732')
To start the bot simply run the start script inside the bin directory:
$ ./bin/start
Or npm install and npm start to launch the bot!
Pull the latest docker image from the Docker Hub and run it. The environment variables you need to pass are listed below.
There is a dockerfile if you want to build a docker image yourself. Run the following inside the project directory to build the image:
$ docker build -t couchbot ./
And launch it with the following command:
$ docker run -d --name couch-slackbot couchbot
Configuration of your bot can either be done using a config file or pass environment variables.
In the config folder there is a config.json.example file you can copy and rename to config.json. Once configured you are ready to start the bot.
If a config file is not ideal for your setup use environment variables. You can see in the table which env var to use for each config value.
| Description | ENV | Required |
|---|---|---|
| The slack token for this slackbot | CB_SLACK_KEY | ✓ |
| The name of the slackbot | CB_SLACK_NAME | ✓ |
| Couchpotato server hostname/ip | CB_HOST | ✓ |
| Couchpotato server port | CB_PORT | ✓ |
| Couchpotato base url | CB_BASE_URL | x |
| Couchpotato API key | CB_COUCH_KEY | ✓ |
Mr. potato is listening to the following commands / messages. It can depend per command where its available. Most of them work in a channel but some only per direct message.
Available in: Channel & Direct message.
To search for a movie send the following as a private message: search movie harry potter This will return a list with the movies it found. (Example gif on top of the README). The list returned also shows the IMDB id. This identifier can be send with the download movie command.
Available in: Channel & Direct message.
To add a movie to the wanted list its either possible to send download movie Bad Boys II it will add the first search result. When using a movie title with the download command try to be as specific as possible. Or send the IMDB identifier download movie tt0172156.
available in: Channel & Direct message.
Check if a movie is already on the wanted list or downloaded. Send the following message: do i have movie sausage party.
available in: Channel & Direct message.
You want some suggestions? Send do you have some suggestions? to the bot and you will get a nice list of some suggestions.
Available in: Direct message.
If you cannot access this readme for documentation and needs some help with some commands. Ask Mr. Potato for some help by sending help in a direct message. It will respond with the available commands.
Admin commands are send in a private message to the bot, but the bot will only react on it if a admin user has send the message.
By sending !version it will answer with the current version of the bot your talking to and the version of couchpotato which is configured.
You can update couchpotato by sending the !update command. Check with !version if there is a version available.
If you like Mr. Potato and it already saved you some time, consinder buying me a coffee to show your support! Thanks in advance!
