livecodingtv-bot

NO LONGER SUPPORTED

BEFORE YOU BEGIN!

This node app uses ES6 features.

Please ensure you are running node v4 or greater!

Changelog

https://github.com/owenconti/livecodingtv-bot/blob/master/changelog.md

Offical Plugins

The list of official plugins for the bot can be found on this repo: https://github.com/owenconti/livecodingtv-bot-plugins

Instructions for writing your own plugins can also be found on the repo above.

Setup

1) Clone the repo

2) Create a setup/custom/credentials.js file and setup/custom/settings.json file.

3) Find your XMPP password on LCTV page.

1. Open your live stream page ( https://www.livecoding.tv/USERNAME )
2. Open Dev Tools and switch to the Elements tab
3. Search the HTML content for "password".
4. The XMPP password will be a long string in an object containing 'jid' and 'password'.

4) Fill in the setup/custom/credentials.js file with the following format:

var username = 'LCTV_BOT_USERNAME';
var password = 'XMPP_BOT_PASSWORD'; // Found in step 3
var room = 'LCTV_USER_WHERE_BOT_WILL_BE';

module.exports = {
    room: username,
    username: username,
    jid: username + '@livecoding.tv',
    password: password,
    roomJid: room + '@chat.livecoding.tv'
};

5) Fill setup/custom/settings.json with the following JSON data:

{
    "plugins": {
        "noifications": true,
        "api-triggers": true
    }
}

6) Run npm install

7) Run node index.js

8) Some commands require extra API keys or specific variables. You can use the credentials.js file to store these variables.

module.exports = {
    // ...
    password: password,
    roomJid: room + '@chat.livecoding.tv',
    githubRepo: 'owenconti/livecodingtv-bot',
    youtubeApiKey: 'adfadsfsadfasdf'
};

9) The bot should be running and waiting for your commands!

Custom command credentials

Github repo command

• Github repo must be publicly available
• Attribute in credentials.js: githubRepo: 'owenconti/livecodingtv-bot'

Generating Help documentation

Help documentation is generated via Gist. Please ensure you have the following variables setup in your credentials file before starting the bot:

{
    "gistUsername" : "GIST_USERNAME",
    "gistAccessToken" : "GIST_ACCESS_TOKEN"
}

Custom settings

To enable plugins once you've downloaded them, edit the setup/custom/settings.json file:

{
    "plugins": {
        "noifications": true,
        "api-triggers": true
    }
}

Custom assets

The core includes one asset, the doge.png image file. If you want to include more assets, place the files in the setup/custom/assets directory. Using the Assets.load( filename.ext ) function, your custom asset will be loaded as base64 encoded string.

Plugin settings

Plugins can have their own settings. If a plugin chooses to have its own settings, the plugin folder will contain a settings.json file. You can edit any of the available settings inside that settings.json file.

Where can I find plugins? Take a look at https://github.com/owenconti/livecodingtv-bot-plugins

What you need for getting Plugins to work:

1) Download the plugin to the folder "plugins" 2) Add it to your settings.json in "setup/custom/" like that:

"plugins" : {
    "PLUGIN-NAME": true
}

3) Restart the bot

Writing plugins

Plugins can be composed of multiple commands. Commands can have four attributes:

{
    types: ['message'],
    regex: /^test$/,
    help: 'Returns a confirmation if the `test` message was received.'
    action: function( chat, stanza ) {
        chat.sendMessage( 'Test received!' );
    }
}

• types
  • Types must be an array, and can contain multiple types.
  • Valid types are: message presence startup websocket
  • message types are parsed when an incoming chat message is received
  • presence types are parsed when an incoming presence (user joined/left) is received
  • startup types are parsed and ran during start up
  • websocket types are parsed when an incoming websocket message is received
• regex
  • The regex attribute is used to determine the incoming stanza matches the command.
  • If a matched is determined, the action attribute of the command will be run.
  • regex must be a valid RegExp object (https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions)
• help
  • The help attribute is used generate documentation for the !help command.
  • If no help attribute is set, no documentation will be generated for the command.
• action
  • The action attribute is a function that is called if the regex for the command matches.
  • The logic for the command should reside inside the action attribute.
  • action is passed 2 parameters:
    1. chat - an instance of the Client object
    2. stanza - the parsed stanza containing:

       {
       user: User object,
       message: message string,
       type: type of stanza (message or presence)
       rateLimited: boolean to determine if the user is rateLimited
       }

  • The stanza parameter is not passed to startup commands.

See the examples directory for an example of creating a plugin.