narrat 1.3.1 → 2.0.0-rc-6

package/README.md

@@ -1,5 +1,15 @@
 # 🚀 Narrat
 
+## Narrat 2.0
+
+This is the narrat 2.0 branch. See the [Narrat 2.0 update docs](https://docs.get-narrat.com/readme/narrat-2.0) for more info, or look at the changelog.
+
+2.0 version can be installed with `npm install narrat@next`, as it's not pushed as the main release yet (main release is still 1.x).
+
+There are syntax changes in usage of $if functions and also an auto script converter available in the [2.0 update docs](https://docs.get-narrat.com/readme/narrat-2.0).
+
+## Original Docs
+
 ![example workflow](https://github.com/nialna/narrat/actions/workflows/main.yml/badge.svg)
 
 A narrative game engine for text-based games. Inspired by renpy syntax, but built to be customisable, extendable and web-focused. See the [website](https://get-narrat.com)
@@ -16,15 +26,13 @@ See the [Documentation](https://docs.get-narrat.com/) for more info, or jump dir
 
 ## Features
 
-* Flexible dialog writing with branching and conditions
-* Multiple script files support with labels and jumps to organise script writing
-* Multiple speaking characters support with icons and poses
-* Custom variables in scripts to create flags or other data the game needs to track
-* Seamless saving and reloading
-* UI with buttons that can be used for example to create world maps with clickable locations (the buttons can be controlled in scripts)
-* Sound and music support
-* Delays between script lines
-* Electron build to turn the game into a pc/mac/linux app (template to be updated with example soon)
-* Skill checks (Feature still early, needs a UI for viewing skills and creating characters)
-
-
+- Flexible dialog writing with branching and conditions
+- Multiple script files support with labels and jumps to organise script writing
+- Multiple speaking characters support with icons and poses
+- Custom variables in scripts to create flags or other data the game needs to track
+- Seamless saving and reloading
+- UI with buttons that can be used for example to create world maps with clickable locations (the buttons can be controlled in scripts)
+- Sound and music support
+- Delays between script lines
+- Electron build to turn the game into a pc/mac/linux app (template to be updated with example soon)
+- Skill checks (Feature still early, needs a UI for viewing skills and creating characters)

package/{lib → dist}/app.vue.d.ts

@@ -1,8 +1,7 @@
 import { PropType } from 'vue';
 import { DialogBoxParameters } from './types/dialog-box-types';
 import { GameConfig } from './types/app-types';
-import { AppOptions } from '.';
-import { Parser } from './types/parser';
+import { AppOptions } from './config';
 import { DialogKey } from './stores/dialog-store';
 declare const _default: import("vue").DefineComponent<{
     config: PropType<GameConfig>;
@@ -11,67 +10,43 @@ declare const _default: import("vue").DefineComponent<{
     dialog: import("vue").ComputedRef<{
         speaker: string;
         text: string;
-        pose?: string;
+        pose?: string | undefined;
         choices?: {
             choice: string;
             originalIndex: number;
             allowed: boolean;
-        }[];
+        }[] | undefined;
         interactive: boolean;
         id: string;
     }[]>;
     stack: import("vue").ComputedRef<{
         currentIndex: number;
-        branch: {
-            code: string;
-            args: string[];
-            operator: string;
-            commandType: string;
-            options: Parser.EmptyOptions | {
-                condition: string;
-                success: any[];
-                failure?: any[];
-            } | {
-                label: string;
-            } | {
-                text: string;
-            } | {
-                prompt: any;
-                choices: {
-                    choice: string;
-                    branch: any[];
-                    condition?: string;
-                    skillCheck?: {
-                        id: string;
-                        skill: string;
-                        value: number;
-                        hideAfterRoll: boolean;
-                        success: {
-                            text: string;
-                            branch: any[];
-                        };
-                        failure: {
-                            text: string;
-                            branch?: any[];
-                        };
-                    };
-                    index: number;
-                }[];
-            } | {
-                screen: string;
-            } | {
-                mode: "sound" | "music";
-                audio: string;
-            } | {
-                mode: "sound" | "music";
-                audio?: string;
-            } | {
-                duration: number;
-            };
-            fileName: string;
-            line: number;
-        }[];
+        branchData: {
+            branch: {
+                code: string;
+                command: {
+                    commandType: string;
+                    operator: string;
+                    args: (import("./types/parser").Parser.Primitive | {
+                        code: string;
+                        command: any;
+                        fileName: string;
+                        line: number;
+                    })[];
+                    options: import("./types/parser").Parser.DefaultArg;
+                    staticOptions: {};
+                };
+                fileName: string;
+                line: number;
+            }[];
+            args?: string[] | undefined;
+        };
         label: string;
+        scope: {
+            [key: string]: any;
+        };
+        onComplete?: ((result: any) => void) | undefined;
+        returnValue: any;
     }[]>;
     modal: import("vue").ComputedRef<string | false>;
     flowState: import("vue").ComputedRef<"menu" | "playing">;
@@ -85,7 +60,6 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     dialogLength(): number;
     lastDialog(): DialogKey | undefined;
-    command(): Parser.Command;
     picture(): string | undefined;
     backgroundStyle(): any;
     layoutWidth(): number;
@@ -106,7 +80,7 @@ declare const _default: import("vue").DefineComponent<{
     gameStyle(): any;
     screenRatio(): number;
     dialogContainerStyle(): any;
-    currentLine: () => Parser.Command;
+    currentLine: () => import("./types/parser").Parser.ParsedExpression<import("./types/parser").Parser.DefaultArg, {}> | undefined;
     screenWidth: () => number;
     screenHeight: () => number;
     canvasWidth: () => number;

package/dist/components/MainMenu.vue.d.ts

@@ -0,0 +1,12 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {
+    playTime: () => {
+        start: number;
+        previousPlaytime: number;
+    };
+}, {
+    quit(): void;
+    mainMenu(): void;
+    closeMenu(): void;
+    getPlayTimeString(): string;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/{lib → dist}/components/Skills.vue.d.ts

@@ -1,8 +1,6 @@
-import { SkillData } from '@/config';
-import { SkillsState } from '@/stores/skills';
-declare const _default: import("vue").DefineComponent<{
-    close: FunctionConstructor;
-}, {
+import { SkillData } from '../config';
+import { SkillsState } from '../stores/skills';
+declare const _default: import("vue").DefineComponent<{}, {
     skills: import("vue").ComputedRef<SkillsState>;
 }, {
     chosenSkill: boolean | String;
@@ -20,7 +18,5 @@ declare const _default: import("vue").DefineComponent<{
     xpBarWidth(xp: number): {
         width: string;
     };
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    close: FunctionConstructor;
-}>>, {}>;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
 export default _default;

package/{lib → dist}/components/debug/debug-menu.vue.d.ts

@@ -1,8 +1,8 @@
-import { Parser } from '@/types/parser';
+import { Parser } from '../../types/parser';
 declare const _default: import("vue").DefineComponent<{}, {
-    skills: import("vue").ComputedRef<import("@/stores/skills").SkillsState>;
+    skills: import("vue").ComputedRef<import("../../stores/skills").SkillsState>;
     skillChecks: import("vue").ComputedRef<{
-        [key: string]: import("@/stores/skills").SkillCheckState;
+        [key: string]: import("../../stores/skills").SkillCheckState;
     }>;
 }, {
     showDebug: boolean;
@@ -24,7 +24,7 @@ declare const _default: import("vue").DefineComponent<{}, {
         previousPlaytime: number;
     };
     flowState: () => "menu" | "playing";
-    data: () => import("@/stores/vm-store").DataState;
+    data: () => import("../../stores/vm-store").DataState;
     script: () => Parser.ParsedScript;
 }, {
     finishJumping(): void;
@@ -36,11 +36,11 @@ declare const _default: import("vue").DefineComponent<{}, {
     jump(): void;
     getMatchResultStyle(index: number): {
         background: string;
-    };
+    } | undefined;
     onSearchInput(): void;
     save(): void;
     wordCount(): void;
-    countWordsInScriptLine(scriptLine: Parser.Command): number;
+    countWordsInScriptLine(scriptLine: Parser.ParsedExpression): number;
     countWordsInString(string: string): number;
     countWordsInScriptBranch(branch: Parser.Branch): number;
     getPlayTimeString(): string;

package/dist/components/game-dialog.vue.d.ts

@@ -0,0 +1,65 @@
+import { PropType } from 'vue';
+declare const _default: {
+    new (...args: any[]): {
+        $: import("vue").ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{
+            inGame: boolean;
+        }> & Omit<Readonly<import("vue").ExtractPropTypes<{
+            layoutMode: PropType<"horizontal" | "vertical">;
+            inGame: BooleanConstructor;
+        }>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "inGame">;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        };
+        $slots: Readonly<{
+            [name: string]: import("vue").Slot | undefined;
+        }>;
+        $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
+        $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
+        $emit: (event: string, ...args: any[]) => void;
+        $el: any;
+        $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+            layoutMode: PropType<"horizontal" | "vertical">;
+            inGame: BooleanConstructor;
+        }>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, {
+            inGame: boolean;
+        }> & {
+            beforeCreate?: ((() => void) | (() => void)[]) | undefined;
+            created?: ((() => void) | (() => void)[]) | undefined;
+            beforeMount?: ((() => void) | (() => void)[]) | undefined;
+            mounted?: ((() => void) | (() => void)[]) | undefined;
+            beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
+            updated?: ((() => void) | (() => void)[]) | undefined;
+            activated?: ((() => void) | (() => void)[]) | undefined;
+            deactivated?: ((() => void) | (() => void)[]) | undefined;
+            beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
+            beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
+            destroyed?: ((() => void) | (() => void)[]) | undefined;
+            unmounted?: ((() => void) | (() => void)[]) | undefined;
+            renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void)[]) | undefined;
+        };
+        $forceUpdate: () => void;
+        $nextTick: typeof import("vue").nextTick;
+        $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
+    } & Readonly<import("vue").ExtractPropTypes<{
+        layoutMode: PropType<"horizontal" | "vertical">;
+        inGame: BooleanConstructor;
+    }>> & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties;
+    __isFragment?: undefined;
+    __isTeleport?: undefined;
+    __isSuspense?: undefined;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+    layoutMode: PropType<"horizontal" | "vertical">;
+    inGame: BooleanConstructor;
+}>>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, {
+    inGame: boolean;
+}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {};
+});
+export default _default;

package/{lib → dist}/components/hud.vue.d.ts

@@ -1,6 +1,6 @@
-import { HudStatConfig } from '@/config';
-import { HudStatsState } from '@/stores/hud-stats-store';
-declare const _default: import("vue").DefineComponent<{}, {}, void, {
+import { HudStatConfig } from '../config';
+import { HudStatsState } from '../stores/hud-stats-store';
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {
     statsConfig(): {
         [key: string]: HudStatConfig;
     };

package/{lib/components/inventory.vue.d.ts → dist/components/inventory-ui.vue.d.ts}

@@ -1,12 +1,10 @@
-import { ItemData } from '@/config';
-import { ItemState } from '@/stores/inventory-store';
-declare const _default: import("vue").DefineComponent<{
-    close: FunctionConstructor;
-}, {
+import { ItemData } from '../config';
+import { ItemState } from '../stores/inventory-store';
+declare const _default: import("vue").DefineComponent<{}, {
     items: import("vue").ComputedRef<{
         [key: string]: ItemState;
     }>;
-    currentlyChoosing: import("vue").ComputedRef<import("@/stores/dialog-store").DialogChoice[]>;
+    currentlyChoosing: import("vue").ComputedRef<import("../stores/dialog-store").DialogChoice[] | undefined>;
 }, {
     chosenId: string | false;
 }, {
@@ -20,6 +18,7 @@ declare const _default: import("vue").DefineComponent<{
         [key: string]: ItemData;
     };
 }, {
+    close(): void;
     getItemStyle(item: string): any;
     getItemName(item: string): string;
     getItemConf(item: string): ItemData;
@@ -27,7 +26,5 @@ declare const _default: import("vue").DefineComponent<{
     closeItem(): void;
     useItem(): void;
     canUseItem(item: ItemState): boolean;
-}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    close: FunctionConstructor;
-}>>, {}>;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
 export default _default;

package/dist/components/menu-buttons.vue.d.ts

@@ -0,0 +1,15 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {
+    activeMenu: string | false;
+}, {
+    showSkills(): boolean;
+    showInventory(): boolean;
+    showQuests(): boolean;
+}, {
+    openMenu(): void;
+    openSkills(): void;
+    openInventory(): void;
+    openQuests(): void;
+    closeMenu(): void;
+    toggleMenu(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/{lib → dist}/components/notification-toast.vue.d.ts

@@ -1,6 +1,6 @@
 declare const _default: import("vue").DefineComponent<{}, {}, void, {
     notifications: () => {
-        [key: string]: import("@/stores/notification-store").NotificationState;
+        [key: string]: import("../stores/notification-store").NotificationState;
     };
 }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
 export default _default;

package/dist/components/quests-ui.vue.d.ts

@@ -0,0 +1,20 @@
+import { QuestState } from '../stores/quest-log';
+declare const _default: import("vue").DefineComponent<{}, {
+    quests: import("vue").ComputedRef<{
+        [key: string]: QuestState;
+    }>;
+}, {}, {
+    questsToDisplay(): {
+        [key: string]: QuestState;
+    };
+}, {
+    close(): void;
+    getQuestData(questId: string): import("../config").QuestData;
+    getObjectiveData(questId: string, objectiveId: string): import("../config").ObjectiveData;
+    getDisplayTextForQuestState(quest: QuestState): "" | " Hidden" | " (Completed)" | " Unknown";
+    getQuestDescription(quest: QuestState): string;
+    getAvailableObjectives(quest: QuestState): {
+        [key: string]: import("../stores/quest-log").ObjectiveState;
+    };
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/{lib → dist}/config.d.ts

@@ -4,6 +4,10 @@ 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: {
@@ -79,6 +83,9 @@ export interface Config {
     quests: {
         [key: string]: QuestData;
     };
+    audioTriggers: {
+        [key: string]: string;
+    };
 }
 export interface QuestData {
     title: string;

package/dist/data/characters.json

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