vjousse/martirc

You're Back To the IRC! MartIrc is a NodeJS wrapper to connect to IRC using a browser supporting Websockets

Overview

NodeJS wrapper to IRC using Websockets. It allows to connect to IRC using a browser supporting websockets.

The elevator pitch

How you should be able to explain what is MartIRC to your boss, in 30 seconds.

For end users wanting to connect to IRC Who need an easy way to chat MartIRC is a web application that works out of the box in your browser unlike JAVA applets that requires the JAVA plugin or basic IRC clients that require installation and configuration our software will allow users to connect to IRC through their browser in one click. No third-party plugin needed, fully web based interface and a chat relying on a well known and opensource chat network: IRC.

Requirements

Obviously you should first install node.JS. Really, this will help. Then you will need to install npm, the node package manager.

Both may be available from your OS package manager.

Installation

git clone git://github.com/knplabs/MartIrc.git
cd MartIrc
git submodule update --init

npm install coloured
npm install log

Running the server

sudo node server/server.js

Connecting to the server with you browser

Open client/client.html in your browser. The application will try by default to connect to the node server on localhost:3000.

If you want to use cookies under chromium (to record opening channels for instance), you have to launch chromium once with --enable-file-cookies and you have to enable cookies in settings as well.

Using MartIrc

In the server area, you can write pure irc command and there is a set of shortcut, the same way than vi, for frequent commands.

:c - To connect to IRC

:s - To jump to server

:j #ubuntu or :j mike - To join a channel or to talk to a user

:k or :k #ubuntu - To delete the current channel or to delete a channel using its name

:n john - To change nickname

Credits

MartIrc has been inspired by the work of Abronte and Gf3, thanks to them!