├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── assets ├── materialButton.svg ├── materialDash.svg ├── materialDpad.svg ├── readmeStandardControllerLayout.jpg └── responsiveGamepadDemo.gif ├── demo ├── analog.js ├── circleButton.js ├── dashButton.js ├── dpad.js ├── examplePlugin.js ├── index.css ├── index.html ├── index.js ├── state.js └── touchpad.js ├── design ├── README.md ├── createPlugin.js ├── disableKeyboardInputElement.js ├── disableKeyboardSpecialKeys.js ├── enable.js ├── gamepadMultiplePlayers.js ├── inputs.js ├── keymap.js ├── multipleInputs.js ├── respondToKeyEvent.js ├── simpleDesktop.js ├── simpleMobile.js ├── state.js └── usePlugin.js ├── lib ├── constants.js ├── gamepad │ └── gamepad.js ├── index.js ├── inputSource.js ├── keyboard │ └── keyboard.js ├── keymap.js └── touchInput │ ├── directional.js │ ├── touchAnalog.js │ ├── touchButton.js │ ├── touchDpad.js │ ├── touchInput.js │ └── touchInputType.js ├── package-lock.json ├── package.json └── rollup.config.js /.gitignore: -------------------------------------------------------------------------------- 1 | # System files 2 | **/.DS_Store 3 | 4 | # Preact 5 | node_modules 6 | dist/ 7 | build/ 8 | 9 | # Logs 10 | logs 11 | *.log 12 | npm-debug.log* 13 | yarn-debug.log* 14 | yarn-error.log* 15 | 16 | # Runtime data 17 | pids 18 | *.pid 19 | *.seed 20 | *.pid.lock 21 | 22 | # Directory for instrumented libs generated by jscoverage/JSCover 23 | lib-cov 24 | 25 | # Coverage directory used by tools like istanbul 26 | coverage 27 | 28 | # nyc test coverage 29 | .nyc_output 30 | 31 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 32 | .grunt 33 | 34 | # Bower dependency directory (https://bower.io/) 35 | bower_components 36 | 37 | # node-waf configuration 38 | .lock-wscript 39 | 40 | # Compiled binary addons (http://nodejs.org/api/addons.html) 41 | build/Release 42 | 43 | # Dependency directories 44 | node_modules/ 45 | jspm_packages/ 46 | 47 | # Typescript v1 declaration files 48 | typings/ 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Optional REPL history 57 | .node_repl_history 58 | 59 | # Output of 'npm pack' 60 | *.tgz 61 | 62 | # Yarn Integrity file 63 | .yarn-integrity 64 | 65 | # dotenv environment variables file 66 | .env 67 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | notifications: 2 | email: false 3 | language: node_js 4 | sudo: false 5 | node_js: 6 | - "node" 7 | install: 8 | - npm install 9 | script: 10 | - npm run build 11 | 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # responsive-gamepad 2 | 3 | 4 | [![Build Status](https://travis-ci.org/torch2424/responsive-gamepad.svg?branch=master)](https://travis-ci.org/torch2424/responsive-gamepad) 5 | ![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/responsive-gamepad.svg) 6 | ![npm](https://img.shields.io/npm/dt/responsive-gamepad.svg) 7 | ![npm version](https://img.shields.io/npm/v/responsive-gamepad.svg) 8 | ![GitHub](https://img.shields.io/github/license/torch2424/responsive-gamepad.svg) 9 | 10 | Handle Keyboard, Gamepad, and Touch Controls in the browser under a single API, (< 5KB). 11 | 12 | [Demo](https://torch2424.github.io/responsive-gamepad/) 13 | 14 | 15 | 16 | # Table Of Contents 17 | 18 | * [Quick Start](#quick-start) 19 | * [Projects Using responsive-gamepad](#projects-using-responsive-gamepad) 20 | * [Instalation](#instalation) 21 | * [API](#api) 22 | * [ResponsiveGamepad](#responsivegamepad) 23 | * [Keyboard](#keyboard) 24 | * [Gamepad](#gamepad) 25 | * [TouchInput](#touchinput) 26 | * [Input Map](#input-map) 27 | * [Plugins](#plugins) 28 | * [How to build plugins](#how-to-build-plugins) 29 | * [Featured Plugins](#featured-plugins) 30 | * [Contributing](#contributing) 31 | * [Installation](#installation) 32 | * [CLI Commands / Npm Scripts](#cli-commands--npm-scripts) 33 | * [LICENSE](#license) 34 | * [Other Notes](#other-notes) 35 | 36 | # Quick Start 37 | 38 | This is a quick **Tl;DR** on installing and using responsive-gamepad: 39 | 40 | 1. `npm install --save responsive-gamepad` 41 | 42 | 2. `import { ResponsiveGamepad } from 'responsive-gamepad';` 43 | 44 | 3. `ResponsiveGamepad.enable();` 45 | 46 | 4. `ResponsiveGamepad.getState();` 47 | 48 | Please see the [Input Map](#input-map) section for what Responsive Gamepad Keys represent on a "Standard" Controller. 49 | 50 | # Projects Using `responsive-gamepad` 51 | 52 | * [WasmBoy](https://github.com/torch2424/wasmBoy) - Gameboy / Gameboy Color Emulator written for Web Assembly using AssemblyScript. 53 | 54 | # Instalation 55 | 56 | *See the [demo/index.js](./demo/index.js), for a proper usage, and touch input example* 57 | 58 | `npm install --save responsive-gamepad` 59 | 60 | # API 61 | 62 | *Additional information/exports concerning can be found in the [Input Map](#input-map) section.* 63 | 64 | *For user journeys, and common How-To use cases, see the [design](./design) directory* 65 | 66 | First, import the `ResponsiveGamepad` singleton service with: 67 | 68 | `import ResponsiveGamepad from 'responsive-gamepad'` 69 | 70 | ## ResponsiveGamepad 71 | 72 | *Properties accessed from: `ResponsiveGamepad`.* 73 | 74 | * `getVersion()`: string - Returns the current version of the lib. 75 | 76 | * `enable()`: void - Enables `ResponsiveGamepad`, and listens for events. 77 | 78 | * `disable()`: void - Removes all listeners from ResponsiveGamepad, and stops listening. 79 | 80 | * `isEnabled()`: boolean - Returns if `ResponsiveGamepad` is currently enabled. 81 | 82 | * `addPlugin(myPlugin)`: function - Adds a plugin to be used with the lib. Returns a function to remove the added plugin. 83 | 84 | * `getState()`: ResponsiveGamepadState - Returns an object with the current state of ResponsiveGamepad. See the [Demo](https://torch2424.github.io/responsive-gamepad/) and the [Input Map](#input-map). 85 | 86 | * `onInputsChange(ArrayOfResponsiveGamepadInputs, callback)`: function - Function to listen for changes on the array of specified `ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS`, and calls a callback whenever they change. Returns a function to stop listening. 87 | 88 | * `clearInputMap()`: Remove all input mappings. Useful if you don't want (some of) the default input map. 89 | 90 | ### Keyboard 91 | 92 | *Properties accessed from: `ResponsiveGamepad.Keyboard`.* 93 | 94 | * `enableIgnoreWhenInputElementFocused()`: void - Enables ignoring ResponsiveGamepad Keyboard input when focused on form input type elements. Enabled by default. 95 | 96 | * `disableIgnoreWhenInputElementFocused()`: void - Disables the above. 97 | 98 | * `enableIgnoreWhenModifierState()`: void - Enables ignoring ResponsiveGamepad Keyboard input when a [Modifier](./lib/keyboard/keyboard.js) key is pressed. See [KeyboardEvent.getModifierState()](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState) for more reference. Enabled by default. 99 | 100 | * `disableIgnoreWhenModifierState()`: void - Disables the above. 101 | 102 | * `setKeysToResponsiveGamepadInput(ArrayOfKeyboardEventCodes, ResponsiveGamepadInput)`: void - Function used for modifying the input map. Takes and array of [KeyboardEvent.code](https://www.w3.org/TR/uievents-code/#code-value-tables) and a single [`ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS`](./lib/constants). 103 | 104 | ### Gamepad 105 | 106 | *Properties accessed from: `ResponsiveGamepad.Gamepad`.* 107 | 108 | * `getState(PlayerIndex: number)`: GamepadState - Function that takes in a player index (0, 1, 2) from the connected gamepads. Returns a `ResponsiveGamepad.getState()` like Object. Can be used for multiplayer. 109 | 110 | * `setGamepadButtonsToResponsiveGamepadInput(ArrayOfGamepadButtonIds, NonAxisResponsiveGamepadInput)`: void - Function used for modifying the input map. Takes and array of [Gamepad Button Ids](https://www.w3.org/TR/gamepad/#remapping) and a single [`ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS`](./lib/constants). 111 | 112 | * `setGamepadAxisToResponsiveGamepadInput(GamepadAxisIds, AxisResponsiveGamepadInput)`: void - Function used for modifying the input map. Takes a single [Gamepad Axis Id](https://www.w3.org/TR/gamepad/#remapping) and a single [`ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS`](./lib/constants). 113 | 114 | ### TouchInput 115 | 116 | *Properties accessed from: `ResponsiveGamepad.TouchInput`.* 117 | 118 | The functions that add inputs to the `ResponsiveGamepad` have additional functionality outside of what is shown below. When inputs are added, they will have styles applied to help with them being touchable. Also, When the touch input becomes active, it will add the CSS class `active` to the element. 119 | 120 | * `addButtonInput(HTMLElement, ResponsiveGamepadInput)`: void - Function that takes in a HTML Element (e.g `document.getElementById`), and a [`ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS`](./lib/constants). Will add the element as an interactive button for the ResponsiveGamepad. 121 | 122 | * `addDpadInput(HTMLElement, configurationObject)`: void - Function that takes in a HTML Element (e.g `document.getElementById`), and a `configurationObject`. Will add the element as an interactive dpad for the `DPAD_UP`, `DPAD_RIGHT`, `DPAD_LEFT`, and `DPAD_DOWN` inputs. The configuration object is outilined below: 123 | 124 | ``` 125 | const configurationObject = { 126 | allowMultipleDirections: false // False by default. This will allow for multiple directions (diagonal) inputs. 127 | } 128 | ``` 129 | 130 | * `addLeftAnalogInput(HTMLElement)`: void - Function that takes in a HTML Element (e.g `document.getElementById`). Will add the element as an interactive virtual joystick for the `LEFT_ANALOG_HORIZONTAL_AXIS`, `LEFT_ANALOG_VERTICAL_AXIS`, `LEFT_ANALOG_UP`, `LEFT_ANALOG_RIGHT`, `LEFT_ANALOG_DOWN`, `LEFT_ANALOG_LEFT` inputs. 131 | 132 | * `addRightAnalogInput(HTMLElement)`: void - Function that takes in a HTML Element (e.g `document.getElementById`). Will add the element as an interactive virtual joystick for the `RIGHT_ANALOG_HORIZONTAL_AXIS`, `RIGHT_ANALOG_VERTICAL_AXIS`, `RIGHT_ANALOG_UP`, `RIGHT_ANALOG_RIGHT`, `RIGHT_ANALOG_DOWN`, `RIGHT_ANALOG_LEFT` inputs. 133 | 134 | # Input Map 135 | 136 | The default input map is based on the **"Standard"** controller. Here is a modified image from the [w3c gamepad draft](https://w3c.github.io/gamepad/#remapping) on how it correlates to the default input map: 137 | 138 | **Note: The X in something like `INPUT_X` represents one of the many directions or axis it represents** 139 | 140 | ![Standard Controller Diagram](./assets/readmeStandardControllerLayout.jpg) 141 | 142 | To see how the keyboard relates to the input map, please see the [default input map](./lib/keymap.js). The library uses [KeyBoardEvent.code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code) to denote all of it's keyboard keys. 143 | 144 | # Plugins 145 | 146 | Plugins allow for modifying the output from getState(). Which can allow for functionality like: 147 | 148 | * Merging multiple inputs into one 149 | 150 | * Adding additional keys for something like another input source. 151 | 152 | * Etc... 153 | 154 | `responsive-gamepad` Plugins should follow the [rollup plugin conventions](https://rollupjs.org/guide/en#conventions): 155 | 156 | * Plugins should have a clear name with `responsive-gamepad-plugin-` prefix. 157 | 158 | * Include `rollup-plugin` keyword in package.json. 159 | 160 | * Document your plugin in English. 161 | 162 | ## How to build plugins 163 | 164 | **For and example, see the demo [ExamplePlugin](./demo/examplePlugin.js).** 165 | 166 | Plugins are simply functions that return an object. See the following example, for what functions the return object could have: 167 | 168 | ``` 169 | export default function ReadmePlugin() { 170 | return { 171 | onAddPlugin: () => { 172 | // Called when the plugin is added with: 'ResponsiveGamepad.addPlugin()' 173 | }, 174 | onGetState: (CurrentResponsiveGamepadState) => { 175 | // Called whenever 'ResponsiveGamepad.getState()' is called. 176 | return CurrentResponsiveGamepadState 177 | } 178 | } 179 | } 180 | ``` 181 | 182 | ## Featured Plugins 183 | 184 | *Open a PR to have your plugin featured here!* 185 | 186 | # Contributing 187 | 188 | Feel free to fork the project, open up a PR, and give any contributions! I'd suggest opening an issue first however, just so everyone is aware and can discuss the proposed changes. 189 | 190 | ### Installation 191 | 192 | Just your standard node app. Install Node with [nvm](https://github.com/creationix/nvm), `git clone` the project, and `npm install`, and you should be good to go! 193 | 194 | ### CLI Commands / Npm Scripts 195 | 196 | ```bash 197 | # Command to serve the demo/lib and watch for changes (No livereload) 198 | npm start 199 | 200 | # Alias for npm start 201 | npm run dev 202 | 203 | # Build the library and demo souce 204 | npm run build 205 | ``` 206 | 207 | # LICENSE 208 | 209 | LICENSE under [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) 210 | 211 | # Other Notes 212 | 213 | * Touch Input SVGS on the responsive gamepad demo, are [Google Material Icons](https://material.io/tools/icons/?style=baseline) 214 | 215 | * XInput vs. DirectInput - [Microsoft Article](https://docs.microsoft.com/en-us/windows/desktop/xinput/xinput-and-directinput), [Reddit thread](https://www.reddit.com/r/pcgaming/comments/4zlbrx/what_is_the_difference_between_directinput_and/) 216 | -------------------------------------------------------------------------------- /assets/materialButton.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /assets/materialDash.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /assets/materialDpad.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /assets/readmeStandardControllerLayout.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/torch2424/responsive-gamepad/fd05ded514afbf22bc80533c4dfaba5f3289efeb/assets/readmeStandardControllerLayout.jpg -------------------------------------------------------------------------------- /assets/responsiveGamepadDemo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/torch2424/responsive-gamepad/fd05ded514afbf22bc80533c4dfaba5f3289efeb/assets/responsiveGamepadDemo.gif -------------------------------------------------------------------------------- /demo/analog.js: -------------------------------------------------------------------------------- 1 | import {Component, h} from 'preact'; 2 | 3 | export default class Analog extends Component { 4 | render({...props}) { 5 | return ( 6 |
7 | 8 | 9 | 10 | 11 | 12 | 13 |
14 | ); 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /demo/circleButton.js: -------------------------------------------------------------------------------- 1 | import {Component, h} from 'preact'; 2 | 3 | export default class CircleButton extends Component { 4 | render({text, ...props}) { 5 | return ( 6 | 7 | 8 | 9 | {text} 10 | 11 | ); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /demo/dashButton.js: -------------------------------------------------------------------------------- 1 | import {Component, h} from 'preact'; 2 | 3 | export default class DashButton extends Component { 4 | render({text, ...props}) { 5 | return ( 6 | 7 | 8 | 9 | {text} 10 | 11 | ); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /demo/dpad.js: -------------------------------------------------------------------------------- 1 | import {Component, h} from 'preact'; 2 | 3 | export default class Dpad extends Component { 4 | render({...props}) { 5 | return ( 6 | 7 | 8 | 9 | 10 | ); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /demo/examplePlugin.js: -------------------------------------------------------------------------------- 1 | // Example Plugin for the libarary 2 | 3 | export default function ExamplePlugin() { 4 | return { 5 | onAddPlugin: () => console.log('ExamplePlugin addPlugin()'), 6 | onGetState: (CurrentResponsiveGamepadState) => { 7 | CurrentResponsiveGamepadState.EXAMPLE_PLUGIN_ADDED = true; 8 | return CurrentResponsiveGamepadState; 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /demo/index.css: -------------------------------------------------------------------------------- 1 | /* Import our CSS Libs */ 2 | @import 'sakura.css/css/normalize.css'; 3 | @import 'sakura.css/css/sakura.css'; 4 | 5 | /* Touchpad */ 6 | .touchpad-spacing { 7 | height: 20vh; 8 | } 9 | 10 | .touchpad { 11 | position: fixed; 12 | bottom: 0; 13 | left: 0; 14 | display: flex; 15 | align-items: flex-end; 16 | width: 100%; 17 | height: 100%; 18 | pointer-events: none; 19 | user-select: none; 20 | } 21 | 22 | .touchpad svg, .touchpad .analog-container { 23 | width: 50%; 24 | height: 20%; 25 | pointer-events: auto; 26 | 27 | background-color: rgba(0,0,0,0.5); 28 | fill: #FAFAFA; 29 | } 30 | 31 | .touchpad .active { 32 | fill: #3ba184; 33 | } 34 | 35 | .touchpad svg text { 36 | font-size: 6px 37 | } 38 | 39 | .analog-container { 40 | position: relative; 41 | display: flex; 42 | justify-content: center; 43 | align-items: center; 44 | } 45 | 46 | .analog-container svg { 47 | background-color: transparent; 48 | width: 100%; 49 | height: 100%; 50 | 51 | } 52 | 53 | .analog-background { 54 | opacity: 0.5; 55 | position: absolute; 56 | top: 0px; 57 | left: 0px; 58 | } 59 | 60 | .analog-stick { 61 | z-index: 100; 62 | width: 68px !important; 63 | height: 68px !important; 64 | } 65 | 66 | -------------------------------------------------------------------------------- /demo/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Responsive Gamepad Demo 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /demo/index.js: -------------------------------------------------------------------------------- 1 | import { h, render, Component } from 'preact'; 2 | import {ResponsiveGamepad} from '../dist/responsive-gamepad.esm'; 3 | 4 | import ExamplePlugin from './examplePlugin'; 5 | 6 | import ResponsiveGamepadState from './state'; 7 | import Touchpad from './touchpad'; 8 | 9 | import './index.css'; 10 | 11 | // Log onInputsChange to console 12 | ResponsiveGamepad.onInputsChange( 13 | ResponsiveGamepad.RESPONSIVE_GAMEPAD_INPUTS.SELECT, 14 | state => { 15 | console.log('demo: onInputsChange SELECT! State:', state); 16 | } 17 | ); 18 | 19 | class ResponsiveGamepadDemo extends Component { 20 | componentDidMount() { 21 | ResponsiveGamepad.addPlugin(ExamplePlugin()); 22 | ResponsiveGamepad.enable(); 23 | } 24 | 25 | render() { 26 | return ( 27 |
28 | 29 |

Responsive Gamepad Demo

30 | Fork me on Github 31 |
Version: {ResponsiveGamepad.getVersion()}
32 | 33 |
34 | This is the example demo for responsive-gamepad. 35 | Feel free to test this demo with: 36 | 41 | Scroll down to see the current state, learn about the api, and test some specific scenarios! 42 |
43 | 44 | 45 | 46 |
47 |

Prevent Default (Keyboard Only)

48 |

49 | I am very tall to show off `event.preventDefault()`. 50 | E.g arrow keys wont scroll if in the keymap. 51 | But typing will work on input type form fields! 52 | Also, keyboard shortcuts will also still work (Refresh the page with Ctrl+R or Cmd+R) 53 |

54 | 58 |
59 |