implements the client-side of the rfb protocol that vnc uses
JavaScript
Clone or download
Pull request Compare This branch is 2 commits ahead of substack:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.npmignore
LICENSE
README.md
index.js
package.json

README.md

RFB client library for node.js

see: http://www.realvnc.com/docs/rfbproto.pdf

Usage Example

var rfb = require('rfb')({
  host: 'localhost'
  , port: 5900
  , shared: true
  , securityType: 'vnc' // or 'none'
  , password: 'test'
});
rfb.on('error', function(e){
  throw e;
});
rfb.on('raw', function(rect){
  rect.x
  rect.y
  rect.width
  rect.height
  rect.encodingType
  rect.encodingType
  rect.depth
  rect.fb // contains the actual frame buffer
});

// other methods
rfb.sendPointer(x, y, mask);
rfb.sendKeyUp(key);
rfb.sendKeyDown(key);
rfb.requestUpdate({ ... });
rfb.pointer(x, y, mask);