narrat 2.0.10 → 2.0.11

package/dist/config.d.ts

@@ -1,151 +1,158 @@
-export declare function setConfig(conf: Config): void;
-export declare function getConfig(): Config;
-export declare function getSkillConfig(id: string): SkillData;
-export declare function getItemConfig(id: string): ItemData;
-export declare function getQuestConfig(questId: string): QuestData;
-export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
-export interface AppOptions {
-    logging: boolean;
-    debug: boolean;
-}
-export interface Config {
-    gameTitle: string;
-    images: {
-        [key: string]: string;
-    };
-    layout: {
-        backgrounds: {
-            width: number;
-            height: number;
-        };
-        dialogBottomPadding: number;
-        minTextWidth: number;
-        mobileDialogHeightPercentage: number;
-        verticalLayoutThreshold: number;
-        portraits: {
-            width: number;
-            height: number;
-        };
-    };
-    screens: {
-        [key: string]: {
-            background: string;
-            buttons: string[];
-        };
-    };
-    buttons: {
-        [key: string]: ButtonConfig;
-    };
-    skills: {
-        [key: string]: SkillData;
-    };
-    skillOptions: {
-        xpPerLevel: number;
-    };
-    skillChecks: {
-        rollRange: number;
-        skillMultiplier: number;
-        failureChance: number;
-        difficultyText: Array<[number, string]>;
-    };
-    scripts: string[];
-    audio: {
-        [key: string]: AudioConfig;
-    };
-    audioOptions: {
-        volume: number;
-        defaultMusic?: string;
-        musicFadeInTime: number;
-        musicFadeInDelay: number;
-        musicFadeOutTime: number;
-    };
-    sound?: {
-        [key: string]: AudioConfig;
-    };
-    music?: {
-        [key: string]: AudioConfig;
-    };
-    notifications: {
-        timeOnScreen: number;
-        alsoPrintInDialogue?: boolean;
-    };
-    hudStats: {
-        [key: string]: HudStatConfig;
-    };
-    items: {
-        [key: string]: ItemData;
-    };
-    interactionTags: {
-        [key: string]: {
-            onlyInteractOutsideOfScripts: boolean;
-        };
-    };
-    quests: {
-        [key: string]: QuestData;
-    };
-    audioTriggers: {
-        [key: string]: string;
-    };
-    menuButtons: {
-        [key: string]: MenuButtonData;
-    };
-}
-export interface MenuButtonData {
-    text: string;
-}
-export interface QuestData {
-    title: string;
-    description: string;
-    objectives: {
-        [key: string]: ObjectiveData;
-    };
-}
-export interface ObjectiveData {
-    description: string;
-    hidden?: boolean;
-}
-export interface ItemData {
-    name: string;
-    description: string;
-    icon: string;
-    onUse?: {
-        action: 'jump' | 'run';
-        label: string;
-    };
-    tag?: string;
-}
-export interface HudStatConfig {
-    name: string;
-    icon: string;
-    startingValue: number;
-    minValue?: number;
-    maxValue?: number;
-}
-export interface AudioConfig {
-    src: string;
-    path?: string;
-    volume?: number;
-    rate?: number;
-    html5?: boolean;
-}
-export interface MusicConfig extends AudioConfig {
-    loop?: boolean;
-}
-export interface ButtonConfig {
-    enabled: boolean;
-    background: string;
-    position: {
-        left: number;
-        top: number;
-        width: number;
-        height: number;
-    };
-    action: string;
-}
-export interface SkillData {
-    name: string;
-    description: string;
-    startingLevel: number;
-    hidden?: boolean;
-    icon: string;
-}
+export declare function setConfig(conf: Config): void;
+export declare function getConfig(): Config;
+export declare function getSkillConfig(id: string): SkillData;
+export declare function getImageUrl(imageKeyOrUrl: string): string;
+export declare function getButtonConfig(button: string): ButtonConfig;
+export declare function getItemConfig(id: string): ItemData;
+export declare function getQuestConfig(questId: string): QuestData;
+export declare function getObjectiveConfig(quest: string, objectiveId: string): ObjectiveData;
+export interface AppOptions {
+    logging: boolean;
+    debug: boolean;
+}
+export interface Config {
+    gameTitle: string;
+    images: {
+        [key: string]: string;
+    };
+    layout: {
+        backgrounds: {
+            width: number;
+            height: number;
+        };
+        dialogBottomPadding: number;
+        minTextWidth: number;
+        mobileDialogHeightPercentage: number;
+        verticalLayoutThreshold: number;
+        portraits: {
+            width: number;
+            height: number;
+        };
+    };
+    screens: {
+        [key: string]: ScreenConfig;
+    };
+    buttons: {
+        [key: string]: ButtonConfig;
+    };
+    skills: {
+        [key: string]: SkillData;
+    };
+    skillOptions: {
+        xpPerLevel: number;
+    };
+    skillChecks: {
+        rollRange: number;
+        skillMultiplier: number;
+        failureChance: number;
+        difficultyText: Array<[number, string]>;
+    };
+    scripts: string[];
+    audio: {
+        [key: string]: AudioConfig;
+    };
+    audioOptions: {
+        volume: number;
+        defaultMusic?: string;
+        musicFadeInTime: number;
+        musicFadeInDelay: number;
+        musicFadeOutTime: number;
+    };
+    sound?: {
+        [key: string]: AudioConfig;
+    };
+    music?: {
+        [key: string]: AudioConfig;
+    };
+    notifications: {
+        timeOnScreen: number;
+        alsoPrintInDialogue?: boolean;
+    };
+    hudStats: {
+        [key: string]: HudStatConfig;
+    };
+    items: {
+        [key: string]: ItemData;
+    };
+    interactionTags: {
+        [key: string]: {
+            onlyInteractOutsideOfScripts: boolean;
+        };
+    };
+    quests: {
+        [key: string]: QuestData;
+    };
+    audioTriggers: {
+        [key: string]: string;
+    };
+    menuButtons: {
+        [key: string]: MenuButtonData;
+    };
+}
+export interface ScreenConfig {
+    background: string;
+    buttons: Array<string | InlineButtonConfig>;
+}
+export interface MenuButtonData {
+    text: string;
+}
+export interface QuestData {
+    title: string;
+    description: string;
+    objectives: {
+        [key: string]: ObjectiveData;
+    };
+}
+export interface ObjectiveData {
+    description: string;
+    hidden?: boolean;
+}
+export interface ItemData {
+    name: string;
+    description: string;
+    icon: string;
+    onUse?: {
+        action: 'jump' | 'run';
+        label: string;
+    };
+    tag?: string;
+}
+export interface HudStatConfig {
+    name: string;
+    icon: string;
+    startingValue: number;
+    minValue?: number;
+    maxValue?: number;
+}
+export interface AudioConfig {
+    src: string;
+    path?: string;
+    volume?: number;
+    rate?: number;
+    html5?: boolean;
+}
+export interface MusicConfig extends AudioConfig {
+    loop?: boolean;
+}
+export interface ButtonConfig {
+    enabled: boolean;
+    background?: string;
+    text?: string;
+    position: {
+        left: number;
+        top: number;
+        width?: number;
+        height?: number;
+    };
+    action: string;
+}
+export interface InlineButtonConfig extends ButtonConfig {
+    id: string;
+}
+export interface SkillData {
+    name: string;
+    description: string;
+    startingLevel: number;
+    hidden?: boolean;
+    icon: string;
+}

