README

O hapless Github wanderer: this is but a work in progress.

Socketron

A state machine for routing sockets and stuff.

Motivation

I found when working with socket.io, that:

io.sockets.on('connection', function (socket) {
  socket.on('this', function (...) { ... });
  socket.on('that', function (...) { ... });
  socket.on('the other thing', function (...) { ... });
  // ...
});

Didn't scale very well. Organization became difficult, and much spaghetti code ensued.

Install

Install with npm:

npm install socketron

Use

Give it a socket.io instance and you're good to go!

Examples

var io = require('socket.io').listen(80);
var socketron = require('socketron');

socketron(io)
.state('lobby', {
  default: true, // this is where newly connected sockets go
  on: {

  }
})
.state('game', {
  
});

License

MIT

Usage no npm install needed!