ttpg-darrell 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,2 @@
+# ttpg-darrell
+Tabletop Playground utilities, mostly libraries for in-game scripts plus some asset wrangling tools.

package/build/cjs/hello.js

@@ -0,0 +1,2 @@
+"use strict";
+console.log("hello");

package/build/cjs/layout/layout-objects.d.ts

@@ -0,0 +1,36 @@
+import { StaticObject, Vector } from "@tabletop-playground/api";
+export type LayoutObjectsSize = {
+    w: number;
+    h: number;
+};
+export declare class LayoutObjects {
+    private _children;
+    private _horizontalAlignment;
+    private _verticalAlignment;
+    private _childDistance;
+    private _isVertical;
+    private _overrideHeight;
+    private _overrideWidth;
+    constructor();
+    setChildDistanace(value: number): this;
+    setHorizontalAlignment(value: number): this;
+    setVerticalAlignment(value: number): this;
+    setIsVertical(value: boolean): this;
+    setOverrideHeight(value: number): this;
+    setOverrideWidth(value: number): this;
+    add(item: StaticObject | LayoutObjects): this;
+    /**
+     * Get size of self, applying any overrides.
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateSize(): LayoutObjectsSize;
+    /**
+     * Get size from laying out children (ignore override on self).
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateChildrenSize(): LayoutObjectsSize;
+    _calculateChildSize(child: StaticObject | LayoutObjects): LayoutObjectsSize;
+    doLayoutAtPoint(center: Vector, yaw: number): this;
+}

package/build/cjs/layout/layout-objects.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutObjects = void 0;
+const api_1 = require("@tabletop-playground/api");
+class LayoutObjects {
+    constructor() {
+        this._children = [];
+        this._horizontalAlignment = api_1.HorizontalAlignment.Center;
+        this._verticalAlignment = api_1.VerticalAlignment.Center;
+        this._childDistance = 0;
+        this._isVertical = false;
+        this._overrideHeight = 0;
+        this._overrideWidth = 0;
+    }
+    setChildDistanace(value) {
+        this._childDistance = value;
+        return this;
+    }
+    setHorizontalAlignment(value) {
+        this._horizontalAlignment = value;
+        return this;
+    }
+    setVerticalAlignment(value) {
+        this._verticalAlignment = value;
+        return this;
+    }
+    setIsVertical(value) {
+        this._isVertical = value;
+        return this;
+    }
+    setOverrideHeight(value) {
+        this._overrideHeight = value;
+        return this;
+    }
+    setOverrideWidth(value) {
+        this._overrideWidth = value;
+        return this;
+    }
+    // ----------------------------------
+    add(item) {
+        this._children.push(item);
+        return this;
+    }
+    /**
+     * Get size of self, applying any overrides.
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateSize() {
+        let size = this.calculateChildrenSize();
+        if (this._overrideHeight > 0) {
+            size.h = this._overrideHeight;
+        }
+        if (this._overrideWidth > 0) {
+            size.w = this._overrideWidth;
+        }
+        return size;
+    }
+    /**
+     * Get size from laying out children (ignore override on self).
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateChildrenSize() {
+        const size = { w: 0, h: 0 };
+        // Account for child distance.
+        const spacing = Math.max(this._children.length - 1, 0) * this._childDistance;
+        if (this._isVertical) {
+            size.h = spacing;
+        }
+        else {
+            size.w = spacing;
+        }
+        // Apply each child.
+        for (const child of this._children) {
+            const childSize = this._calculateChildSize(child);
+            if (this._isVertical) {
+                size.w = Math.max(size.w, childSize.w);
+                size.h += childSize.h;
+            }
+            else {
+                size.h = Math.max(size.h, childSize.h);
+                size.w += childSize.w;
+            }
+        }
+        return size;
+    }
+    _calculateChildSize(child) {
+        let childSize;
+        if (child instanceof api_1.StaticObject) {
+            const currentRotation = true;
+            const includeGeometry = false;
+            const extent = child.getExtent(currentRotation, includeGeometry);
+            childSize = { w: extent.y * 2, h: extent.x * 2 };
+        }
+        else {
+            childSize = child.calculateSize();
+        }
+        return childSize;
+    }
+    doLayoutAtPoint(center, yaw) {
+        const size = this.calculateSize();
+        const childrenSize = this.calculateChildrenSize();
+        let padLeft;
+        if (this._horizontalAlignment === api_1.HorizontalAlignment.Left) {
+            padLeft = 0;
+        }
+        else if (this._horizontalAlignment === api_1.HorizontalAlignment.Right) {
+            padLeft = size.w - childrenSize.w;
+        }
+        else {
+            padLeft = (size.w - childrenSize.w) / 2; // center (even if "Fill")
+        }
+        let padTop;
+        if (this._verticalAlignment === api_1.VerticalAlignment.Top) {
+            padTop = 0;
+        }
+        else if (this._verticalAlignment === api_1.VerticalAlignment.Bottom) {
+            padTop = size.w - childrenSize.w;
+        }
+        else {
+            padTop = (size.w - childrenSize.w) / 2; // center (even if "Fill")
+        }
+        let left = -size.w / 2 + padLeft;
+        let top = -size.h / 2 + padTop;
+        for (const child of this._children) {
+            const childSize = this._calculateChildSize(child);
+            // Calculate child center (world).
+            const childCenter = new api_1.Vector(top + childSize.h / 2, left + childSize.w / 2, 0)
+                .rotateAngleAxis(yaw, [0, 0, 1])
+                .add(center);
+            // Position child.
+            if (child instanceof api_1.StaticObject) {
+                child.setPosition(childCenter);
+                child.setRotation(child.getRotation().compose([0, yaw, 0]));
+            }
+            else {
+                child.doLayoutAtPoint(childCenter, yaw);
+            }
+            // Move "cursor" to next open spot top-left.
+            if (this._isVertical) {
+                top += childSize.h + this._childDistance;
+            }
+            else {
+                left += childSize.w + this._childDistance;
+            }
+        }
+        return this;
+    }
+}
+exports.LayoutObjects = LayoutObjects;

package/build/cjs/layout/layout.d.ts

@@ -0,0 +1,8 @@
+import { GameObject } from "@tabletop-playground/api";
+export declare class Layout {
+    private _anchorX;
+    private _anchorY;
+    getWidth(): number;
+    getHeight(): number;
+    add(obj: GameObject, weight?: number): void;
+}

package/build/cjs/layout/layout.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Layout = void 0;
+class Layout {
+    constructor() {
+        this._anchorX = 0.5;
+        this._anchorY = 0.5;
+    }
+    getWidth() {
+        return 0;
+    }
+    getHeight() {
+        return 0;
+    }
+    add(obj, weight = 0) { }
+}
+exports.Layout = Layout;

package/build/cjs/locale/locale.d.ts

@@ -0,0 +1,8 @@
+export declare const locale: {
+    (key: string, replacement?: {
+        [key: string]: string | number;
+    } | undefined): string;
+    inject(dict: {
+        [key: string]: string;
+    }): void;
+};

package/build/cjs/locale/locale.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.locale = void 0;
+const REPLACE_REGEX = /(?<!\\){(?!#)(.*?)(?<!\\)}/gm;
+const PLURAL_REGEX = /(?<!\\){#(.*?)(?<!\\)}/gm;
+const PLURAL_SEPERATOR = /(?<!\\)\|/gm;
+const _lang = {};
+// Original author: ThatRobHuman
+const locale = (key, replacement = undefined) => {
+    const str = _lang[key];
+    if (!str) {
+        return key; // not registered, use key as stand-in
+    }
+    else if (!replacement) {
+        return str; // no need for regex
+    }
+    return str
+        .replace(REPLACE_REGEX, (match) => {
+        const r = replacement[match.substring(1, match.length - 1)].toString();
+        if (r === undefined) {
+            return match;
+        }
+        return r;
+    })
+        .replace(PLURAL_REGEX, (match) => {
+        const [val, singular, plural, zeroForm] = match
+            .substring(2, match.length - 1)
+            .split(PLURAL_SEPERATOR);
+        const num = Number(replacement[val]);
+        if (isNaN(num) || num === 0) {
+            return zeroForm || plural;
+        }
+        if (num > 1) {
+            return plural;
+        }
+        return singular;
+    });
+};
+exports.locale = locale;
+exports.locale.inject = (dict) => {
+    for (const [k, v] of Object.entries(dict)) {
+        _lang[k] = v;
+    }
+};

package/build/cjs/nsid/nsid.d.ts

@@ -0,0 +1,54 @@
+import { Card, StaticObject } from "@tabletop-playground/api";
+export type ParsedNSID = {
+    nsid: string;
+    type: string[];
+    source: string[];
+    name: string[];
+    extra: string | undefined;
+};
+export declare const DECK_NSID = "deck:?/?";
+/**
+ * Object metadata field uses a simple "type:source/name|extra" string.
+ *
+ * Each component is a dot (".") delimited series of strings.
+ *
+ * TYPE delineates the hierarchy to the specific object type.  Entries should
+ * start generic and get more specific, for instance "card.action" is a card
+ * from the action deck.  The TYPE field should be sufficient to locate where
+ * the item belongs, in some cases augment with owning player slot.
+ *
+ * SOURCE is the produce/release with the item.  For instance, "base" could
+ * mean the base game, or use an official expansion name.  Recommend homebrew
+ * always start with "homebrew.{x}" where {x} is the identifier (to avoid
+ * confusion with canon content sources).
+ *
+ * NAME is the item name.  It may include dot-delimited discriminators for
+ * different versions of the same item (e.g. "direct_hit.1" vs "direct_hit.2").
+ *
+ * EXTRA should be avoided, there may be rare cases wanting fruther metadata.
+ *
+ * @see https://github.com/TI4-Online/TI4-TTPG/wiki/NSID-Namespace
+ */
+export declare abstract class NSID {
+    /**
+     * Create NSID from a metadata string or object.  A deck with multiple cards
+     * gets a special "deck" NSID, consumers should call `stack` to get by card.
+     *
+     * @param input
+     * @returns NSID string
+     */
+    static get(input: StaticObject): string;
+    /**
+     * Get NSIDs for each card in a deck.
+     *
+     * @param input deck
+     * @returns NSID array, per-card values
+     */
+    static getDeck(input: Card): string[];
+    /**
+     * Parse this NSID into components (and sub-components, if dot delimited).
+     *
+     * @returns parsed
+     */
+    static parse(nsid: string): ParsedNSID | undefined;
+}

package/build/cjs/nsid/nsid.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NSID = exports.DECK_NSID = void 0;
+const api_1 = require("@tabletop-playground/api");
+exports.DECK_NSID = "deck:?/?";
+/**
+ * Object metadata field uses a simple "type:source/name|extra" string.
+ *
+ * Each component is a dot (".") delimited series of strings.
+ *
+ * TYPE delineates the hierarchy to the specific object type.  Entries should
+ * start generic and get more specific, for instance "card.action" is a card
+ * from the action deck.  The TYPE field should be sufficient to locate where
+ * the item belongs, in some cases augment with owning player slot.
+ *
+ * SOURCE is the produce/release with the item.  For instance, "base" could
+ * mean the base game, or use an official expansion name.  Recommend homebrew
+ * always start with "homebrew.{x}" where {x} is the identifier (to avoid
+ * confusion with canon content sources).
+ *
+ * NAME is the item name.  It may include dot-delimited discriminators for
+ * different versions of the same item (e.g. "direct_hit.1" vs "direct_hit.2").
+ *
+ * EXTRA should be avoided, there may be rare cases wanting fruther metadata.
+ *
+ * @see https://github.com/TI4-Online/TI4-TTPG/wiki/NSID-Namespace
+ */
+class NSID {
+    /**
+     * Create NSID from a metadata string or object.  A deck with multiple cards
+     * gets a special "deck" NSID, consumers should call `stack` to get by card.
+     *
+     * @param input
+     * @returns NSID string
+     */
+    static get(input) {
+        let metadata = "";
+        if (input instanceof api_1.Card) {
+            if (input.getStackSize() === 1) {
+                // Singleton card: use the card metadata.
+                metadata = input.getCardDetails().metadata;
+            }
+            else {
+                // Deck: do not attempt to extract more here.
+                metadata = exports.DECK_NSID;
+            }
+        }
+        else if (input instanceof api_1.StaticObject) {
+            // Non-card table or game object.  Use template metadata.
+            metadata = input.getTemplateMetadata();
+        }
+        return metadata;
+    }
+    /**
+     * Get NSIDs for each card in a deck.
+     *
+     * @param input deck
+     * @returns NSID array, per-card values
+     */
+    static getDeck(input) {
+        return input.getAllCardDetails().map((cardDetails) => {
+            return cardDetails.metadata;
+        });
+    }
+    /**
+     * Parse this NSID into components (and sub-components, if dot delimited).
+     *
+     * @returns parsed
+     */
+    static parse(nsid) {
+        const m = nsid.match(/^([^:]+):([^/]+)\/([^|]+)\|?(.*)$/);
+        if (!m) {
+            return undefined;
+        }
+        return {
+            nsid: nsid,
+            type: m[1].split("."),
+            source: m[2].split("."),
+            name: m[3].split("."),
+            extra: m[4].length > 0 ? m[4] : undefined,
+        };
+    }
+}
+exports.NSID = NSID;

package/build/cjs/shuffle/shuffle.d.ts

@@ -0,0 +1,4 @@
+export declare class Shuffle {
+    static shuffle<T>(items: T[]): T[];
+    static choice<T>(items: T[]): T;
+}

package/build/cjs/shuffle/shuffle.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Shuffle = void 0;
+class Shuffle {
+    static shuffle(items) {
+        // Fisher-Yates
+        for (let i = items.length - 1; i > 0; i--) {
+            let j = Math.floor(Math.random() * (i + 1));
+            [items[i], items[j]] = [items[j], items[i]];
+        }
+        return items;
+    }
+    static choice(items) {
+        return items[Math.floor(Math.random() * items.length)];
+    }
+}
+exports.Shuffle = Shuffle;

package/build/cjs/spawn/spawn.d.ts

@@ -0,0 +1,12 @@
+import { GameObject, Vector } from "@tabletop-playground/api";
+/**
+ * Registry for NSID to template id.
+ */
+export declare abstract class Spawn {
+    private static _nsidToTemplateId;
+    static spawn(nsid: string, position: Vector | [x: number, y: number, z: number]): GameObject | undefined;
+    static inject(dict: {
+        [key: string]: string;
+    }): void;
+    static validate(): void;
+}

package/build/cjs/spawn/spawn.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Spawn = void 0;
+const api_1 = require("@tabletop-playground/api");
+/**
+ * Registry for NSID to template id.
+ */
+class Spawn {
+    static spawn(nsid, position) {
+        const templateId = Spawn._nsidToTemplateId[nsid];
+        if (!templateId) {
+            throw new Error(`spawn nsid "${nsid}" has no templateId`);
+        }
+        const obj = api_1.world.createObjectFromTemplate(templateId, position);
+        return obj;
+    }
+    static inject(dict) {
+        for (const [k, v] of Object.entries(dict)) {
+            Spawn._nsidToTemplateId[k] = v;
+        }
+    }
+    static validate() {
+        const templateIds = new Set();
+        for (const pkg of api_1.world.getAllowedPackages()) {
+            for (const templateId of pkg.getTemplateIds()) {
+                templateIds.add(templateId);
+            }
+        }
+        const missing = [];
+        for (const [nsid, templateId] of Object.entries(Spawn._nsidToTemplateId)) {
+            if (!templateIds.has(templateId)) {
+                missing.push(`${templateId} ("${nsid}")`);
+            }
+        }
+        if (missing.length > 0) {
+            throw new Error(`Spawn.validate missing templateIds (${missing.length}):\n` +
+                missing.join("\n"));
+        }
+    }
+}
+exports.Spawn = Spawn;
+Spawn._nsidToTemplateId = {};

package/build/cjs/triggerable-multicast-delegate/triggerable-multicast-delegate.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Lookalike for TTPG's MulticastDelegate, but with a trigger method.
+ */
+export declare class TriggerableMulticastDelegate<T> {
+    private readonly _listeners;
+    /**
+     * Add a function to the trigger set.
+     *
+     * @param fn
+     */
+    add(fn: T): void;
+    /**
+     * Remove a function from the trigger set.
+     *
+     * @param fn
+     */
+    remove(fn: T): void;
+    /**
+     * Clear the trigger set.
+     */
+    clear(): void;
+    /**
+     * Call every function in the trigger set.
+     *
+     * Call every function even if one throws, raise gathered errors at end.
+     *
+     * @param args
+     */
+    trigger(...args: any): void;
+}

package/build/cjs/triggerable-multicast-delegate/triggerable-multicast-delegate.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerableMulticastDelegate = void 0;
+/**
+ * Lookalike for TTPG's MulticastDelegate, but with a trigger method.
+ */
+class TriggerableMulticastDelegate {
+    constructor() {
+        this._listeners = [];
+    }
+    /**
+     * Add a function to the trigger set.
+     *
+     * @param fn
+     */
+    add(fn) {
+        this._listeners.push(fn);
+    }
+    /**
+     * Remove a function from the trigger set.
+     *
+     * @param fn
+     */
+    remove(fn) {
+        for (let i = this._listeners.length - 1; i >= 0; i--) {
+            if (this._listeners[i] === fn) {
+                this._listeners.splice(i, 1);
+            }
+        }
+    }
+    /**
+     * Clear the trigger set.
+     */
+    clear() {
+        this._listeners.splice(0);
+    }
+    /**
+     * Call every function in the trigger set.
+     *
+     * Call every function even if one throws, raise gathered errors at end.
+     *
+     * @param args
+     */
+    trigger(...args) {
+        const errors = [];
+        for (const fn of this._listeners) {
+            try {
+                if (typeof fn === "function") {
+                    fn(...args);
+                }
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    errors.push(e);
+                }
+            }
+        }
+        if (errors.length === 1) {
+            throw errors[0];
+        }
+        else if (errors.length > 1) {
+            const message = `ERRORS (${errors.length}):\n` +
+                errors.map((e) => e.message).join("\n");
+            const stack = errors
+                .map((e) => `-----\n${e.stack ? e.stack : "N/A"}`)
+                .join("\n");
+            const error = new Error(message);
+            error.stack = stack;
+            throw error;
+        }
+    }
+}
+exports.TriggerableMulticastDelegate = TriggerableMulticastDelegate;

