libquassel

Javascript library to connect and interact with Quassel IRC server.

Install

npm install --production libquassel

Use in browser

You just need to import client/libquassel.js or client/libquassel.min.js in your HTML page.

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

2.0 breaking changes

Version 2.0 introduces BufferView object, and this break some existing behavior.

• New bufferview module
• IRCBuffer changes
  • unused order attribute removed
  • setTemporarilyRemoved, setPermanentlyRemoved and isHidden are no longer part of this class. Those are moved to BufferView class.
• events
  • buffer.unhide replaced by bufferview.bufferunhide
  • buffer.hidden replaced by bufferview.bufferhidden
  • buffer.order deleted. New bufferview.orderchanged and bufferview.init events

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
    //   securecore (default true): if false, do not use SSL to connect to the core
    //   highlightmode (default to current nick only): see documentation
    {backloglimit: 10}, 
    function(next) {
        next("user", "password");
    }
);

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

// ...

quassel.connect();

Documentation

2.1.2

Examples

See test/manual.js for details.

License

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