smartpeer v1.0.0

SmartPeer: Peer-to-peer for creating smartphone controllers

SmartPeer provides an easy way of turning a smartphone into versatile controller.

Getting started

Include the library

install NPM package: npm install smartpeer

// The usage -
import SmartPeer from 'smartpeer';

Create a Peer

const peer = new smartPeer('id', 'frequency'); 
// all parameters are optional:
// ID: if id isn't provided a random one will be created
// Frequency: how often should the the updates occur 

Create a QRcode \ Make a qr code for easy phone connection

peer.createQrCode(type, url, canvas);
//select from premade controllers by specifying a type (joystick, touchscreen, nes controller) or provide a url for your own controller
//canvas element for the qr code to be displayed

Events

Register a new event

peer.on(flag, function);
//Flag: specify when the function should be called (connection, data, close)
//Function: pass a function to be called

Types of callbacks \ connection : will pass a number of player who just connected to your function \ data : will pass a player number and the input from the phone \ close : will pass a number of player who just disconnected \

Display stats

peer.getStats(type, DomElement)
//Specify type of stats you wish to display (latency, update frequency...) and an html element to display them

Access last state player

peer.state.playerNumber
//will return last known state of a given player