narrat 2.0.0-test-4 → 2.0.2

package/dist/config.d.ts

@@ -0,0 +1,151 @@
+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;
+}

package/dist/constants.d.ts

@@ -0,0 +1 @@
+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"
+    }
+  }
+}

package/dist/data/config.json

@@ -1,176 +1,182 @@
-{
-  "gameTitle": "Narrat Game Example",
-  "images": {
-    "narrat": "img/backgrounds/narrat.png",
-    "map": "img/backgrounds/map.png",
-    "shopButton": "img/ui/shop-button.png",
-    "parkButton": "img/ui/park-button.png"
-  },
-  "layout": {
-    "backgrounds": {
-      "width": 880,
-      "height": 720
-    },
-    "dialogBottomPadding": 70,
-    "minTextWidth": 475,
-    "mobileDialogHeightPercentage": 60,
-    "verticalLayoutThreshold": 1000,
-    "portraits": {
-      "width": 100,
-      "height": 100
-    }
-  },
-  "screens": {
-    "default": {
-      "background": "narrat"
-    },
-    "map": {
-      "background": "map",
-      "buttons": ["shopButton", "parkButton"]
-    }
-  },
-  "buttons": {
-    "shopButton": {
-      "enabled": false,
-      "background": "shopButton",
-      "position": {
-        "left": 38,
-        "top": 6,
-        "width": 255,
-        "height": 226
-      },
-      "action": "shopButton"
-    },
-    "parkButton": {
-      "enabled": false,
-      "background": "parkButton",
-      "position": {
-        "left": 632,
-        "top": 86,
-        "width": 255,
-        "height": 226
-      },
-      "action": "parkButton"
-    }
-  },
-  "skills": {
-    "agility": {
-      "name": "Agility",
-      "description": "How good you are at moving around.",
-      "startingLevel": 0,
-      "icon": "img/skills/agility.jpg",
-      "hidden": true
-    },
-    "haggling": {
-      "name": "Haggling",
-      "description": "Get good prices on items",
-      "icon": "img/skills/logic.jpg",
-      "startingLevel": 1
-    }
-  },
-  "skillChecks": {
-    "rollRange": 100,
-    "skillMultiplier": 10,
-    "failureChance": 1,
-    "difficultyText": [
-      [0, "Very Easy"],
-      [10, "Easy"],
-      [30, "Medium"],
-      [50, "Hard"],
-      [70, "Very Hard"],
-      [80, "Extremely Hard"],
-      [90, "Near Impossible"]
-    ]
-  },
-  "scripts": ["data/example.rpy"],
-  "audio": {
-    "calm": {
-      "loop": true,
-      "src": "music/calm.mp3"
-    },
-    "click": {
-      "src": "audio/click.ogg"
-    },
-    "game_start": {
-      "src": "audio/game_start.ogg"
-    },
-    "failure": {
-      "src": "audio/failure.ogg"
-    },
-    "success": {
-      "src": "audio/success.wav"
-    }
-  },
-  "audioOptions": {
-    "volume": 0.5,
-    "musicFadeInTime": 0.5,
-    "musicFadeInDelay": 0.5,
-    "musicFadeOutTime": 0.5
-  },
-  "notifications": {
-    "timeOnScreen": 2.5,
-    "alsoPrintInDialogue": true
-  },
-  "hudStats": {
-    "money": {
-      "icon": "img/ui/money.png",
-      "name": "Money",
-      "startingValue": 10,
-      "minValue": 0
-    },
-    "energy": {
-      "icon": "img/ui/energy.png",
-      "name": "Energy",
-      "startingValue": 10,
-      "minValue": 0,
-      "maxValue": 10
-    }
-  },
-  "items": {
-    "bread": {
-      "name": "Bread",
-      "description": "A bread in the game.",
-      "icon": "img/items/bread.png",
-      "onUse": {
-        "action": "jump",
-        "label": "eat_bread"
-      }
-    },
-    "book": {
-      "name": "Ominous Book",
-      "description": "An ominous book. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed ullamcorper turpis. Aliquam tincidunt dolor sed mollis aliquet. Duis in odio eros. Maecenas sapien arcu, fermentum id tincidunt non, accumsan vel metus. Nullam pretium molestie accumsan. In ut rutrum tellus. Integer vitae nisl eleifend lorem tristique auctor quis sed nulla. Cras gravida viverra tristique. Mauris imperdiet tortor purus, fringilla vehicula metus ullamcorper eget. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla porta imperdiet justo, sed blandit orci. Aenean accumsan hendrerit arcu, laoreet vestibulum turpis vulputate eu. Etiam dignissim nibh dictum pharetra congue. Nulla ultrices, augue a blandit laoreet, metus enim sodales arcu, eget pellentesque lorem justo et ipsum. ",
-      "icon": "img/items/book.png",
-      "onUse": {
-        "action": "run_label",
-        "label": "read_book"
-      },
-      "tag": "always_interactable"
-    }
-  },
-  "interactionTags": {
-    "default": {
-      "onlyInteractOutsideOfScripts": true
-    }
-  },
-  "quests": {
-    "breadShopping": {
-      "title": "Bread Shopping",
-      "description": "The helper cat asked you to buy bread for him.",
-      "objectives": {
-        "bread": {
-          "description": "Buy bread for the helper cat."
-        },
-        "delivery": {
-          "hidden": true,
-          "description": "Deliver the bread to the helper cat."
-        }
-      }
-    }
-  },
-  "audioTriggers": {
-    "onPlayerAnswered": "click",
-    "onPressStart": "game_start",
-    "onSkillCheckFailure": "failure",
-    "onSkillCheckSuccess": "success"
-  }
-}
+{
+  "gameTitle": "Narrat Game Example",
+  "images": {
+    "narrat": "img/backgrounds/narrat.png",
+    "map": "img/backgrounds/map.png",
+    "shopButton": "img/ui/shop-button.png",
+    "parkButton": "img/ui/park-button.png"
+  },
+  "layout": {
+    "backgrounds": {
+      "width": 880,
+      "height": 720
+    },
+    "dialogBottomPadding": 70,
+    "minTextWidth": 475,
+    "mobileDialogHeightPercentage": 60,
+    "verticalLayoutThreshold": 1000,
+    "portraits": {
+      "width": 100,
+      "height": 100
+    }
+  },
+  "screens": {
+    "default": {
+      "background": "narrat"
+    },
+    "map": {
+      "background": "map",
+      "buttons": ["shopButton", "parkButton"]
+    }
+  },
+  "buttons": {
+    "shopButton": {
+      "enabled": false,
+      "background": "shopButton",
+      "position": {
+        "left": 38,
+        "top": 6,
+        "width": 255,
+        "height": 226
+      },
+      "action": "shopButton"
+    },
+    "parkButton": {
+      "enabled": false,
+      "background": "parkButton",
+      "position": {
+        "left": 632,
+        "top": 86,
+        "width": 255,
+        "height": 226
+      },
+      "action": "parkButton"
+    }
+  },
+  "skills": {
+    "agility": {
+      "name": "Agility",
+      "description": "How good you are at moving around.",
+      "startingLevel": 0,
+      "icon": "img/skills/agility.jpg",
+      "hidden": true
+    },
+    "haggling": {
+      "name": "Haggling",
+      "description": "Get good prices on items",
+      "icon": "img/skills/logic.jpg",
+      "startingLevel": 1
+    }
+  },
+  "skillChecks": {
+    "rollRange": 100,
+    "skillMultiplier": 10,
+    "failureChance": 1,
+    "difficultyText": [
+      [0, "Very Easy"],
+      [10, "Easy"],
+      [30, "Medium"],
+      [50, "Hard"],
+      [70, "Very Hard"],
+      [80, "Extremely Hard"],
+      [90, "Near Impossible"]
+    ]
+  },
+  "scripts": ["data/example.rpy"],
+  "audio": {
+    "calm": {
+      "loop": true,
+      "src": "music/calm.mp3"
+    },
+    "click": {
+      "src": "audio/click.ogg"
+    },
+    "game_start": {
+      "src": "audio/game_start.ogg"
+    },
+    "failure": {
+      "src": "audio/failure.ogg"
+    },
+    "success": {
+      "src": "audio/success.wav"
+    }
+  },
+  "audioOptions": {
+    "volume": 0.5,
+    "musicFadeInTime": 0.5,
+    "musicFadeInDelay": 0.5,
+    "musicFadeOutTime": 0.5
+  },
+  "notifications": {
+    "timeOnScreen": 2.5,
+    "alsoPrintInDialogue": true
+  },
+  "hudStats": {
+    "money": {
+      "icon": "img/ui/money.png",
+      "name": "Money",
+      "startingValue": 10,
+      "minValue": 0
+    },
+    "energy": {
+      "icon": "img/ui/energy.png",
+      "name": "Energy",
+      "startingValue": 10,
+      "minValue": 0,
+      "maxValue": 10
+    }
+  },
+  "items": {
+    "bread": {
+      "name": "Bread",
+      "description": "A bread in the game.",
+      "icon": "img/items/bread.png",
+      "onUse": {
+        "action": "jump",
+        "label": "eat_bread"
+      }
+    },
+    "book": {
+      "name": "Ominous Book",
+      "description": "An ominous book. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed ullamcorper turpis. Aliquam tincidunt dolor sed mollis aliquet. Duis in odio eros. Maecenas sapien arcu, fermentum id tincidunt non, accumsan vel metus. Nullam pretium molestie accumsan. In ut rutrum tellus. Integer vitae nisl eleifend lorem tristique auctor quis sed nulla. Cras gravida viverra tristique. Mauris imperdiet tortor purus, fringilla vehicula metus ullamcorper eget. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla porta imperdiet justo, sed blandit orci. Aenean accumsan hendrerit arcu, laoreet vestibulum turpis vulputate eu. Etiam dignissim nibh dictum pharetra congue. Nulla ultrices, augue a blandit laoreet, metus enim sodales arcu, eget pellentesque lorem justo et ipsum. ",
+      "icon": "img/items/book.png",
+      "onUse": {
+        "action": "run",
+        "label": "read_book"
+      },
+      "tag": "always_interactable"
+    }
+  },
+  "interactionTags": {
+    "default": {
+      "onlyInteractOutsideOfScripts": true
+    }
+  },
+  "quests": {
+    "breadShopping": {
+      "title": "Bread Shopping",
+      "description": "The helper cat asked you to buy bread for him.",
+      "objectives": {
+        "bread": {
+          "description": "Buy bread for the helper cat."
+        },
+        "delivery": {
+          "hidden": true,
+          "description": "Deliver the bread to the helper cat."
+        }
+      }
+    }
+  },
+  "audioTriggers": {
+    "onPlayerAnswered": "click",
+    "onPressStart": "game_start",
+    "onSkillCheckFailure": "failure",
+    "onSkillCheckSuccess": "success"
+  },
+  "menuButtons": {
+    "menu": {
+      "text": "Menu",
+      "cssId": "my-custom-id"
+    }
+  }
+}