narrat 2.0.0-test-2 → 2.0.1

package/README.md

@@ -1,38 +1,38 @@
-# 🚀 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)
-
-![Narrat banner image](https://gblobscdn.gitbook.com/assets%2F-Mh95QNKFZeeRV90-ZSq%2F-MiI7tyjjriQTQI80bhM%2F-MiI83Ys6ED75AlZ_dVT%2Fnarrat-banner.jpg?alt=media&token=9d72e03f-c2ba-4fcb-8579-491b0f8940d8)
-
-You can [try a little demo](https://get-narrat.com/demo/). It contains a built version of the [narrat demo repo](https://github.com/nialna/narrat-demo).
-
-Game dialogue info is written in files with a similar syntax to Renpy (.rpy files). Those files get loaded by the game engine which plays through them. This allows us to use [renpy syntax highlighting](https://marketplace.visualstudio.com/items?itemName=LuqueDaniel.languague-renpy) in vs code easily. It is **not renpy** though, just inspired from it. Eventually narrat might have its own language and file extension support.
-
-## Usage
-
-See the [Documentation](https://docs.get-narrat.com/) for more info, or jump directly in the [Getting Started Guide](https://docs.get-narrat.com/getting-started)
-
-## 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)
+# 🚀 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)
+
+![Narrat banner image](https://gblobscdn.gitbook.com/assets%2F-Mh95QNKFZeeRV90-ZSq%2F-MiI7tyjjriQTQI80bhM%2F-MiI83Ys6ED75AlZ_dVT%2Fnarrat-banner.jpg?alt=media&token=9d72e03f-c2ba-4fcb-8579-491b0f8940d8)
+
+You can [try a little demo](https://get-narrat.com/demo/). It contains a built version of the [narrat demo repo](https://github.com/nialna/narrat-demo).
+
+Game dialogue info is written in files with a similar syntax to Renpy (.rpy files). Those files get loaded by the game engine which plays through them. This allows us to use [renpy syntax highlighting](https://marketplace.visualstudio.com/items?itemName=LuqueDaniel.languague-renpy) in vs code easily. It is **not renpy** though, just inspired from it. Eventually narrat might have its own language and file extension support.
+
+## Usage
+
+See the [Documentation](https://docs.get-narrat.com/) for more info, or jump directly in the [Getting Started Guide](https://docs.get-narrat.com/getting-started)
+
+## 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)

package/dist/app.vue.d.ts

@@ -0,0 +1,106 @@
+import { PropType } from 'vue';
+import { DialogBoxParameters } from './types/dialog-box-types';
+import { GameConfig } from './types/app-types';
+import { AppOptions } from './config';
+import { DialogKey } from './stores/dialog-store';
+declare const _default: import("vue").DefineComponent<{
+    config: PropType<GameConfig>;
+    options: PropType<AppOptions>;
+}, {
+    dialog: import("vue").ComputedRef<{
+        speaker: string;
+        text: string;
+        pose?: string | undefined;
+        choices?: {
+            choice: string;
+            originalIndex: number;
+            allowed: boolean;
+        }[] | undefined;
+        textField?: boolean | undefined;
+        interactive: boolean;
+        id: string;
+    }[]>;
+    stack: import("vue").ComputedRef<{
+        currentIndex: 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">;
+}, {
+    lineTitle: string;
+    lineText: string;
+    gameLoaded: boolean;
+    loadingStep: string;
+    loadingPercentage: number;
+    hasSave: boolean;
+}, {
+    dialogLength(): number;
+    lastDialog(): DialogKey | undefined;
+    picture(): string | undefined;
+    backgroundStyle(): any;
+    layoutWidth(): number;
+    gameTitle(): string;
+    inGame(): boolean;
+    layoutHeight(): number;
+    backgroundSize(): {
+        width: number;
+        height: number;
+        left: number;
+        top: number;
+    };
+    dialogWidth(): number;
+    dialogStyle(): any;
+    gameWidth(): number;
+    gameHeight(): number;
+    appStyle(): any;
+    gameStyle(): any;
+    screenRatio(): number;
+    dialogContainerStyle(): any;
+    currentLine: () => import("./types/parser").Parser.ParsedExpression<import("./types/parser").Parser.DefaultArg, {}> | undefined;
+    screenWidth: () => number;
+    screenHeight: () => number;
+    canvasWidth: () => number;
+    canvasHeight: () => number;
+    topOffset: () => number;
+    leftOffset: () => number;
+    layoutMode: () => "horizontal" | "vertical";
+}, {
+    setupMachine(): Promise<void>;
+    getSaveFile(): string | null;
+    startGame(): Promise<void>;
+    loadGame(): Promise<void>;
+    isDialogActive(i: number): boolean;
+    nextLine(): void;
+    updateScreenSize(): void;
+    closeModal(): void;
+    getDialogBoxOptions(dialogKey: DialogKey, index: number): DialogBoxParameters;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    config: PropType<GameConfig>;
+    options: PropType<AppOptions>;
+}>>, {}>;
+export default _default;

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/dist/components/Skills.vue.d.ts

@@ -0,0 +1,22 @@
+import { SkillData } from '../config';
+import { SkillsState } from '../stores/skills';
+declare const _default: import("vue").DefineComponent<{}, {
+    skills: import("vue").ComputedRef<SkillsState>;
+}, {
+    chosenSkill: boolean | String;
+}, {
+    skillsToDisplay(): SkillsState;
+    skillConf(): {
+        [key: string]: SkillData;
+    };
+    xpPerLevel(): number;
+}, {
+    getSkillStyle(skill: string): any;
+    getSkillName(skill: string): string;
+    clickSkill(skill: string): void;
+    closeSkill(): void;
+    xpBarWidth(xp: number): {
+        width: 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/dist/components/debug/debug-menu.vue.d.ts

@@ -0,0 +1,48 @@
+import { Parser } from '../../types/parser';
+declare const _default: import("vue").DefineComponent<{}, {
+    skills: import("vue").ComputedRef<import("../../stores/skills").SkillsState>;
+    skillChecks: import("vue").ComputedRef<{
+        [key: string]: import("../../stores/skills").SkillCheckState;
+    }>;
+}, {
+    showDebug: boolean;
+    jumping: boolean;
+    searchString: string;
+    matches: string[];
+    matchCursor: number;
+}, {
+    labels(): string[];
+    variables(): {
+        [key: string]: any;
+    };
+    playing: () => boolean;
+    errors: () => {
+        text: string;
+    }[];
+    playTime: () => {
+        start: number;
+        previousPlaytime: number;
+    };
+    flowState: () => "menu" | "playing";
+    data: () => import("../../stores/vm-store").DataState;
+    script: () => Parser.ParsedScript;
+}, {
+    finishJumping(): void;
+    labelSelected(event: any): void;
+    close(): void;
+    closeErrors(): void;
+    open(): void;
+    toggle(): void;
+    jump(): void;
+    getMatchResultStyle(index: number): {
+        background: string;
+    } | undefined;
+    onSearchInput(): void;
+    save(): void;
+    wordCount(): void;
+    countWordsInScriptLine(scriptLine: Parser.ParsedExpression): number;
+    countWordsInString(string: string): number;
+    countWordsInScriptBranch(branch: Parser.Branch): number;
+    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/dist/components/dialog-picture.vue.d.ts

@@ -0,0 +1,9 @@
+declare const _default: import("vue").DefineComponent<{
+    pictureUrl: StringConstructor;
+}, unknown, unknown, {
+    boxStyle(): any;
+    layoutMode: () => "horizontal" | "vertical";
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    pictureUrl: StringConstructor;
+}>>, {}>;
+export default _default;

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/dist/components/hud.vue.d.ts

@@ -0,0 +1,12 @@
+import { HudStatConfig } from '../config';
+import { HudStatsState } from '../stores/hud-stats-store';
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {
+    statsConfig(): {
+        [key: string]: HudStatConfig;
+    };
+    stats(): HudStatsState;
+    hudStyle(): any;
+    layoutMode: () => "horizontal" | "vertical";
+    hudStats: () => HudStatsState;
+}, {}, 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/inventory-ui.vue.d.ts

@@ -0,0 +1,30 @@
+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[] | undefined>;
+}, {
+    chosenId: string | false;
+}, {
+    itemsToDisplay(): {
+        [key: string]: ItemState;
+    };
+    chosenItem(): null | ItemState;
+    canUseChosenItem(): boolean;
+    chosenItemConf(): null | ItemData;
+    itemConf(): {
+        [key: string]: ItemData;
+    };
+}, {
+    close(): void;
+    getItemStyle(item: string): any;
+    getItemName(item: string): string;
+    getItemConf(item: string): ItemData;
+    clickItem(item: string): void;
+    closeItem(): void;
+    useItem(): void;
+    canUseItem(item: ItemState): boolean;
+}, 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/loading-bar.vue.d.ts

@@ -0,0 +1,10 @@
+declare const _default: import("vue").DefineComponent<{
+    percentage: NumberConstructor;
+    step: StringConstructor;
+}, unknown, unknown, {}, {
+    loadingStyle(): any;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    percentage: NumberConstructor;
+    step: StringConstructor;
+}>>, {}>;
+export default _default;

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

@@ -0,0 +1,26 @@
+export interface ButtonConf {
+    id: string;
+    onClick?: () => void;
+    condition?: () => boolean;
+    cssId?: string;
+    cssClass?: string;
+    text: string;
+}
+declare const _default: import("vue").DefineComponent<{}, {}, {
+    buttons: ButtonConf[];
+    activeMenu: string | false;
+}, {
+    buttonsToShow(): ButtonConf[];
+    showSkills(): boolean;
+    showInventory(): boolean;
+    showQuests(): boolean;
+}, {
+    buttonClick(button: ButtonConf): void;
+    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/dist/components/notification-toast.vue.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("vue").DefineComponent<{}, {}, void, {
+    notifications: () => {
+        [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/dist/components/utils/modal.vue.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("vue").DefineComponent<{
+    containerCssClass: StringConstructor;
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    containerCssClass: StringConstructor;
+}>>, {}>;
+export default _default;

package/dist/components/volume-controls.vue.d.ts

@@ -0,0 +1,7 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {
+    muted: boolean;
+}, {}, {
+    changeVolume(event: Event): void;
+    toggleMute(): 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/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/config.json

@@ -141,7 +141,7 @@
       "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",
+        "action": "run",
         "label": "read_book"
       },
       "tag": "always_interactable"
@@ -172,5 +172,11 @@
     "onPressStart": "game_start",
     "onSkillCheckFailure": "failure",
     "onSkillCheckSuccess": "success"
+  },
+  "menuButtons": {
+    "menu": {
+      "text": "Menu",
+      "cssId": "my-custom-id"
+    }
   }
 }