package/dist/constants.d.ts

@@ -1 +1 @@
-export declare const SAVE_FILE = "gameSave";
+export declare const SAVE_FILE = "gameSave";

package/dist/data/characters.json

@@ -1,62 +1,62 @@
-{
-  "config": {
-    "imagesPath": "./img/characters/"
-  },
-  "characters": {
-    "game": {
-      "name": "",
-      "color": "white"
-    },
-    "player": {
-      "style": {
-        "color": "orange"
-      },
-      "name": "You"
-    },
-    "cat": {
-      "sprites": {
-        "idle": "cat_idle.jpg"
-      },
-      "style": {
-        "color": "white"
-      },
-      "name": "Generic Cat"
-    },
-    "shopkeeper": {
-      "sprites": {
-        "idle": "music_cat.jpeg"
-      },
-      "style": {
-        "color": "white"
-      },
-      "name": "Shopkeeper"
-    },
-    "helper": {
-      "sprites": {
-        "idle": "helper_cat.png"
-      },
-      "style": {
-        "color": "green"
-      },
-      "name": "Helper Cat"
-    },
-    "music_cat": {
-      "sprites": {
-        "idle": "music_cat.jpeg"
-      },
-      "style": {
-        "color": "green"
-      },
-      "name": "Music Cat"
-    },
-    "inner": {
-      "sprites": {
-        "idle": "inner_voice.png"
-      },
-      "style": {
-        "color": "red"
-      },
-      "name": "Inner Voice"
-    }
-  }
-}
+{
+  "config": {
+    "imagesPath": "./img/characters/"
+  },
+  "characters": {
+    "game": {
+      "name": "",
+      "color": "white"
+    },
+    "player": {
+      "style": {
+        "color": "orange"
+      },
+      "name": "You"
+    },
+    "cat": {
+      "sprites": {
+        "idle": "cat_idle.jpg"
+      },
+      "style": {
+        "color": "white"
+      },
+      "name": "Generic Cat"
+    },
+    "shopkeeper": {
+      "sprites": {
+        "idle": "music_cat.jpeg"
+      },
+      "style": {
+        "color": "white"
+      },
+      "name": "Shopkeeper"
+    },
+    "helper": {
+      "sprites": {
+        "idle": "helper_cat.png"
+      },
+      "style": {
+        "color": "green"
+      },
+      "name": "Helper Cat"
+    },
+    "music_cat": {
+      "sprites": {
+        "idle": "music_cat.jpeg"
+      },
+      "style": {
+        "color": "green"
+      },
+      "name": "Music Cat"
+    },
+    "inner": {
+      "sprites": {
+        "idle": "inner_voice.png"
+      },
+      "style": {
+        "color": "red"
+      },
+      "name": "Inner Voice"
+    }
+  }
+}