narrat 2.0.10 → 2.0.13-test

package/dist/stores/main-store.d.ts

@@ -19,7 +19,27 @@ interface MainState {
 export interface MainSaveData {
     playTime: number;
 }
-export declare const useMain: import("pinia").StoreDefinition<"main", MainState, {}, {
+export declare const useMain: import("pinia").StoreDefinition<"main", MainState, {
+    isInGame(state: {
+        ready: boolean;
+        playing: boolean;
+        errors: {
+            text: string;
+        }[];
+        playTime: {
+            start: number;
+            previousPlaytime: number;
+        };
+        options: {
+            baseAssetsPath?: string | undefined;
+            logging: boolean;
+            debug: boolean;
+        };
+        flowState: 'menu' | 'playing';
+        modal: string | false;
+        paused: boolean;
+    } & import("pinia").PiniaCustomStateProperties<MainState>): boolean;
+}, {
     setup(scriptPaths: string[], config: Config): Promise<void>;
     startMachine(): void;
     startGame(): Promise<void>;
@@ -53,22 +73,62 @@ export declare const useMain: import("pinia").StoreDefinition<"main", MainState,
                 previousPlaytime: number;
             };
             options: {
+                baseAssetsPath?: string | undefined;
                 logging: boolean;
                 debug: boolean;
             };
             flowState: 'menu' | 'playing';
             modal: string | false;
             paused: boolean;
-        } & import("pinia")._StoreWithState<"main", MainState, {}, any> & import("pinia")._StoreWithGetters<{}> & import("pinia").PiniaCustomProperties<string, import("pinia").StateTree, import("pinia")._GettersTree<import("pinia").StateTree>, import("pinia")._ActionsTree>;
+        } & import("pinia")._StoreWithState<"main", MainState, {
+            isInGame(state: {
+                ready: boolean;
+                playing: boolean;
+                errors: {
+                    text: string;
+                }[];
+                playTime: {
+                    start: number;
+                    previousPlaytime: number;
+                };
+                options: {
+                    baseAssetsPath?: string | undefined;
+                    logging: boolean;
+                    debug: boolean;
+                };
+                flowState: 'menu' | 'playing';
+                modal: string | false;
+                paused: boolean;
+            } & import("pinia").PiniaCustomStateProperties<MainState>): boolean;
+        }, any> & import("pinia")._StoreWithGetters<{
+            isInGame(state: {
+                ready: boolean;
+                playing: boolean;
+                errors: {
+                    text: string;
+                }[];
+                playTime: {
+                    start: number;
+                    previousPlaytime: number;
+                };
+                options: {
+                    baseAssetsPath?: string | undefined;
+                    logging: boolean;
+                    debug: boolean;
+                };
+                flowState: 'menu' | 'playing';
+                modal: string | false;
+                paused: boolean;
+            } & import("pinia").PiniaCustomStateProperties<MainState>): boolean;
+        }> & import("pinia").PiniaCustomProperties<string, import("pinia").StateTree, import("pinia")._GettersTree<import("pinia").StateTree>, import("pinia")._ActionsTree>;
         screens: import("pinia").Store<"screens", {
-            currentScreen: string;
+            layers: string[];
             buttons: import("./screens-store").ButtonsState;
         }, {}, {
-            setScreen(screen: string): void;
-            setButtons(buttons: {
-                [key: string]: import("../config").ButtonConfig;
-            }): void;
-            changeButton(button: string, newValue: boolean): void;
+            setScreen(screen: string, layer?: number | undefined): void;
+            emptyLayer(layer: number): void;
+            setButtons(config: Config): void;
+            changeButton(button: string, newValue: import("./screens-store").ButtonStateValue): void;
             generateSaveData(): import("./screens-store").ScreenState;
             loadSaveData(data: import("./screens-store").ScreenState): void;
         }>;
@@ -83,7 +143,11 @@ export declare const useMain: import("pinia").StoreDefinition<"main", MainState,
             setupSkills(skills: {
                 [key: string]: import("../config").SkillData;
             }): void;
+            getSkill(skill: string): import("./skills").SkillState;
+            getSkillLevel(skill: string): number;
+            getSkillXp(skill: string): number;
             addXp(skill: string, xp: number): void;
