#Node-Telegram-Bot

A Telegram Bot which supports user-made plugins

Written in Node.js

Based on node-telegram-bot-api

###Table of Contents

• Running the Bot
• Plugins
  • Writing custom plugins
• TODO
• Contributing
• Constributors
• Need help?

##Running the Bot

• Clone/Download/Fork the repository
• npm install
• Create a Bot Account
  • Get the associated token (https://core.telegram.org/bots/#botfather)
• Set the required Environment Variables (two methods)
  1. Via setup.sh
     • Edit setup.sh
       • Set TELEGRAM_TOKEN with the auth token of your bot
       • Set the other API Keys if you want to enable the relative plugins.
     • Run source setup.sh
  2. Set them manually
     • Check setup.sh to see the required Environment Variables.
• Edit config.js
  • Edit activePlugins if you want to edit the active plugins. It is an array of the filenames of the active plugins.
    • You can find the plugins in the plugins folder.
• Run the bot
  • node bot.js
  • Stop it at any time with CTRL+C

##Plugins

Plugins can be easly written with a basic understanding of JavaScript.

Check the plugins folder to see the available plugins and check each file to see a basic explanation.

###Writing custom plugins

• Take a look at the provided plugins in the plugins folder
• Create a .js file in the plugins folder

Basic Skeleton

var pluginName = function(){

    this.init = function(){
        //this will be executed when the bot starts
    };

    this.doStop = function(){
        //this will be executed when the bot shuts down
    };  


    this.doMessage = function (msg, reply) {
        //this will be executed whenever your bot get a message

        /*
            1. Check if the msg.text matches the trigger for your plugin
            2. Do stuff you need
            3. Produce reply 
                replyText = {type:"text", text:"Message you want to post"}
                replyAudio = {type:"audio", audio:"path/to/audio.mp3"}
                replyPhoto = {type:"photo", photo:"path/to/photo.png"}
                replyStatus = {type:"status", status:"typing"}
            4. Post the reply
                reply(replyText); //for example

        */
    };

};

module.exports = pluginName;

##TODO

• Common utilities module (downloading file, downloading web page, ...)
• Improve the code
• More plugins
• Plugins fixes
  • TTS
    • Fix random exceptions that sometimes happens
  • SET
    • Make triggers local to a chat (they are now shared between all chats)

##Contributing Did you made a plugin you want to share with everyone? Did you improve the code in any way?

Submit a pull request!

This project will only grow if YOU help!

##Constributors In Alphabetical Order

• Cristian Baldi

  • Crated the project
  • Developed a bunch plugins

• Phill Farrugia

  • Improved & documented the code
  • Added Heroku Integration
  • Created Unit Tests
  • Added automatic testing via Travis CI

##Need help? Send me a mail or create an issue, I will answer ASAP. 👍