Node-Telegram-Bot: A JavaScript repository from piguet

#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
Using the Bot
Plugins
- Writing custom plugins
TODO
Contributing
Constributors
Need help?
License

##Running the Bot

Clone/Download/Fork the repository
Install redis (and check if it is working)
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

##Using the Bot

Send a message to the bot or add it to a group chat and you are ready to use it!

Use /list to see a list of the enabled plugins or /help <plugin-name> to get an explanation for each enabled plugin.

##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 for each plugin.

###Writing custom plugins

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

Basic Class Skeleton

var pluginName = function(){
    
    this.help = {
        shortDescription: "Set a simple and short description for your plugin here.",
        fullHelp: "Add examples, an in-depth explanation here."
        //both these fields are required
    };

    this.on('text', function (msg, reply) {
        //this will be executed whenever your bot get a text message
        //you can listen to many events, just take a look at the example plugins.

        /*
            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

Tests!
Improve utilities module (downloading files , common database, generate markdown links)
More Plugins
Documentation
Website
Promotion

##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 of plugins
- Added redis support
- Improved the plugin system
- Messed up the code
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. 👍

##License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

piguet/Node-Telegram-Bot