@blankparenthesis/pxlsspace v2.8.6

node-pxls

A node module for interacting with pxls.space based websites using a combination of REST API and WebSocket.

Examples

Listening to all pixel placements:

const { Pxls } = require("@blankparenthesis/pxlsspace");

const pxls = new Pxls({ 
	site: "pxls.space", 
	buffers: [],
});
pxls.on("pixel", console.log);
pxls.connect();

Save a snapshot of the canvas:

const { Pxls, BufferType } = require("@blankparenthesis/pxlsspace");

const pxls = new Pxls({ 
	site: "pxls.space", 
	buffers: [BufferType.CANVAS],
});
pxls.connect().then(() => {
	pxls.saveCanvas("snapshot.png");
});

Getting the online user count:

const { Pxls } = require("@blankparenthesis/pxlsspace");

const pxls = new Pxls({ 
	site: "pxls.space", 
	buffers: [],
});
pxls.connect().then(() => {
	console.log(pxls.users);
});