like2d 2.9.0 → 2.10.0

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,YAAY,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpE,YAAY,EAAE,UAAU,EAAE,iBAAiB,IAAI,eAAe,EAAE,MAAM,eAAe,CAAC;AACtF,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAGvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AACzD,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAE/D;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAGvD"}

package/dist/index.js

@@ -1,11 +1,8 @@
 /**
  * @module like2d
  * @description A cozy web-native 2D game framework.
- *
- * See main like/README.md file an for overview of Like2D.
  */
 import { Engine } from './engine';
-export { ImageHandle } from './core/graphics';
 /**
  * Create a new Like2D game instance attached to a DOM container.
  *
@@ -13,26 +10,8 @@ export { ImageHandle } from './core/graphics';
  * initializes all subsystems (graphics, audio, input), and returns an object
  * where you can assign game callbacks.
  *
- * ### How to bind callbacks
- *
- * ```ts
- * export const like = createLike();
- *
- * like.start();
- *
- * like.draw = () => { like.gfx.clear('yellow') }
- *
- * like.update = function (dt: number) {
- *   if (dt === Math.random()) {
- *     console.log("You just won the Powerball!")
- *   }
- * }
- * ```
- *
  * @param container - The HTML element to attach the game canvas to.
- *                    Must be in the DOM.
  * @returns A {@link Like} instance ready for callback assignment
- *
  */
 export function createLike(container) {
     const engine = new Engine(container);

package/dist/input/gamepad-mapping.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @module GamepadMapping
+ *
+ * A database, generated on module load,
+ * which uses SDL's database to coerce
+ * browser APIs into physical gamepad button
+ * mappings.
+ *
+ * Browser API shortcomings:
+ *  - No standard way of exposing vendor and product
+ *  - Almost nothing is standard
+ *  - Vendor and product alone doesn't suffice for GUID -- Different controllers have the same.
+ *  - D-pads either get mapped to an axis (last pair of axes in Chromium) or buttons (Firefox).
+ *  - Analog axes get mapped differently in Firefox and Chromium.
+ *
+ * How we overcome them:
+ *  - We parse out vendor and product based on currently known formats.
+ *  - We go with best-match and always fall back on manual mapping.
+ */
+import type { Vector2 } from "../math";
+/**
+ * ref: https://www.w3.org/TR/gamepad/#dfn-standard-gamepad
+ * note: `num` is only the corresponding number on standard mapping above.
+ *
+ * The point of the mapping system is to apply that _or_ non-standard mappings,
+ * Which are exceedingly common.
+ */
+declare const buttonMap: readonly [{
+    readonly sdl: "a";
+    readonly like: "BBottom";
+    readonly num: number;
+    readonly name: "Bottom Face Button";
+}, {
+    readonly sdl: "b";
+    readonly like: "BRight";
+    readonly num: 1;
+    readonly name: "Right Face Button";
+}, {
+    readonly sdl: "x";
+    readonly like: "BLeft";
+    readonly num: 2;
+    readonly name: "Left Face Button";
+}, {
+    readonly sdl: "y";
+    readonly like: "BTop";
+    readonly num: 3;
+    readonly name: "Top Face Button";
+}, {
+    readonly sdl: "leftshoulder";
+    readonly like: "L1";
+    readonly num: 4;
+    readonly name: "Left shoulder (front)";
+}, {
+    readonly sdl: "rightshoulder";
+    readonly like: "R1";
+    readonly num: 5;
+    readonly name: "Right shoulder (front)";
+}, {
+    readonly sdl: "lefttrigger";
+    readonly like: "L2";
+    readonly num: 6;
+    readonly name: "Left shoulder (rear)";
+}, {
+    readonly sdl: "righttrigger";
+    readonly like: "R2";
+    readonly num: 7;
+    readonly name: "Right shoulder (rear)";
+}, {
+    readonly sdl: "back";
+    readonly like: "MenuLeft";
+    readonly num: 8;
+    readonly name: "Left Menu Button";
+}, {
+    readonly sdl: "start";
+    readonly like: "MenuRight";
+    readonly num: 9;
+    readonly name: "Right Menu Button";
+}, {
+    readonly sdl: "leftstick";
+    readonly like: "LeftStick";
+    readonly num: 10;
+    readonly name: "Left Stick Button";
+}, {
+    readonly sdl: "rightstick";
+    readonly like: "RightStick";
+    readonly num: 11;
+    readonly name: "Right Stick Button";
+}, {
+    readonly sdl: "dpup";
+    readonly like: "Up";
+    readonly num: 12;
+    readonly name: "D-Pad Up";
+}, {
+    readonly sdl: "dpdown";
+    readonly like: "Down";
+    readonly num: 13;
+    readonly name: "D-Pad Down";
+}, {
+    readonly sdl: "dpleft";
+    readonly like: "Left";
+    readonly num: 14;
+    readonly name: "D-Pad Left";
+}, {
+    readonly sdl: "dpright";
+    readonly like: "Right";
+    readonly num: 15;
+    readonly name: "D-Pad right";
+}];
+export type LikeButton = (typeof buttonMap)[number]["like"] | `Button${number}` | `Axis${number}+` | `Axis${number}-`;
+export type GamepadMapping = {
+    buttons: ButtonMapping;
+    sticks: StickMapping[];
+};
+export type ButtonMapping = Record<number, LikeButton>;
+export type StickMapping = [StickAxisMapping, StickAxisMapping];
+export type StickAxisMapping = {
+    index: number;
+    invert: boolean;
+};
+export declare const defaultMapping: (stickCount: number) => GamepadMapping;
+export declare const standardButtonMapping: () => ButtonMapping;
+export declare const allButtons: Set<string>;
+export declare const fullButtonName: Map<"BBottom" | "BRight" | "BLeft" | "BTop" | "L1" | "R1" | "L2" | "R2" | "MenuLeft" | "MenuRight" | "LeftStick" | "RightStick" | "Up" | "Down" | "Left" | "Right", "Bottom Face Button" | "Right Face Button" | "Left Face Button" | "Top Face Button" | "Left shoulder (front)" | "Right shoulder (front)" | "Left shoulder (rear)" | "Right shoulder (rear)" | "Left Menu Button" | "Right Menu Button" | "Left Stick Button" | "Right Stick Button" | "D-Pad Up" | "D-Pad Down" | "D-Pad Left" | "D-Pad right">;
+export declare const mapStick: (gp: Gamepad, mapping: StickMapping) => Vector2;
+type SdlMapping = {
+    vendor: number;
+    product: number;
+    name: string;
+    sdlName: string;
+    mapping: Record<number, LikeButton>;
+};
+export declare function getSdlMapping(gamepad: Gamepad): SdlMapping | undefined;
+export {};
+//# sourceMappingURL=gamepad-mapping.d.ts.map

package/dist/input/gamepad-mapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gamepad-mapping.d.ts","sourceRoot":"","sources":["../../src/input/gamepad-mapping.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;;;GAMG;AACH,QAAA,MAAM,SAAS;;;kBAC0B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBrC,CAAC;AAEX,MAAM,MAAM,UAAU,GAClB,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAClC,SAAS,MAAM,EAAE,GACjB,OAAO,MAAM,GAAG,GAChB,OAAO,MAAM,GAAG,CAAC;AAIrB,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACvD,MAAM,MAAM,YAAY,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAElE,eAAO,MAAM,cAAc,GAAI,YAAY,MAAM,KAAG,cAQlD,CAAC;AAEH,eAAO,MAAM,qBAAqB,QAAO,aAC0B,CAAC;AACpE,eAAO,MAAM,UAAU,aAAqD,CAAC;AAC7E,eAAO,MAAM,cAAc,qfAE1B,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,IAAI,OAAO,EAAE,SAAS,YAAY,KAAG,OAK7D,CAAC;AAsEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACrC,CAAC;AAEF,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CA0BtE"}

package/dist/input/gamepad-mapping.js

@@ -0,0 +1,146 @@
+/**
+ * @module GamepadMapping
+ *
+ * A database, generated on module load,
+ * which uses SDL's database to coerce
+ * browser APIs into physical gamepad button
+ * mappings.
+ *
+ * Browser API shortcomings:
+ *  - No standard way of exposing vendor and product
+ *  - Almost nothing is standard
+ *  - Vendor and product alone doesn't suffice for GUID -- Different controllers have the same.
+ *  - D-pads either get mapped to an axis (last pair of axes in Chromium) or buttons (Firefox).
+ *  - Analog axes get mapped differently in Firefox and Chromium.
+ *
+ * How we overcome them:
+ *  - We parse out vendor and product based on currently known formats.
+ *  - We go with best-match and always fall back on manual mapping.
+ */
+/**
+ * ref: https://www.w3.org/TR/gamepad/#dfn-standard-gamepad
+ * note: `num` is only the corresponding number on standard mapping above.
+ *
+ * The point of the mapping system is to apply that _or_ non-standard mappings,
+ * Which are exceedingly common.
+ */
+const buttonMap = [
+    { sdl: "a", like: "BBottom", num: 0, name: "Bottom Face Button" },
+    { sdl: "b", like: "BRight", num: 1, name: "Right Face Button" },
+    { sdl: "x", like: "BLeft", num: 2, name: "Left Face Button" },
+    { sdl: "y", like: "BTop", num: 3, name: "Top Face Button" },
+    { sdl: "leftshoulder", like: "L1", num: 4, name: "Left shoulder (front)" },
+    { sdl: "rightshoulder", like: "R1", num: 5, name: "Right shoulder (front)" },
+    { sdl: "lefttrigger", like: "L2", num: 6, name: "Left shoulder (rear)" },
+    { sdl: "righttrigger", like: "R2", num: 7, name: "Right shoulder (rear)" },
+    { sdl: "back", like: "MenuLeft", num: 8, name: "Left Menu Button" },
+    { sdl: "start", like: "MenuRight", num: 9, name: "Right Menu Button" },
+    { sdl: "leftstick", like: "LeftStick", num: 10, name: "Left Stick Button" },
+    {
+        sdl: "rightstick",
+        like: "RightStick",
+        num: 11,
+        name: "Right Stick Button",
+    },
+    { sdl: "dpup", like: "Up", num: 12, name: "D-Pad Up" },
+    { sdl: "dpdown", like: "Down", num: 13, name: "D-Pad Down" },
+    { sdl: "dpleft", like: "Left", num: 14, name: "D-Pad Left" },
+    { sdl: "dpright", like: "Right", num: 15, name: "D-Pad right" },
+];
+export const defaultMapping = (stickCount) => ({
+    buttons: {},
+    sticks: Array(stickCount / 2)
+        .fill(0)
+        .map((_, i) => [
+        { index: i * 2, invert: false },
+        { index: i * 2 + 1, invert: false },
+    ]),
+});
+export const standardButtonMapping = () => Object.fromEntries(buttonMap.map(({ like, num }) => [num, like]));
+export const allButtons = new Set(buttonMap.map(({ like }) => like));
+export const fullButtonName = new Map(buttonMap.map(({ like, name }) => [like, name]));
+export const mapStick = (gp, mapping) => {
+    return mapping.map((axis) => (axis.invert ? -1 : 1) * (gp.axes[axis.index] ?? 0));
+};
+//// ************* SDL Gamepad auto-binding system ******************* ////
+// @ts-ignore
+import gamecontrollerdb from "../gamecontrollerdb.txt?raw";
+const sdlButtonSet = new Set(buttonMap.map(({ sdl }) => sdl));
+const sdlToLikeMap = new Map(buttonMap.map(({ sdl, like }) => [sdl, like]));
+const mappingDb = generateMappingDb(gamecontrollerdb);
+function generateMappingDb(db) {
+    const dbEntries = db
+        .split("\n")
+        .map((l) => l.trim())
+        .filter((line) => line !== "" && !line.startsWith("#"))
+        .map(parseDbLine);
+    console.log(`[Gamepad] Parsed ${dbEntries.length} entries from DB`);
+    const mappingDb = Object.fromEntries(dbEntries);
+    console.log(`[Gamepad] Final entry count: ${Object.keys(mappingDb).length}`);
+    return mappingDb;
+}
+function parseDbLine(line) {
+    const [guid, name, ...mappings] = line.split(",");
+    mappings.pop();
+    const vpNum = 0x1 * parseInt(guid.substring(16, 18), 16) +
+        0x100 * parseInt(guid.substring(18, 20), 16) +
+        0x10000 * parseInt(guid.substring(8, 10), 16) +
+        0x1000000 * parseInt(guid.substring(10, 12), 16);
+    const mapping = Object.fromEntries(mappings
+        .map((s) => {
+        const [sdl, bname] = s.split(":");
+        const browserIndex = sdlRawButtonToBrowser(bname);
+        return (browserIndex !== undefined &&
+            sdlButtonSet.has(sdl) && [browserIndex, sdlToLikeMap.get(sdl)]);
+    })
+        .filter((v) => !!v));
+    return [vpNum, { name, mapping }];
+}
+function sdlRawButtonToBrowser(btn) {
+    return btn.startsWith("b")
+        ? Number(btn.substring(1))
+        : btn.startsWith("h")
+            ? { 1: 12, 2: 13, 4: 14, 8: 15 }[Number(btn.substring(3))]
+            : undefined;
+}
+export function getSdlMapping(gamepad) {
+    const parsed = tryParseId(gamepad.id);
+    if (parsed) {
+        const [vendorStr, productStr, nameStr] = parsed;
+        const vendor = parseInt(vendorStr, 16);
+        const product = parseInt(productStr, 16);
+        const name = nameStr.trim();
+        const mapping = mappingDb[vendor * 0x10000 + product];
+        if (mapping) {
+            console.log(`[Gamepad] Found SDL db mapping for '${name}'`);
+            return {
+                vendor,
+                product,
+                name,
+                sdlName: mapping.name,
+                mapping: mapping.mapping,
+            };
+        }
+        else {
+            console.log(`[Gamepad] No SDL db mapping found for '${gamepad.id}.`);
+        }
+    }
+    else {
+        console.log(`[Gamepad] Failed to parse id: ${gamepad.id}. Please report this bug with the name of your web browser.`);
+    }
+}
+function tryParseId(id) {
+    const infoC = id.match(/^([^(]+)\(Vendor: ([0-9a-f]+) Product: ([0-9a-f]+)/i);
+    if (infoC) {
+        // chrome pattern: Name(Vendor: VEND Product: PROD)
+        const [, name, vendor, product] = infoC;
+        return [vendor, product, name.trim()];
+    }
+    else {
+        // firefox pattern: VEND-PROD-Name
+        const infoF = id.split("-");
+        if (infoF.length == 3) {
+            return infoF;
+        }
+    }
+}

package/dist/input/gamepad.d.ts

@@ -0,0 +1,74 @@
+import { GamepadMapping, LikeButton } from './gamepad-mapping';
+import { type LikeGamepadEvent } from '../events';
+import { Vector2 } from '../math/vector2';
+import { EngineProps } from '../engine';
+/** A selector for a gamepad. */
+export type GamepadTarget = number | "any";
+/** LIKE Gamepad Wrapper
+ *
+ *  - Allows events/callbacks to be sent from joy buttons.
+ *  - Can track if any gamepad has a button pressed / just pressed.
+ *  - Remaps raw input numbers to readable strings -- by default using SDL database.
+ *
+ * If you're planning on supporting gamepads, please include a
+ * way to generate {@link GamepadMapping} and set it with {@link Gamepad.setMapping}.
+ *
+ * If you don't want to make your own, take a look at `prefab-scenes/mapGamepad`.
+ */
+export declare class Gamepad {
+    private dispatch;
+    private gamepads;
+    private autoLoadMapping;
+    constructor(props: EngineProps<LikeGamepadEvent>);
+    private onGamepadConnected;
+    /**
+     * @private
+     * Called by the engine every frame.
+     */
+    update(): void;
+    /**
+     *
+     * @param target Which controller?
+     * @returns all of the sticks. Convention is 0 = left, 1 = right.
+     */
+    getSticks(target: number): Vector2[];
+    fullButtonName(name: LikeButton): string;
+    private checkButton;
+    /** Check if a gamepad button is down. */
+    isDown(target: GamepadTarget, button: LikeButton | number): boolean | undefined;
+    /**
+     * Returns true for only one frame/update if a button is pressed.
+     * Considered an alternative to `like.gamepadpressed`.
+     */
+    justPressed(target: GamepadTarget, button: LikeButton | number): boolean | undefined;
+    /**
+     * Get a controller mapping.
+     * Note that modifying this mapping in place will modify the target controller.
+     * However, use `setMapping` to finalize the mapping.
+     */
+    getMapping(index: number): GamepadMapping | undefined;
+    /**
+     * Set the mapping for a particular controller.
+     *
+     * Set `save = false` if you don't want this written into localstorage.
+     */
+    setMapping(index: number, mapping: GamepadMapping, save?: boolean): void;
+    /**
+     * Get saved mapping from db, if it exists.
+     */
+    loadMapping(index: number): GamepadMapping | undefined;
+    /**
+     * Save a mapping to persistant storage
+     */
+    saveMapping(index: number, mapping: GamepadMapping): void;
+    /**
+     * Enable automatically loading mappings.
+     *
+     * When a gamepad with a known (to this system) ID is plugged in,
+     * this will load the previously saved mapping.
+     *
+     * @param enable
+     */
+    enableAutoLoadMapping(enable: boolean): void;
+}
+//# sourceMappingURL=gamepad.d.ts.map

package/dist/input/gamepad.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gamepad.d.ts","sourceRoot":"","sources":["../../src/input/gamepad.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkC,cAAc,EAAiB,UAAU,EAAY,MAAM,mBAAmB,CAAC;AACxH,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,gCAAgC;AAChC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,eAAe,CAAQ;gBAEnB,KAAK,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAgChD,OAAO,CAAC,kBAAkB;IA+B1B;;;OAGG;IACH,MAAM,IAAI,IAAI;IAId;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAQpC,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIxC,OAAO,CAAC,WAAW;IAYnB,yCAAyC;IACzC,MAAM,CACJ,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;OAGG;IACH,WAAW,CACT,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,UAAU,GAAG,MAAM,GAC1B,OAAO,GAAG,SAAS;IAItB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIrD;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,UAAO;IAU9D;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAYtD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IASlD;;;;;;;OAOG;IACH,qBAAqB,CAAC,MAAM,EAAE,OAAO;CAGtC"}