package/build/cjs/vault/vault.d.ts

@@ -0,0 +1,8 @@
+export declare class Vault {
+    private readonly _uid;
+    constructor(uid: string);
+    clear(): void;
+    delete(key: string): void;
+    put(key: string, value: string): void;
+    get(key: string): string | undefined;
+}

package/build/cjs/vault/vault.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vault = void 0;
+class Vault {
+    constructor(uid) {
+        this._uid = uid;
+    }
+    clear() { }
+    delete(key) { }
+    put(key, value) { }
+    get(key) {
+        return undefined;
+    }
+}
+exports.Vault = Vault;

package/build/esm/hello.js

@@ -0,0 +1,2 @@
+"use strict";
+console.log("hello");

package/build/esm/layout/layout-objects.d.ts

@@ -0,0 +1,36 @@
+import { StaticObject, Vector } from "@tabletop-playground/api";
+export type LayoutObjectsSize = {
+    w: number;
+    h: number;
+};
+export declare class LayoutObjects {
+    private _children;
+    private _horizontalAlignment;
+    private _verticalAlignment;
+    private _childDistance;
+    private _isVertical;
+    private _overrideHeight;
+    private _overrideWidth;
+    constructor();
+    setChildDistanace(value: number): this;
+    setHorizontalAlignment(value: number): this;
+    setVerticalAlignment(value: number): this;
+    setIsVertical(value: boolean): this;
+    setOverrideHeight(value: number): this;
+    setOverrideWidth(value: number): this;
+    add(item: StaticObject | LayoutObjects): this;
+    /**
+     * Get size of self, applying any overrides.
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateSize(): LayoutObjectsSize;
+    /**
+     * Get size from laying out children (ignore override on self).
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateChildrenSize(): LayoutObjectsSize;
+    _calculateChildSize(child: StaticObject | LayoutObjects): LayoutObjectsSize;
+    doLayoutAtPoint(center: Vector, yaw: number): this;
+}

package/build/esm/layout/layout-objects.js

@@ -0,0 +1,147 @@
+import { HorizontalAlignment, StaticObject, Vector, VerticalAlignment, } from "@tabletop-playground/api";
+export class LayoutObjects {
+    constructor() {
+        this._children = [];
+        this._horizontalAlignment = HorizontalAlignment.Center;
+        this._verticalAlignment = VerticalAlignment.Center;
+        this._childDistance = 0;
+        this._isVertical = false;
+        this._overrideHeight = 0;
+        this._overrideWidth = 0;
+    }
+    setChildDistanace(value) {
+        this._childDistance = value;
+        return this;
+    }
+    setHorizontalAlignment(value) {
+        this._horizontalAlignment = value;
+        return this;
+    }
+    setVerticalAlignment(value) {
+        this._verticalAlignment = value;
+        return this;
+    }
+    setIsVertical(value) {
+        this._isVertical = value;
+        return this;
+    }
+    setOverrideHeight(value) {
+        this._overrideHeight = value;
+        return this;
+    }
+    setOverrideWidth(value) {
+        this._overrideWidth = value;
+        return this;
+    }
+    // ----------------------------------
+    add(item) {
+        this._children.push(item);
+        return this;
+    }
+    /**
+     * Get size of self, applying any overrides.
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateSize() {
+        let size = this.calculateChildrenSize();
+        if (this._overrideHeight > 0) {
+            size.h = this._overrideHeight;
+        }
+        if (this._overrideWidth > 0) {
+            size.w = this._overrideWidth;
+        }
+        return size;
+    }
+    /**
+     * Get size from laying out children (ignore override on self).
+     *
+     * @returns {LayoutObjectsSize}
+     */
+    calculateChildrenSize() {
+        const size = { w: 0, h: 0 };
+        // Account for child distance.
+        const spacing = Math.max(this._children.length - 1, 0) * this._childDistance;
+        if (this._isVertical) {
+            size.h = spacing;
+        }
+        else {
+            size.w = spacing;
+        }
+        // Apply each child.
+        for (const child of this._children) {
+            const childSize = this._calculateChildSize(child);
+            if (this._isVertical) {
+                size.w = Math.max(size.w, childSize.w);
+                size.h += childSize.h;
+            }
+            else {
+                size.h = Math.max(size.h, childSize.h);
+                size.w += childSize.w;
+            }
+        }
+        return size;
+    }
+    _calculateChildSize(child) {
+        let childSize;
+        if (child instanceof StaticObject) {
+            const currentRotation = true;
+            const includeGeometry = false;
+            const extent = child.getExtent(currentRotation, includeGeometry);
+            childSize = { w: extent.y * 2, h: extent.x * 2 };
+        }
+        else {
+            childSize = child.calculateSize();
+        }
+        return childSize;
+    }
+    doLayoutAtPoint(center, yaw) {
+        const size = this.calculateSize();
+        const childrenSize = this.calculateChildrenSize();
+        let padLeft;
+        if (this._horizontalAlignment === HorizontalAlignment.Left) {
+            padLeft = 0;
+        }
+        else if (this._horizontalAlignment === HorizontalAlignment.Right) {
+            padLeft = size.w - childrenSize.w;
+        }
+        else {
+            padLeft = (size.w - childrenSize.w) / 2; // center (even if "Fill")
+        }
+        let padTop;
+        if (this._verticalAlignment === VerticalAlignment.Top) {
+            padTop = 0;
+        }
+        else if (this._verticalAlignment === VerticalAlignment.Bottom) {
+            padTop = size.w - childrenSize.w;
+        }
+        else {
+            padTop = (size.w - childrenSize.w) / 2; // center (even if "Fill")
+        }
+        let left = -size.w / 2 + padLeft;
+        let top = -size.h / 2 + padTop;
+        for (const child of this._children) {
+            const childSize = this._calculateChildSize(child);
+            // Calculate child center (world).
+            const childCenter = new Vector(top + childSize.h / 2, left + childSize.w / 2, 0)
+                .rotateAngleAxis(yaw, [0, 0, 1])
+                .add(center);
+            // Position child.
+            if (child instanceof StaticObject) {
+                child.setPosition(childCenter);
+                child.setRotation(child.getRotation().compose([0, yaw, 0]));
+            }
+            else {
+                child.doLayoutAtPoint(childCenter, yaw);
+            }
+            // Move "cursor" to next open spot top-left.
+            if (this._isVertical) {
+                top += childSize.h + this._childDistance;
+            }
+            else {
+                left += childSize.w + this._childDistance;
+            }
+        }
+        return this;
+    }
+}

