@antha/input 0.0.8 → 0.1.1

package/README.md

@@ -1,9 +1,59 @@
 # @antha/input
 
-Pre-built [Antha](https://www.npmjs.com/package/antha) mods and elements for handling inputs.
+This package provides pre-built [Antha game engine](https://www.npmjs.com/package/@antha/engine) mods that read keyboard and gamepad input, then translate it into named player actions.
 
 ## Install
 
 ```sh
 npm i @antha/input
 ```
+
+## Usage
+
+<!-- example-link: src/readme-examples/reading-input-bindings.example.ts -->
+
+```TypeScript
+import {AnthaEngine, defineAnthaMod} from '@antha/engine';
+import {
+    type AnthaInputBindingsModState,
+    createAnthaInputBindingsMod,
+    createAnthaReadRawInputMod,
+    InputDirection,
+} from '@antha/input';
+
+enum GameAction {
+    Jump = 'jump',
+}
+
+type GameState = AnthaInputBindingsModState<GameAction>;
+
+const engine = new AnthaEngine<GameState>({
+    initState: {
+        bindingAssignments: {
+            '1': {
+                [GameAction.Jump]: [
+                    {
+                        deviceKey: 'keyboard',
+                        direction: InputDirection.Positive,
+                        inputName: 'button-Space',
+                    },
+                ],
+            },
+        },
+    },
+    mods: [
+        createAnthaReadRawInputMod(),
+        createAnthaInputBindingsMod<GameAction>(),
+        defineAnthaMod<GameState>({
+            modName: 'game-logic',
+            execute({state}) {
+                const jump = state.activeBindings?.['1']?.[GameAction.Jump];
+
+                return jump?.value ? `Jump strength: ${jump.value}` : undefined;
+            },
+        }),
+    ],
+});
+
+engine.startLoop();
+```

package/dist/bindings/antha-menu-nav.mod.js

@@ -1,9 +1,9 @@
 import { defineAnthaMod } from '@antha/engine';
+import { KnownInput } from '@antha/gamepad-type';
 import { check } from '@augment-vir/assert';
 import { getObjectTypedEntries, getObjectTypedValues } from '@augment-vir/common';
 import { convertDuration } from 'date-vir';
 import { NavController, NavDirection, NavValue } from 'device-navigation';
-import { KnownInput } from 'gamepad-type';
 import { InputDirection } from '../raw-inputs/raw-input.js';
 import { AnyGamepad, } from './player-bindings.js';
 export { nav, navAttribute, NavController } from 'device-navigation';

package/dist/elements/antha-keyboard.element.d.ts

@@ -1,6 +1,5 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
+import { type PartialWithUndefined, type RequireExactlyOne } from '@augment-vir/common';
 import { type NavController } from 'device-navigation';
-import { type RequireExactlyOne } from 'type-fest';
 /**
  * Keypress details emitted by the `keyPress` event from {@link AnthaKeyboard}.
  *

package/dist/index.d.ts

@@ -7,5 +7,5 @@ export * from './elements/antha-keyboard.element.js';
 export * from './raw-inputs/antha-raw-input-debug.element.js';
 export * from './raw-inputs/antha-read-raw-input.mod.js';
 export * from './raw-inputs/raw-input.js';
-export * from 'gamepad-type';
+export * from '@antha/gamepad-type';
 export * from 'input-device-handler';

package/dist/index.js

@@ -7,5 +7,5 @@ export * from './elements/antha-keyboard.element.js';
 export * from './raw-inputs/antha-raw-input-debug.element.js';
 export * from './raw-inputs/antha-read-raw-input.mod.js';
 export * from './raw-inputs/raw-input.js';
-export * from 'gamepad-type';
+export * from '@antha/gamepad-type';
 export * from 'input-device-handler';

package/dist/raw-inputs/antha-read-raw-input.mod.d.ts

@@ -1,5 +1,5 @@
+import { type GamepadBrandMap, type GamepadLayout, type GamepadModelMap } from '@antha/gamepad-type';
 import { type PartialWithUndefined, type SelectFrom, type SetRequired } from '@augment-vir/common';
-import { type GamepadBrandMap, type GamepadLayout, type GamepadModelMap } from 'gamepad-type';
 import { InputDeviceHandler, type InputDeviceHandlerOptions, type InputDeviceKey } from 'input-device-handler';
 import { type RawInput, type RawInputs, type SimpleInputDevicesMap } from './raw-input.js';
 /**

package/dist/raw-inputs/antha-read-raw-input.mod.js

@@ -1,8 +1,8 @@
 import { defineAnthaMod } from '@antha/engine';
+import { defaultGamepadLayouts, defaultGamepadModelMap, findMatchingGamepadLayout, findMatchingGamepadModel, modelInputNameOverrides, } from '@antha/gamepad-type';
 import { check } from '@augment-vir/assert';
 import { mapObject, } from '@augment-vir/common';
 import { html } from 'element-vir';
-import { defaultGamepadLayouts, defaultGamepadModelMap, findMatchingGamepadLayout, findMatchingGamepadModel, modelInputNameOverrides, } from 'gamepad-type';
 import { InputDeviceHandler, isGamepadDeviceKey, } from 'input-device-handler';
 import { AnthaRawInputDebug } from './antha-raw-input-debug.element.js';
 import { calculateInputDirection, mapToSimpleDevicesMap, } from './raw-input.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/input",
-    "version": "0.0.8",
+    "version": "0.1.1",
     "description": "An Antha mod for handling inputs.",
     "keywords": [
         "vir",
@@ -33,26 +33,25 @@
         "test:docs": "virmator docs check"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.73.1",
-        "@augment-vir/common": "^31.73.1",
-        "date-vir": "^8.5.0",
-        "device-navigation": "^4.7.2",
-        "gamepad-type": "^2.1.0",
-        "input-device-handler": "^9.0.3",
-        "object-shape-tester": "^6.14.0",
-        "type-fest": "^5.7.0",
-        "vira": "^31.24.1"
+        "@antha/gamepad-type": "^0.1.1",
+        "@augment-vir/assert": "^32.2.2",
+        "@augment-vir/common": "^32.2.2",
+        "date-vir": "^9.0.0",
+        "device-navigation": "^4.7.3",
+        "input-device-handler": "^9.0.4",
+        "object-shape-tester": "^6.14.1",
+        "vira": "^31.29.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.73.1",
-        "@web/dev-server-esbuild": "^1.0.5",
-        "@web/test-runner": "^0.20.2",
-        "@web/test-runner-playwright": "^0.11.1",
-        "element-vir": "^26.17.0",
+        "@augment-vir/test": "^32.2.2",
+        "@web/dev-server-esbuild": "^2.0.0",
+        "@web/test-runner": "^1.0.0",
+        "@web/test-runner-playwright": "^1.0.0",
+        "element-vir": "^26.17.3",
         "istanbul-smart-text-reporter": "^1.1.5"
     },
     "peerDependencies": {
-        "@antha/engine": "^0.0.8",
+        "@antha/engine": "^0.1.1",
         "element-vir": ">=26"
     },
     "engines": {