Code Monkey home page Code Monkey logo

paib2's Introduction

Paib 2.0

This is a complete rewrite of paib.

This is solely the bot's core, hoping to separate core and plugins better.

Changes from 1.0

  • Completely rewritten in node
  • Hopefully better API
  • Built-in logger
  • Plugins can be distributed as NPM packages

Usage

$ git clone https://github.com/pta2002/paib2

$ npm install # Or yarn, if you use it

$ node paib.js

This will run a bot named 'paib2' and connect to the #bottest channel on afternet, with a sample plugin.

Configuration

Configuration is done by editing the config.js file.

This file is just a JS module that exports a configuration object.

module.exports = {
    nick: 'yournick',
    server: {
        address: 'irc.example.com',
        port: 6697,
        secure: true
    },
    username: 'mybot',
    realname: 'An IRC bot',
    debug: false,
    channels: ['#chan1', '#chan2'],
    commandPrefix: '~',
    plugins: [
        // Require plugins as needed...
        require('plugin1'),
        require('plugin2')
    ],
    // node-irc options https://node-irc.readthedocs.io/en/latest/API.html#events
    other: {
        selfSigned: true
    }
}

Making a plugin

There's currently an example plugin in plugins/example.js

LICENSE

Copyright (c) 2017 Pedro Alves

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.

paib2's People

Contributors

pta2002 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.