package/build/esm/layout/layout.d.ts

@@ -0,0 +1,8 @@
+import { GameObject } from "@tabletop-playground/api";
+export declare class Layout {
+    private _anchorX;
+    private _anchorY;
+    getWidth(): number;
+    getHeight(): number;
+    add(obj: GameObject, weight?: number): void;
+}

package/build/esm/layout/layout.js

@@ -0,0 +1,13 @@
+export class Layout {
+    constructor() {
+        this._anchorX = 0.5;
+        this._anchorY = 0.5;
+    }
+    getWidth() {
+        return 0;
+    }
+    getHeight() {
+        return 0;
+    }
+    add(obj, weight = 0) { }
+}

package/build/esm/locale/locale.d.ts

@@ -0,0 +1,8 @@
+export declare const locale: {
+    (key: string, replacement?: {
+        [key: string]: string | number;
+    } | undefined): string;
+    inject(dict: {
+        [key: string]: string;
+    }): void;
+};

package/build/esm/locale/locale.js

@@ -0,0 +1,40 @@
+const REPLACE_REGEX = /(?<!\\){(?!#)(.*?)(?<!\\)}/gm;
+const PLURAL_REGEX = /(?<!\\){#(.*?)(?<!\\)}/gm;
+const PLURAL_SEPERATOR = /(?<!\\)\|/gm;
+const _lang = {};
+// Original author: ThatRobHuman
+export const locale = (key, replacement = undefined) => {
+    const str = _lang[key];
+    if (!str) {
+        return key; // not registered, use key as stand-in
+    }
+    else if (!replacement) {
+        return str; // no need for regex
+    }
+    return str
+        .replace(REPLACE_REGEX, (match) => {
+        const r = replacement[match.substring(1, match.length - 1)].toString();
+        if (r === undefined) {
+            return match;
+        }
+        return r;
+    })
+        .replace(PLURAL_REGEX, (match) => {
+        const [val, singular, plural, zeroForm] = match
+            .substring(2, match.length - 1)
+            .split(PLURAL_SEPERATOR);
+        const num = Number(replacement[val]);
+        if (isNaN(num) || num === 0) {
+            return zeroForm || plural;
+        }
+        if (num > 1) {
+            return plural;
+        }
+        return singular;
+    });
+};
+locale.inject = (dict) => {
+    for (const [k, v] of Object.entries(dict)) {
+        _lang[k] = v;
+    }
+};

package/build/esm/nsid/nsid.d.ts

@@ -0,0 +1,54 @@
+import { Card, StaticObject } from "@tabletop-playground/api";
+export type ParsedNSID = {
+    nsid: string;
+    type: string[];
+    source: string[];
+    name: string[];
+    extra: string | undefined;
+};
+export declare const DECK_NSID = "deck:?/?";
+/**
+ * Object metadata field uses a simple "type:source/name|extra" string.
+ *
+ * Each component is a dot (".") delimited series of strings.
+ *
+ * TYPE delineates the hierarchy to the specific object type.  Entries should
+ * start generic and get more specific, for instance "card.action" is a card
+ * from the action deck.  The TYPE field should be sufficient to locate where
+ * the item belongs, in some cases augment with owning player slot.
+ *
+ * SOURCE is the produce/release with the item.  For instance, "base" could
+ * mean the base game, or use an official expansion name.  Recommend homebrew
+ * always start with "homebrew.{x}" where {x} is the identifier (to avoid
+ * confusion with canon content sources).
+ *
+ * NAME is the item name.  It may include dot-delimited discriminators for
+ * different versions of the same item (e.g. "direct_hit.1" vs "direct_hit.2").
+ *
+ * EXTRA should be avoided, there may be rare cases wanting fruther metadata.
+ *
+ * @see https://github.com/TI4-Online/TI4-TTPG/wiki/NSID-Namespace
+ */
+export declare abstract class NSID {
+    /**
+     * Create NSID from a metadata string or object.  A deck with multiple cards
+     * gets a special "deck" NSID, consumers should call `stack` to get by card.
+     *
+     * @param input
+     * @returns NSID string
+     */
+    static get(input: StaticObject): string;
+    /**
+     * Get NSIDs for each card in a deck.
+     *
+     * @param input deck
+     * @returns NSID array, per-card values
+     */
+    static getDeck(input: Card): string[];
+    /**
+     * Parse this NSID into components (and sub-components, if dot delimited).
+     *
+     * @returns parsed
+     */
+    static parse(nsid: string): ParsedNSID | undefined;
+}

package/build/esm/nsid/nsid.js

@@ -0,0 +1,80 @@
+import { Card, StaticObject } from "@tabletop-playground/api";
+export const DECK_NSID = "deck:?/?";
+/**
+ * Object metadata field uses a simple "type:source/name|extra" string.
+ *
+ * Each component is a dot (".") delimited series of strings.
+ *
+ * TYPE delineates the hierarchy to the specific object type.  Entries should
+ * start generic and get more specific, for instance "card.action" is a card
+ * from the action deck.  The TYPE field should be sufficient to locate where
+ * the item belongs, in some cases augment with owning player slot.
+ *
+ * SOURCE is the produce/release with the item.  For instance, "base" could
+ * mean the base game, or use an official expansion name.  Recommend homebrew
+ * always start with "homebrew.{x}" where {x} is the identifier (to avoid
+ * confusion with canon content sources).
+ *
+ * NAME is the item name.  It may include dot-delimited discriminators for
+ * different versions of the same item (e.g. "direct_hit.1" vs "direct_hit.2").
+ *
+ * EXTRA should be avoided, there may be rare cases wanting fruther metadata.
+ *
+ * @see https://github.com/TI4-Online/TI4-TTPG/wiki/NSID-Namespace
+ */
+export class NSID {
+    /**
+     * Create NSID from a metadata string or object.  A deck with multiple cards
+     * gets a special "deck" NSID, consumers should call `stack` to get by card.
+     *
+     * @param input
+     * @returns NSID string
+     */
+    static get(input) {
+        let metadata = "";
+        if (input instanceof Card) {
+            if (input.getStackSize() === 1) {
+                // Singleton card: use the card metadata.
+                metadata = input.getCardDetails().metadata;
+            }
+            else {
+                // Deck: do not attempt to extract more here.
+                metadata = DECK_NSID;
+            }
+        }
+        else if (input instanceof StaticObject) {
+            // Non-card table or game object.  Use template metadata.
+            metadata = input.getTemplateMetadata();
+        }
+        return metadata;
+    }
+    /**
+     * Get NSIDs for each card in a deck.
+     *
+     * @param input deck
+     * @returns NSID array, per-card values
+     */
+    static getDeck(input) {
+        return input.getAllCardDetails().map((cardDetails) => {
+            return cardDetails.metadata;
+        });
+    }
+    /**
+     * Parse this NSID into components (and sub-components, if dot delimited).
+     *
+     * @returns parsed
+     */
+    static parse(nsid) {
+        const m = nsid.match(/^([^:]+):([^/]+)\/([^|]+)\|?(.*)$/);
+        if (!m) {
+            return undefined;
+        }
+        return {
+            nsid: nsid,
+            type: m[1].split("."),
+            source: m[2].split("."),
+            name: m[3].split("."),
+            extra: m[4].length > 0 ? m[4] : undefined,
+        };
+    }
+}

package/build/esm/shuffle/shuffle.d.ts

@@ -0,0 +1,4 @@
+export declare class Shuffle {
+    static shuffle<T>(items: T[]): T[];
+    static choice<T>(items: T[]): T;
+}

package/build/esm/shuffle/shuffle.js

@@ -0,0 +1,13 @@
+export class Shuffle {
+    static shuffle(items) {
+        // Fisher-Yates
+        for (let i = items.length - 1; i > 0; i--) {
+            let j = Math.floor(Math.random() * (i + 1));
+            [items[i], items[j]] = [items[j], items[i]];
+        }
+        return items;
+    }
+    static choice(items) {
+        return items[Math.floor(Math.random() * items.length)];
+    }
+}

package/build/esm/spawn/spawn.d.ts

@@ -0,0 +1,12 @@
+import { GameObject, Vector } from "@tabletop-playground/api";
+/**
+ * Registry for NSID to template id.
+ */
+export declare abstract class Spawn {
+    private static _nsidToTemplateId;
+    static spawn(nsid: string, position: Vector | [x: number, y: number, z: number]): GameObject | undefined;
+    static inject(dict: {
+        [key: string]: string;
+    }): void;
+    static validate(): void;
+}

package/build/esm/spawn/spawn.js

@@ -0,0 +1,38 @@
+import { world } from "@tabletop-playground/api";
+/**
+ * Registry for NSID to template id.
+ */
+export class Spawn {
+    static spawn(nsid, position) {
+        const templateId = Spawn._nsidToTemplateId[nsid];
+        if (!templateId) {
+            throw new Error(`spawn nsid "${nsid}" has no templateId`);
+        }
+        const obj = world.createObjectFromTemplate(templateId, position);
+        return obj;
+    }
+    static inject(dict) {
+        for (const [k, v] of Object.entries(dict)) {
+            Spawn._nsidToTemplateId[k] = v;
+        }
+    }
+    static validate() {
+        const templateIds = new Set();
+        for (const pkg of world.getAllowedPackages()) {
+            for (const templateId of pkg.getTemplateIds()) {
+                templateIds.add(templateId);
+            }
+        }
+        const missing = [];
+        for (const [nsid, templateId] of Object.entries(Spawn._nsidToTemplateId)) {
+            if (!templateIds.has(templateId)) {
+                missing.push(`${templateId} ("${nsid}")`);
+            }
+        }
+        if (missing.length > 0) {
+            throw new Error(`Spawn.validate missing templateIds (${missing.length}):\n` +
+                missing.join("\n"));
+        }
+    }
+}
+Spawn._nsidToTemplateId = {};

package/build/esm/triggerable-multicast-delegate/triggerable-multicast-delegate.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Lookalike for TTPG's MulticastDelegate, but with a trigger method.
+ */
+export declare class TriggerableMulticastDelegate<T> {
+    private readonly _listeners;
+    /**
+     * Add a function to the trigger set.
+     *
+     * @param fn
+     */
+    add(fn: T): void;
+    /**
+     * Remove a function from the trigger set.
+     *
+     * @param fn
+     */
+    remove(fn: T): void;
+    /**
+     * Clear the trigger set.
+     */
+    clear(): void;
+    /**
+     * Call every function in the trigger set.
+     *
+     * Call every function even if one throws, raise gathered errors at end.
+     *
+     * @param args
+     */
+    trigger(...args: any): void;
+}

package/build/esm/triggerable-multicast-delegate/triggerable-multicast-delegate.js

@@ -0,0 +1,69 @@
+/**
+ * Lookalike for TTPG's MulticastDelegate, but with a trigger method.
+ */
+export class TriggerableMulticastDelegate {
+    constructor() {
+        this._listeners = [];
+    }
+    /**
+     * Add a function to the trigger set.
+     *
+     * @param fn
+     */
+    add(fn) {
+        this._listeners.push(fn);
+    }
+    /**
+     * Remove a function from the trigger set.
+     *
+     * @param fn
+     */
+    remove(fn) {
+        for (let i = this._listeners.length - 1; i >= 0; i--) {
+            if (this._listeners[i] === fn) {
+                this._listeners.splice(i, 1);
+            }
+        }
+    }
+    /**
+     * Clear the trigger set.
+     */
+    clear() {
+        this._listeners.splice(0);
+    }
+    /**
+     * Call every function in the trigger set.
+     *
+     * Call every function even if one throws, raise gathered errors at end.
+     *
+     * @param args
+     */
+    trigger(...args) {
+        const errors = [];
+        for (const fn of this._listeners) {
+            try {
+                if (typeof fn === "function") {
+                    fn(...args);
+                }
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    errors.push(e);
+                }
+            }
+        }
+        if (errors.length === 1) {
+            throw errors[0];
+        }
+        else if (errors.length > 1) {
+            const message = `ERRORS (${errors.length}):\n` +
+                errors.map((e) => e.message).join("\n");
+            const stack = errors
+                .map((e) => `-----\n${e.stack ? e.stack : "N/A"}`)
+                .join("\n");
+            const error = new Error(message);
+            error.stack = stack;
+            throw error;
+        }
+    }
+}

package/build/esm/vault/vault.d.ts

@@ -0,0 +1,8 @@
+export declare class Vault {
+    private readonly _uid;
+    constructor(uid: string);
+    clear(): void;
+    delete(key: string): void;
+    put(key: string, value: string): void;
+    get(key: string): string | undefined;
+}

package/build/esm/vault/vault.js

@@ -0,0 +1,11 @@
+export class Vault {
+    constructor(uid) {
+        this._uid = uid;
+    }
+    clear() { }
+    delete(key) { }
+    put(key, value) { }
+    get(key) {
+        return undefined;
+    }
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "ttpg-darrell",
+  "version": "1.0.0",
+  "description": "TTPG TypeScript library",
+  "main": "./build/cjs/index.js",
+  "module": "./build/esm/index.js",
+  "files": [
+    "build/"
+  ],
+  "scripts": {
+    "test": "jest",
+    "build": "tsc -p tsconfig-esm.json && tsc -p tsconfig-cjs.json",
+    "prepublishOnly": "yarn run build"
+  },
+  "author": "Darrell",
+  "license": "Unlicense",
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.5.10",
+    "@types/klaw-sync": "^6.0.5",
+    "@types/node": "^20.10.0",
+    "@types/yargs": "^17.0.32",
+    "fs-extra": "^11.2.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "klaw-sync": "^6.0.0",
+    "node": "^21.2.0",
+    "sharp": "^0.32.6",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "ttpg-mock": "^1.0.7",
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {
+    "@tabletop-playground/api": "^0.39.0"
+  }
+}