x11

A pure node.js JavaScript client implementing X Window (X11) protocol and extensions.

About

![Gitter](https://badges.gitter.im/Join Chat.svg) X11 protocol client for node.js

Implements core X11 protocol, as well as Xrender, Damage, Composite, Big-Requests, Dpms, Screensaver, XFixes, Shape, XTest, XC-Misc, GLX and Apple-WM extensions.

install

npm install x11

Windows users:

  1. install XMing or Cygwin/X
  2. get node-x11 copy (using git or from Github)

#CI build status:

example

Core requests usage:

var x11 = require('x11');

var Exposure = x11.eventMask.Exposure;
var PointerMotion = x11.eventMask.PointerMotion;

x11.createClient(function(err, display) {
    if (!err) {
        var X = display.client;
        var root = display.screen[0].root;
        var wid = X.AllocID();
        X.CreateWindow(
            wid, root,        // new window id, parent
            0, 0, 100, 100,   // x, y, w, h
            0, 0, 0, 0,       // border, depth, class, visual
            { eventMask: Exposure|PointerMotion } // other parameters
        );
        X.MapWindow(wid);
        var gc = X.AllocID();
        X.CreateGC(gc, wid);
        X.on('event', function(ev) {
            if (ev.type == 12)
            {
                X.PolyText8(wid, gc, 50, 50, ['Hello, Node.JS!']);
            }
        });
        X.on('error', function(e) {
            console.log(e);
        });
    } else {
        console.log(err);
    }
});

Screenshots

In use

  • ntk - higher level toolkit on top of X11
  • node-remote - media center controller
  • tiles - tiling window manager
  • vnc - vnc client.
  • node-ewmh - set of EWMH helpers.
  • OdieWM - window manager
  • Dbusmenu - unity global menu client.
  • AirWM - tiling window manager
  • npdf - pdf viewer

Protocol documentation

  • http://www.x.org/releases/X11R7.6/doc/
  • http://www.x.org/releases/X11R7.6/doc/xproto/x11protocol.pdf
  • C Xlib to X11 request mapping table http://tronche.com/gui/x/xlib/appendix/a.html

Other implementations

  • C: XLib - http://www.sbin.org/doc/Xlib/ http://www.tronche.com/gui/x/xlib/ http://www.x.org/docs/X11/xlib.pdf
  • C: XCB - http://xcb.freedesktop.org/
  • Python: http://sourceforge.net/projects/python-xlib/ ( github fork: https://github.com/Ademan/python-xlib-branch pypi: http://pypi.python.org/pypi/Python%20Xlib )
  • https://github.com/alexer/python-xlib-render
  • Python/twisted: https://launchpad.net/twisted-x11
  • Perl: http://search.cpan.org/~smccam/X11-Protocol-0.56/Protocol.pm
  • Go: https://github.com/BurntSushi/xgb
  • Java: https://github.com/xderoche/J11
  • Ruby: https://github.com/dj2/x-ruby-bindings
  • Clojure: https://github.com/noodlewiz/xcljb
  • Guile: https://github.com/mwitmer/guile-xcb