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

buttonmancer

v0.2.2

Published

Easily facilitate remapping actions to gamepad buttons and keyboard keys

Downloads

6

Readme

#buttonmancer 0.2.2

Easily facilitate mapping gamepad buttons and keyboard keys to specific actions in your game.

Buttonmancer supports multiple alternate keys for each action, remapping controls, and returning to default controls;

Just pass in an Action Map to the Buttonmancer() class like the example below to get started.

import Buttonmancer from 'buttonmancer';

const actionMap = {
  gamepad: {
    MOVE_LEFT: ['Left'],
    MOVE_RIGHT: ['Right'],
    JUMP: ['X']
  },
  keyboard: {
    MOVE_LEFT: ['ArrowLeft', 'KeyA'],
    MOVE_RIGHT: ['ArrowRight', 'KeyD'],
    JUMP: ['SpaceBar']
  }
};

const controls = new Buttonmancer(actionMap.gamepad);

You can remap all of the controls in your button mapping by using the remap() method and passing in a new Action Map.

const newMap = {
  MOVE_LEFT: ['Up'],
  MOVE_RIGHT: ['Down'],
  JUMP: ['X', 'Circle', 'Sqaure', 'R1']
};

controls.remap(newMap);

You can remap a single control by using the alterControl() method and passing a single Action.

const newLeft = {
  MOVE_LEFT: ['Left', 'L1']
};

controls.alterControl(newLeft);

Buttonmancer also comes with some utilities, including a simple way to get an accurate and consistent keyboard event name.

import ButtonmancerUtils from 'buttonmancer';

document.addEventListener('keydown', (e) => {
  const keyPressed = ButtonmancerUtils.getKey(e);
});

Currently this function uses the e.keyCode or e.which value to return a normalized e.key value because browser implementations are inconsistent. In the future, it will use the appropriate e.key or e.keyIdentifier value to normalize the event name.