@doodle-engine/core 0.0.1

package/dist/types/snapshot.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Snapshot type definitions for the Doodle Engine.
+ * A snapshot is a point-in-time view of the game state formatted for rendering.
+ * The renderer displays snapshots but never sees raw game state.
+ */
+import type { Time } from './state';
+/**
+ * Location information in a snapshot (localized).
+ */
+export interface SnapshotLocation {
+    /** Location ID */
+    id: string;
+    /** Localized display name */
+    name: string;
+    /** Localized description text */
+    description: string;
+    /** Banner image filename */
+    banner: string;
+}
+/**
+ * Character information in a snapshot (localized).
+ */
+export interface SnapshotCharacter {
+    /** Character ID */
+    id: string;
+    /** Localized display name */
+    name: string;
+    /** Localized biography text */
+    biography: string;
+    /** Portrait image filename */
+    portrait: string;
+    /** Current location ID */
+    location: string;
+    /** Whether this character is in the party */
+    inParty: boolean;
+    /** Relationship value with the player */
+    relationship: number;
+    /** Character stats */
+    stats: Record<string, unknown>;
+}
+/**
+ * Item information in a snapshot (localized).
+ */
+export interface SnapshotItem {
+    /** Item ID */
+    id: string;
+    /** Localized display name */
+    name: string;
+    /** Localized description text */
+    description: string;
+    /** Icon image filename */
+    icon: string;
+    /** Large image filename */
+    image: string;
+    /** Item stats */
+    stats: Record<string, unknown>;
+}
+/**
+ * A player choice in a dialogue (localized).
+ */
+export interface SnapshotChoice {
+    /** Choice ID */
+    id: string;
+    /** Localized choice text */
+    text: string;
+}
+/**
+ * Current dialogue node information (localized).
+ */
+export interface SnapshotDialogue {
+    /** Character ID speaking, or null for narration */
+    speaker: string | null;
+    /** Localized speaker name (or "Narrator") */
+    speakerName: string;
+    /** Localized dialogue text */
+    text: string;
+    /** Portrait image filename (if speaker is a character) */
+    portrait?: string;
+    /** Voice audio filename (optional) */
+    voice?: string;
+}
+/**
+ * Quest information in a snapshot (localized).
+ */
+export interface SnapshotQuest {
+    /** Quest ID */
+    id: string;
+    /** Localized quest name */
+    name: string;
+    /** Localized quest description */
+    description: string;
+    /** Current stage ID */
+    currentStage: string;
+    /** Localized current stage description */
+    currentStageDescription: string;
+}
+/**
+ * Journal entry information in a snapshot (localized).
+ */
+export interface SnapshotJournalEntry {
+    /** Entry ID */
+    id: string;
+    /** Localized entry title */
+    title: string;
+    /** Localized entry text */
+    text: string;
+    /** Entry category */
+    category: string;
+}
+/**
+ * Map location marker in a snapshot (localized).
+ */
+export interface SnapshotMapLocation {
+    /** Location ID */
+    id: string;
+    /** Localized location name */
+    name: string;
+    /** X coordinate on map */
+    x: number;
+    /** Y coordinate on map */
+    y: number;
+    /** Whether this is the player's current location */
+    isCurrent: boolean;
+}
+/**
+ * Map information in a snapshot (localized).
+ */
+export interface SnapshotMap {
+    /** Map ID */
+    id: string;
+    /** Localized map name */
+    name: string;
+    /** Map image filename */
+    image: string;
+    /** Map scale for travel time calculation */
+    scale: number;
+    /** Locations on this map */
+    locations: SnapshotMapLocation[];
+}
+/**
+ * A snapshot represents everything the renderer needs to display the current moment.
+ * All localization has been resolved, all conditions have been evaluated.
+ * The renderer never sees raw game state, content registry, or localization keys.
+ */
+export interface Snapshot {
+    /** Current location information */
+    location: SnapshotLocation;
+    /** Characters at the current location */
+    charactersHere: SnapshotCharacter[];
+    /** Items at the current location (not in inventory) */
+    itemsHere: SnapshotItem[];
+    /** Available dialogue choices (only if in dialogue) */
+    choices: SnapshotChoice[];
+    /** Current dialogue node (null if not in dialogue) */
+    dialogue: SnapshotDialogue | null;
+    /** Characters in the player's party */
+    party: SnapshotCharacter[];
+    /** Items in the player's inventory */
+    inventory: SnapshotItem[];
+    /** Active quests with current stages */
+    quests: SnapshotQuest[];
+    /** Unlocked journal entries */
+    journal: SnapshotJournalEntry[];
+    /** Game variables (gold, counters, etc.) */
+    variables: Record<string, number | string>;
+    /** Current in-game time */
+    time: Time;
+    /** Map data (null if map is disabled) */
+    map: SnapshotMap | null;
+    /** Current music track filename */
+    music: string;
+    /** Current ambient sound filename */
+    ambient: string;
+    /** Notifications to display (cleared after shown) */
+    notifications: string[];
+    /** Sound effects to play (from recent playSound effects) */
+    pendingSounds: string[];
+    /** Video to play fullscreen (from playVideo effect) */
+    pendingVideo: string | null;
+}
+//# sourceMappingURL=snapshot.d.ts.map