+            setSkillLevel(skill: string, level: number): void;
             incrementSkill(skill: string, amount: number): void;
             levelledUp(skill: string): void;
         }>;

package/dist/stores/screens-store.d.ts

@@ -1,23 +1,23 @@
-import { ButtonConfig } from '../config';
+import { Config } from '../config';
+export declare type ButtonStateValue = boolean | 'hidden' | 'greyed';
 export interface ButtonsState {
     [key: string]: {
-        enabled: boolean;
+        state: ButtonStateValue;
     };
 }
 export interface ScreenState {
-    currentScreen: string;
+    layers: string[];
     buttons: ButtonsState;
 }
 export declare type ScreenSave = ScreenState;
 export declare const useScreens: import("pinia").StoreDefinition<"screens", {
-    currentScreen: string;
+    layers: string[];
     buttons: ButtonsState;
 }, {}, {
-    setScreen(screen: string): void;
-    setButtons(buttons: {
-        [key: string]: ButtonConfig;
-    }): void;
-    changeButton(button: string, newValue: boolean): void;
+    setScreen(screen: string, layer?: number): void;
+    emptyLayer(layer: number): void;
+    setButtons(config: Config): void;
+    changeButton(button: string, newValue: ButtonStateValue): void;
     generateSaveData(): ScreenSave;
     loadSaveData(data: ScreenSave): void;
 }>;

package/dist/stores/skills.d.ts

@@ -30,7 +30,11 @@ export declare const useSkills: import("pinia").StoreDefinition<"skills", Skills
     setupSkills(skills: {
         [key: string]: SkillData;
     }): void;
+    getSkill(skill: string): SkillState;
+    getSkillLevel(skill: string): number;
+    getSkillXp(skill: string): number;
     addXp(skill: string, xp: number): void;
+    setSkillLevel(skill: string, level: number): void;
     incrementSkill(skill: string, amount: number): void;
     levelledUp(skill: string): void;
 }>;

package/dist/types/app-types.d.ts

@@ -1,4 +1,5 @@
 export interface GameConfig {
+    baseAssetsPath?: string;
     charactersPath: string;
     configPath: string;
 }

package/dist/types/parser.d.ts

