Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.18 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.18 KB

libquassel

NodeJS lib to connect and interact with Quassel IRC server.

Install

npm install --production libquassel

Development

npm install libquassel

In order to create a browser compatible file, run the following command

# for nodejs 0.12 to 4.x
grunt lts
# for nodejs >=5
grunt stable

Getting Started

var Quassel = require('../lib/libquassel.js');
var quassel = new Quassel(
        "quassel.domain.tld", // Quasselcore address
        4242, // Quasselcore port
        // Options:
        //   nobacklogs (default false): if true, do not handle backlogs
        //   backloglimit: number of backlogs to request per buffer at connection
        //   unsecurecore (default false): if true, do not use SSL to connect to the core
        {backloglimit: 10}, 
        function(next) {
    next("user", "password");
});

quassel.on('network.init', function(networkId) {
    network = quassel.getNetworks().get(networkId);
    // ...
});

// ...

quassel.connect();

All events are detailed in test/manual.js for now.

Examples

See test/manual.js for details.

License

Copyright (c) 2014-2015 Joël Charles
Licensed under the MIT license.