carnaux / vue-gamepad

🎮 A Vue.js plugin to add gamepad support. Bind any element to trigger a callback when a gamepad button is pressed.

vue-gamepad

A Vue.js plugin to add gamepad support. Bind any element to trigger a callback when a gamepad button is pressed.

Installation

npm/yarn

$ npm install vue-gamepad
# or with yarn
$ yarn add vue-gamepad

CDN

https://unpkg.com/vue-gamepad/dist/vue-gamepad.min.js

Usage

Tell Vue to use the plugin

import Vue from 'vue';
import VueGamepad from 'vue-gamepad';

Vue.use(VueGamepad);

Example usage inside templates:

<button v-gamepad:button-a="callback">Press me!</button>

Constructor Options

Key	Description	Default	Type
analogThreshold	Threshold before analog events are triggered. Low values may cause false positives	0.5	Number
buttonMapping	List of strings containing button indices	Mapping	Array
buttonInitialTimeout	Time (in milliseconds) until the button will start repeating when held down	200	Number
buttonRepeatTimeout	Time (in milliseconds) between each button repeat event when held down	200	Number
injectClasses	Add classes to elements which have a gamepad binding	true	Boolean

Directives

• v-gamepad - Bind an element to a gamepad action which will fire a callback
  • released modifier - Only fire the callback when the button is released
  • repeat modifier - Repeatedly fire the callback when the button is held
• v-gamepad-layer - TODO
• v-gamepad-json - Pass a raw object of buttons, actions and callbacks to bind

License

This project is licensed under the MIT License - see the LICENSE file for details