@@ -1,5 +1,5 @@
 export declare namespace Parser {
-    type Primitive = string | number | boolean;
+    type Primitive = string | number | boolean | undefined | null;
     type Expression = Array<Primitive | Expression>;
     interface IfOptions {
         condition: string;

package/dist/vm/commands/arithmetic-commands.d.ts

@@ -7,6 +7,12 @@ export declare const substractionPlugin: CommandPlugin<{
     a: number;
     b: number;
 }, {}>;
+export declare const negPlugin: CommandPlugin<{
+    a: number;
+}, {}>;
+export declare const absPlugin: CommandPlugin<{
+    a: number;
+}, {}>;
 export declare const multiplicationPlugin: CommandPlugin<{
     a: number;
     b: number;

package/dist/vm/commands/command-helpers.d.ts

@@ -1,2 +1,3 @@
 import { Parser } from '../../types/parser';
 export declare function commandRuntimeError(cmd: Parser.Command<any, any>, errorText: string): void;
+export declare function commandLog(cmd: Parser.Command<any, any>, ...log: any[]): void;

package/dist/vm/commands/flow-commands.d.ts

@@ -12,3 +12,6 @@ export declare const defineVariablePlugin: CommandPlugin<{
 export declare const returnPlugin: CommandPlugin<{
     value: any;
 }, {}>;
+export declare const logPlugin: CommandPlugin<{
+    value: any;
+}, {}>;

package/dist/vm/commands/math-commands.d.ts

@@ -0,0 +1,14 @@
+import { CommandPlugin } from './command-plugin';
+export declare const minPlugin: CommandPlugin<{
+    min: number;
+    value: number;
+}, {}>;
+export declare const maxPlugin: CommandPlugin<{
+    max: number;
+    value: number;
+}, {}>;
+export declare const clampPlugin: CommandPlugin<{
+    min: number;
+    max: number;
+    value: number;
+}, {}>;

package/dist/vm/commands/random-commands.d.ts

@@ -0,0 +1,10 @@
+import { CommandPlugin } from './command-plugin';
+export declare const randomIntPlugin: CommandPlugin<{
+    a: number;
+    b: number;
+}, {}>;
+export declare const randomFloatPlugin: CommandPlugin<{
+    a: number;
+    b: number;
+}, {}>;
+export declare const randomFromArgsPlugin: CommandPlugin<{}, {}>;

package/dist/vm/commands/screen-commands.d.ts

@@ -1,8 +1,12 @@
 import { CommandPlugin } from './command-plugin';
 export declare const setScreenCommand: CommandPlugin<{
     screen: string;
+    layer: number;
+}, {}>;
+export declare const emptyLayerCommand: CommandPlugin<{
+    layer: number;
 }, {}>;
 export declare const setButtonCommand: CommandPlugin<{
     buttonId: string;
-    enabled: boolean;
+    state: any;
 }, {}>;

package/dist/vm/commands/skill-commands.d.ts

@@ -5,11 +5,23 @@ export interface AddLevelArgs {
     amount: number;
 }
 export declare const addLevelPlugin: CommandPlugin<AddLevelArgs, {}>;
+export declare const setLevelPlugin: CommandPlugin<{
+    skill: string;
+    level: number;
+}, {}>;
 export interface AddXpArgs {
     xpKey: string;
     xpToAdd: number;
 }
 export declare const addXpPlugin: CommandPlugin<AddXpArgs, {}>;
+export interface GetLevelArgs {
+    skillKey: string;
+}
+export declare const getLevelPlugin: CommandPlugin<GetLevelArgs, {}>;
+export interface GetXpArgs {
+    xpKey: string;
+}
+export declare const getXpPlugin: CommandPlugin<GetXpArgs, {}>;
 export interface SkillCheckOptions {
     id: string;
     skill: string;

package/dist/vm/vm-helpers.d.ts

@@ -11,6 +11,8 @@ export interface SkillCheckParams {
 export declare function runSkillCheck(params: SkillCheckParams): SkillCheckState;
 export declare function runConditionCommand(command: Parser.Command<IfOptions, IfStaticOptions>): Parser.Branch | undefined;
 export declare function isExpression(arg: Parser.Arg): arg is Parser.ParsedExpression;
+export declare type Variable = string | number | boolean | undefined | null;
+export declare function isVariable(arg: Parser.Arg): arg is Variable;
 export declare function writeText(text: string): void;
 export declare function textCommand(dialog: AddDialogParams): Promise<void>;
 export declare function getLine(lines: Parser.Line[], index: number): Parser.Line | undefined;

package/dist/vm/vm.d.ts

@@ -16,4 +16,3 @@ export declare function runCommand(expression: Parser.ParsedExpression, choices?
 export declare function generateCommand(expr: Parser.ParsedExpression, choices?: DialogChoice[]): Promise<Parser.Command>;
 export declare function runExpression<ReturnType = any>(expr: Parser.ParsedExpression, choices?: DialogChoice[]): Promise<ReturnType>;
 export declare function playerAnswered(choice: string | number): Promise<any>;
-export declare function finishGame(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "2.0.10",
+  "version": "2.0.13-test",
   "description": "narrat narrative engine",
   "main": "dist/narrat.umd.js",
   "module": "dist/narrat.es.js",
@@ -16,6 +16,8 @@
   "scripts": {
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
     "start": "npm run dev",
+    "rpg": "cross-env VITE_EXAMPLE=examples/rpg npx vite dev",
+    "build-rpg": "cross-env VITE_DEMO_BUILD=rpg npx vite build && shx cp -r examples/rpg/* built-example/rpg",
     "dev": "vite",
     "generate-types": "vue-tsc --emitDeclarationOnly --outDir dist && npm run fix-type-aliases",
     "fix-type-aliases": "tsc-alias -p tsconfig.json",
@@ -66,12 +68,13 @@
     "postcss": "^8.4.14",
     "prettier": "^2.7.1",
     "rollup-plugin-typescript2": "^0.32.1",
+    "shx": "^0.3.4",
     "tailwindcss": "^3.1.4",
     "ts-jest": "^28.0.5",
     "tsc-alias": "^1.6.11",
     "tslib": "^2.4.0",
     "typescript": "^4.7.4",
-    "vite": "^2.9.9",
+    "vite": "^3.0.0",
     "vite-plugin-eslint": "^1.6.1",
     "vue": "^3.2.37",
     "vue-tsc": "^0.38.2"

package/dist/data/characters.json

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