npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gamepadcontroller

v1.0.1

Published

An event based api for gamepad controllers in the browser

Downloads

109

Readme

Gamepad Controller

An event based api for using gamepads in the browser

Facilitates listening to button press, button release, and joy stick move events from a connected gamepad controller. This package was developed with an xbox one controller, but should support any gamepad.

Usage

Install with: $ npm install --save gamepadcontroller

Then on the client:

// ES6
import 'GamepadController' from 'gamepadcontroller';
// OR ES5
var GamepadController = require('gamepadcontroller');

const gamepad = new GamepadController(0 /* takes an index, 0 - 3  */);
gamepad.onButtonPress(0, e => console.log(e, 'A button pressed'));
gamepad.onButtonRelease(0, e => console.log(e, 'A button released'));
gamepad.onButtonChange(7, e => console.log(e, 'Right trigger changed'));
gamepad.onStickMove(0, e => console.log(e, 'Left stick moved'));

The GamepadController constructor requires an index from 0 - 3 to determine which of the four potential gamepad controller slots to wrap.

Event Listeners

Button Events

  • gamepad.onButtonPress(buttonIndex, buttonCallbackFunction)
  • gamepad.removeOnButtonPress(buttonIndex)
  • gamepad.onButtonRelease(buttonIndex, buttonCallbackFunction)
  • gamepad.removeOnButtonRelease(buttonIndex)
  • gamepad.onButtonChange(buttonIndex, buttonCallbackFunction)
  • gamepad.removeOnButtonChange(buttonIndex)
function buttonCallbackFunction (state) {
  const { previous, current } = state;
  // previous and current = { pressed: Bool, value: 0 < value < 1 } 
  // handle button event ...
}

Stick Events

  • gamepad.onStickMove(stickIndex, stickCallbackFunction)
  • gamepad.removeOnStickMove(stickIndex)
function stickCallbackFunction (state) {
  const { previous, current } = state;
  // previous and current = { x: -1 < x < 1, y: -1 < y < 1 }
  // handle stick move ...
}

Reference

Standard button mapping for an Xbox One Gamepad Controller:

 0: 'a'
 1: 'b'
 2: 'x'
 3: 'y'
 4: 'left bumper'
 5: 'right bumper'
 6: 'left trigger'
 7: 'right trigger'
 8: 'back'
 9: 'start'
10: 'left stick'
11: 'right stick'
12: 'up'
13: 'down'
14: 'left'
15: 'right'
16: 'xbox'

Joystick indexes for an Xbox One Gamepad Controller:

0: 'left stick'
1: 'right stick'