Git Product home page Git Product logo

gamepad.js's Introduction

gamepad.js

Simple HTML5 Gamepad API handler

Demo here: http://tom32i.github.io/gamepad.js/

Installation:

npm i gamepad.js

Usage:

var listener = new GamepadListener();

Options:

analog: (boolean: default true) Set to false to get fixed value: ex for a stick 0/1/-1. Used to reduce the number of change event triggered if you dont need analog values.

precision: (int: default 0 (no rounding)) When in analog mode, set the number of number you want after decimal. Used to reduce the muber of event triggered but keep analog values.

deadZone: (float: from 0 to 1) Percent of noise to ignore around 0. Ex: deadZone set to 0.3 will cause stick position of from -0.3 to 0.3 to be considered 0. Stick moves below 30% from default positon won't trigger a change.

Theses options can be set for the whole gamepad:

var listener = new GamepadListener({
    analog: false,
    deadZone: 0.3
});

Or distinctly for sticks and buttons:

var listener = new GamepadListener({
    button: {
        analog: false
    },
    stick: {
        precision: 2,
        deadZone: 0.5
    }
});

Events:

  • 'gamepad:connected': When a new gamepad is connected.
  • 'gamepad:disconnected': When a gamepad is disconnected.
  • 'gamepad:axis': When a gamepad axis changes.
  • 'gamepad:{gamepad}:axis': When a specific gamepad axis changes, '{gamepad}' being the numeric index.
  • 'gamepad:{gamepad}:axis:{axis}': When a specific axis on a specific gamepad changes, '{axis}' being the numeric index of the axis.
  • 'gamepad:button': When a gamepad button changes.
  • 'gamepad:{gamepad}:button': When a specific gamepad button changes, '{gamepad}' being the numeric index.
  • 'gamepad:{gamepad}:button:{button}': When a specific button on a specific gamepad changes, '{button}' being the numeric index of the button.

Listen for value change on gampads:

listener.on('gamepad:connected',  function (event) {
    /**
     * event: CustomEvent
     *   detail: {
     *       gamepad: Gamepad,
     *       index: 0
     *   }
     */
});

listener.on('gamepad:disconnected',  function (event) {
    /**
     * event: CustomEvent
     *   detail: {
     *       index: 0
     *   }
     */
});

listener.on('gamepad:axis', function (event) {
    /**
     * event: CustomEvent
     *   detail: {
     *       axis: 1,
     *       gamepad: Gamepad,
     *       value: -0.34
     *   }
     */
});

listener.on('gamepad:0:button',  function (event) {
    /**
     * event: CustomEvent
     *   detail: {
     *       gamepad: Gamepad,
     *       button: GamepadButton,
     *       pressed: true,
     *       index: 7,
     *       value: 0.56
     *   }
     */
});

listener.on('gamepad:0:button:5',  function (event) {
    /**
     * event: CustomEvent
     *   detail: {
     *       gamepad: Gamepad,
     *       button: GamepadButton,
     *       pressed: true,
     *       index: 5,
     *       value: 1
     *   }
     */
});

gamepad.js's People

Contributors

tom32i avatar

Watchers

James Cloos avatar Rowdy Rabouw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.