@ctrllr/sdk

Turn any smartphone into a wireless game controller via WebRTC.

Install

pnpm add @ctrllr/sdk

Quick Start

import { CtrllrManager } from '@ctrllr/sdk';

const ctrllr = new CtrllrManager({
  signalingUrl: 'wss://your-signaling-server.com',
});

await ctrllr.connect();

// Display QR code for players to scan
const qrImg = document.getElementById('qr') as HTMLImageElement;
qrImg.src = await ctrllr.getQRCodeDataURL();

// Handle controllers
ctrllr.on('controllerconnected', ({ controller }) => {
  controller.on('statechange', (e) => {
    player.move(e.state.joystick.x, e.state.joystick.y);
  });

  controller.on('buttondown', (e) => {
    if (e.input === 'a') player.jump();
    if (e.input === 'start') game.togglePause();
  });
});

Docs

Full documentation, API reference, and live demo at ctrllr.com/docs.

License

MIT