Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

gkey

hughsk3MIT0.0.0

An index of gamepad input mappings for controllers using the HTML5 gamepad API

gamepad, api, browserify, html5, input, control, index

readme

gkey

A list of human-readable names for Browser-friendly gamepads. Currently only supports generic/XBox-like controllers, but if you have the opportunity to test with others then submit a pull request and I'll merge it in!

Installation

npm install gkey

Usage

See gp-controls for an example implementation.

var generic = require('gkey/generic')
var xbox = require('gkey/xbox')

var gamepad = navigator.getGamepads()[0]

console.log(generic.buttons[0], gamepad.buttons[0]) // "<action 1>" 1
console.log(xbox.buttons[0], gamepad.buttons[0])    // "<a>" 1

console.log(generic.axes[0], gamepad.buttons[0])    // "<axis-left-x>" -0.75
console.log(xbox.axes[0], gamepad.buttons[0])       // "<axis-left-x>" -0.75