inpt 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raoul van Rüschen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+# Input Controller
+
+[![CI](https://github.com/vanruesc/input-controller/actions/workflows/ci.yml/badge.svg)](https://github.com/vanruesc/input-controller/actions/workflows/ci.yml)
+[![Version](https://badgen.net/npm/v/input-controller?color=green)](https://www.npmjs.com/package/input-controller)
+
+A fast, event-based input management library for the browser.
+
+*[Demo](https://vanruesc.github.io/input-controller/demo) · [Documentation](https://vanruesc.github.io/input-controller/docs)*
+
+## Installation
+
+```sh
+npm install input-controller
+```
+
+## Features
+
+* Emits action events for bound inputs.
+* Emits normalized events for different pointer types and gestures.
+* Supports input bindings with user-defined actions.
+* Supports input combinations with modifiers.
+  * Input matching uses fast bitwise operations.
+  * Matches are reevaluated immediately when any input changes.
+* Supports different pointer lock behaviors per pointer button: `none`, `lock` and `lock-hold`.
+* Disables the context menu when any action is bound to the secondary button.
+  * This does not apply if the action also requires a modifier.
+
+## Usage
+
+```js
+import { InputManager } from "input-controller";
+
+const inputManager = new InputManager(settings.input, domElement);
+inputManager.addEventListener("activate", event => console.log(event));
+inputManager.addEventListener("deactivate", event => console.log(event));
+inputManager.addEventListener("move", event => console.log(event));
+```
+
+## Settings
+
+### Configuration
+
+```js
+import { KeyCode, Input, PointerButton } from "input-controller";
+
+const settings = inputManager.settings;
+settings.pointer.setBehavior(PointerButton.MAIN, "lock");
+
+const keyBindings = settings.keyBindings;
+keyBindings.set("Space", "jump");
+keyBindings.set(new Input("KeyS", { modifiers: ["Ctrl"] }), "save");
+
+const pointerBindings = settings.pointerBindings;
+pointerBindings.set(PointerButton.MAIN, "drag");
+pointerBindings.set(Gesture.PINCH, "zoom");
+pointerBindings.set(Gesture.ROTATE, "rotate");
+```
+
+See the [docs](https://vanruesc.github.io/input-controller/docs/classes/Settings.html) for more information.
+
+### Saving and Loading
+
+```js
+// JSON round-trip.
+const json = JSON.stringify(settings);
+settings.fromJSON(json);
+
+// Via local storage.
+localStorage.setItem("input-controller", JSON.stringify(settings));
+settings.fromJSON(localStorage.getItem("input-controller"));
+
+// Save as JSON file.
+const settingsURL = URL.createObjectURL(settings.toBlob());
+const a = document.createElement("a");
+a.setAttribute("href", settingsURL);
+a.setAttribute("download", "input-controller.json");
+a.click();
+URL.revokeObjectURL(settingsURL);
+
+// Load from JSON file.
+fetch("./input-controller.json")
+	.then(response => response.text())
+	.then(data => settings.fromJSON(data))
+	.catch(e => console.error(e));
+```
+
+## Contributing
+
+Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.