A Telegram bot for download and subscribe to tv show subtitles.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
download
js
scripts
.gitignore
LICENSE
README.md
package-lock.json
package.json

README.md

Logo

A Telegram bot for download and subscribe to tv show subtitles.

Subtitles Alert Bot is a Telegram Bot that let you download and subscribe to subtitles of your favourite tv shows. You can download subtitles for a specific episode or a set of subtitles, and manage your subscriptions. A subscription is referred to a specific tv show for one or more languages: once you have subscribed you will get your subtitles on your phone (also a direct link for others subtitles for all episode versions) without doing anything.

For its purpose we recommend to use the bot with Telegram Desktop Client or Telegram Web.

More about Telegram Bots: https://core.telegram.org/bots

Features

With Subtitles Alert Bot you can:

📥 Download subtitles (for a specific episode or a set of episode). You will get the ".srt" file and a link to other subtitles for every episode release available.

🔈 Subscribe to subtitles. You can subscribe to a specific tv show for one or more subtitles' languages. Just relax and as soon as your subtitles are out you will receive them.

📆 Show your active subscriptions.

🚫 Unsubscribe from tv shows.

Other minor functionalities such as: 🇮🇹 changing bot language (Italian and English available for now), 💰 Donate and 🆘 show the Help message.

Screenshots

Logo

Technology

Based on Node.js our bot uses several open-source libraries listed here. Our source of subtitles is www.addic7ed.com and http://www.tvmaze.com/api is the endpoint for retrieve updated informations about tv shows.

Thanks to:

If you want to run a version of this bot a nice and suggested cheap server is a RaspberryPi. We use it and it works like charm. Feel free to ask us for help on setting up.

How can I contribute?

In the Issue section of this repository we constantly add bugs to fix or new features to develop. You can fork this repository and start develop as a contributor.

Setting up

  • To run a local version of Subtitles Alert Bot you have first to obtain a token from Telegram
  • Set the telegramBotToken variable in js/main.js to the new token
  • We used MongoDBas database. You first have to install it and run it
  • Configure your MongoDB local connection in js/conf.js (on dbName set your database name - subtitlesAlertBot as default).
  • Run the bot instance: sudo node main.js
  • You're free to use any Telegram client you like and search for your bot instance name. Start the conversation sending /start to the bot chat.

Database

We used MongoDB. In js/db/mongo.js you can find our model. For full compatibility with existing code, please use the same data model.

Issue tracker and new features to develop

https://github.com/nicolocarpignoli/subtitles-alert-bot/issues

Public roadmap

Public roadmap for Subtitles Alert Bot can be found here. It's always up-to-date with last release.

Feel free to donate

Our project is totally free and open-source. If you want to donate we will be very grateful and it will contribute to our project to mantain an always running version of Subtitles Alert Bot (you can find the official and first version of the bot as @SubtitlesAlertBot on Telegram)

Logo

About the authors

Logo is courtesy of Mariusz Nawrocki

License

This project is released under MIT license as you can check in LICENSE.md file.