package/dist/types/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/types/snapshot.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,OAAO,EAAE,OAAO,CAAA;IAChB,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,cAAc;IACd,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gBAAgB;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,eAAe;IACf,EAAE,EAAE,MAAM,CAAA;IACV,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,uBAAuB;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,0CAA0C;IAC1C,uBAAuB,EAAE,MAAM,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,eAAe;IACf,EAAE,EAAE,MAAM,CAAA;IACV,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,CAAC,EAAE,MAAM,CAAA;IACT,0BAA0B;IAC1B,CAAC,EAAE,MAAM,CAAA;IACT,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,aAAa;IACb,EAAE,EAAE,MAAM,CAAA;IACV,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAA;IACb,4BAA4B;IAC5B,SAAS,EAAE,mBAAmB,EAAE,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,mCAAmC;IACnC,QAAQ,EAAE,gBAAgB,CAAA;IAE1B,yCAAyC;IACzC,cAAc,EAAE,iBAAiB,EAAE,CAAA;IAEnC,uDAAuD;IACvD,SAAS,EAAE,YAAY,EAAE,CAAA;IAEzB,uDAAuD;IACvD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB,sDAAsD;IACtD,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAEjC,uCAAuC;IACvC,KAAK,EAAE,iBAAiB,EAAE,CAAA;IAE1B,sCAAsC;IACtC,SAAS,EAAE,YAAY,EAAE,CAAA;IAEzB,wCAAwC;IACxC,MAAM,EAAE,aAAa,EAAE,CAAA;IAEvB,+BAA+B;IAC/B,OAAO,EAAE,oBAAoB,EAAE,CAAA;IAE/B,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA;IAE1C,2BAA2B;IAC3B,IAAI,EAAE,IAAI,CAAA;IAEV,yCAAyC;IACzC,GAAG,EAAE,WAAW,GAAG,IAAI,CAAA;IAEvB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAA;IAEf,qDAAqD;IACrD,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,4DAA4D;IAC5D,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,uDAAuD;IACvD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B"}

package/dist/types/state.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Game state type definitions for the Doodle Engine.
+ * These represent all mutable data that changes during gameplay.
+ */
+/**
+ * In-game time representation.
+ */
+export interface Time {
+    /** Current day number (1-based) */
+    day: number;
+    /** Current hour (0-23) */
+    hour: number;
+}
+/**
+ * Mutable state for a single character.
+ */
+export interface CharacterState {
+    /** Current location ID where this character is */
+    location: string;
+    /** Whether this character is traveling with the player */
+    inParty: boolean;
+    /** Disposition value toward the player */
+    relationship: number;
+    /** Extensible stats object - engine stores but doesn't interpret */
+    stats: Record<string, unknown>;
+}
+/**
+ * Current dialogue state.
+ */
+export interface DialogueState {
+    /** ID of the active dialogue */
+    dialogueId: string;
+    /** ID of the current node in that dialogue */
+    nodeId: string;
+}
+/**
+ * A note written by the player.
+ */
+export interface PlayerNote {
+    /** Unique ID for this note */
+    id: string;
+    /** Note title */
+    title: string;
+    /** Note content */
+    text: string;
+}
+/**
+ * Complete game state - everything that changes during play.
+ * This is what gets saved and loaded.
+ */
+export interface GameState {
+    /** Location ID where the player currently is */
+    currentLocation: string;
+    /** Current in-game time */
+    currentTime: Time;
+    /** True/false values for story tracking */
+    flags: Record<string, boolean>;
+    /** Numbers or strings for quantities, names, etc. */
+    variables: Record<string, number | string>;
+    /** Item IDs the player is carrying */
+    inventory: string[];
+    /** Current stage for each started quest (questId -> stageId) */
+    questProgress: Record<string, string>;
+    /** Journal entry IDs that have been unlocked */
+    unlockedJournalEntries: string[];
+    /** Notes the player has written */
+    playerNotes: PlayerNote[];
+    /** Current conversation state, or null if not in dialogue */
+    dialogueState: DialogueState | null;
+    /** All mutable character data (characterId -> CharacterState) */
+    characterState: Record<string, CharacterState>;
+    /** Current location of each item (itemId -> locationId or "inventory") */
+    itemLocations: Record<string, string>;
+    /** Whether the player can open the map */
+    mapEnabled: boolean;
+    /** Recent events to show the player (cleared after shown) */
+    notifications: string[];
+    /** Sound effects to play (cleared after snapshot is built) */
+    pendingSounds: string[];
+    /** Video to play (cleared after snapshot is built) */
+    pendingVideo: string | null;
+    /** Active language code (e.g., "en", "es") */
+    currentLocale: string;
+}
+//# sourceMappingURL=state.d.ts.map

package/dist/types/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/types/state.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,OAAO,EAAE,OAAO,CAAA;IAChB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAA;IACpB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,gDAAgD;IAChD,eAAe,EAAE,MAAM,CAAA;IAEvB,2BAA2B;IAC3B,WAAW,EAAE,IAAI,CAAA;IAEjB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE9B,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA;IAE1C,sCAAsC;IACtC,SAAS,EAAE,MAAM,EAAE,CAAA;IAEnB,gEAAgE;IAChE,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAErC,gDAAgD;IAChD,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAEhC,mCAAmC;IACnC,WAAW,EAAE,UAAU,EAAE,CAAA;IAEzB,6DAA6D;IAC7D,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;IAEnC,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAE9C,0EAA0E;IAC1E,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAErC,0CAA0C;IAC1C,UAAU,EAAE,OAAO,CAAA;IAEnB,6DAA6D;IAC7D,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,sDAAsD;IACtD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAA;CACtB"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@doodle-engine/core",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "./dist/core.cjs",
+  "module": "./dist/core.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/core.js",
+      "require": "./dist/core.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "vite build && tsc -p tsconfig.json",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0",
+    "vitest": "^2.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/katbella/doodle-engine.git",
+    "directory": "packages/core"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  }
+}