narrat 2.3.1 → 2.3.2

package/README.md

@@ -1,6 +1,6 @@
 # 🚀 Narrat
 
-![example workflow](https://github.com/nialna/narrat/actions/workflows/main.yml/badge.svg)
+![example workflow](https://github.com/liana-p/narrat-engine/actions/workflows/main.yml/badge.svg)
 
 Narrat is a game engine for making interactive narrative RPGs packed with features.. Create your game by editing with a Simple scripting syntax. It supports Skills with skill check rolls, an Items inventory, and has a Quests System. The script system is very powerful and allows branching choices, functions, variables and conditions.
 

package/dist/app.vue.d.ts

@@ -1,8 +1,6 @@
 import { PropType } from 'vue';
-import { GameConfig } from './types/app-types';
-import { AppOptions } from './config';
+import { AppOptions } from './types/app-types';
 declare const _default: import("vue").DefineComponent<{
-    config: PropType<GameConfig>;
     options: PropType<AppOptions>;
 }, {
     dialog: import("vue").ComputedRef<{
@@ -88,7 +86,6 @@ declare const _default: import("vue").DefineComponent<{
     engineSplashDone(): void;
     updateScreenSize(): void;
 }, 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/dialog-picture.vue.d.ts

@@ -3,7 +3,9 @@ declare const _default: import("vue").DefineComponent<{
 }, 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<{
+}, {
+    getAssetUrl(url: string): string;
+}, 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/menu-buttons.vue.d.ts

@@ -6,21 +6,49 @@ export interface ButtonConf {
     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<{}>>, {}>;
+declare const _default: {
+    new (...args: any[]): {
+        $: import("vue").ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{}> & Omit<Readonly<import("vue").ExtractPropTypes<{}>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>;
+        $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) | ((event: string, ...args: any[]) => void);
+        $el: any;
+        $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, {}> & {
+            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<{}>> & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties;
+    __isFragment?: undefined;
+    __isTeleport?: undefined;
+    __isSuspense?: undefined;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {};
+});
 export default _default;

package/dist/components/notification-toast.vue.d.ts

@@ -1,4 +1,4 @@
-declare const _default: import("vue").DefineComponent<{}, {}, void, {
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {
     notifications: () => {
         [key: string]: import("../stores/notification-store").NotificationState;
     };

package/dist/config.d.ts

@@ -4,17 +4,18 @@ export declare function getConfig(): Config;
 export declare function getSkillConfig(id: string): SkillData;
 export declare function getImageUrl(imageKeyOrUrl: string): string;
 export declare function getAssetUrl(assetPath: string): string;
+export declare function getDataUrl(dataPath: 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 {
-    baseAssetsPath?: string;
+export interface AppOptionsDeprecated {
     logging: boolean;
     debug: boolean;
 }
 export interface Config {
     baseAssetsPath?: string;
+    baseDataPath?: string;
     gameTitle: string;
     images: {
         [key: string]: string;
@@ -36,6 +37,18 @@ export interface Config {
     gameFlow: {
         labelToJumpOnScriptEnd?: string;
     };
+    splashScreens: {
+        engineSplashScreen?: {
+            skip?: boolean;
+            fadeDuration?: number;
+            timeBeforeFadeout?: number;
+            overrideText?: string;
+            overrideLogo?: string;
+        };
+        gameSplashScreen?: {
+            startButtonText?: string;
+        };
+    };
     screens: {
         [key: string]: ScreenConfig;
     };

package/dist/constants.d.ts

@@ -6,3 +6,5 @@ export declare const OK_SIGNAL = "###_--_~=:;_OK";
 export declare const STOP_SIGNAL = "###_--_~=:;_STOP";
 export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | typeof OK_SIGNAL | typeof STOP_SIGNAL;
 export declare function isReturnSignal(s: string): s is ReturnSignal;
+export declare const VERSION: string;
+export declare const BUILD_DATE: Date;

package/dist/exports/components.d.ts

@@ -0,0 +1,2 @@
+import ModalWindow from '../components/utils/modal-window.vue';
+export { ModalWindow };

package/dist/exports/events.d.ts

@@ -0,0 +1 @@
+export { inputEvents } from '../utils/InputsListener';

package/dist/exports/others.d.ts

@@ -0,0 +1 @@
+export { registerMenuButton } from '../menu-buttons/menu-buttons';

package/dist/exports/plugins.d.ts

@@ -1,8 +1,25 @@
 import { NarratPlugin } from '../plugins/NarratPlugin';
 import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
 import type { CommandRunner } from '../vm/commands/command-plugin';
+import { StoreDefinition } from 'pinia';
+import { MenuButtonState } from '../stores/menu-store';
 export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
-declare type NarratPluginObject<T> = {
+export interface NarratCustomStoreActions {
+    save?: () => any;
+    load?: (data: any) => void;
+    setup?: () => Promise<void>;
+    start?: () => void;
+    reset: () => void;
+}
+export declare type UseCustomStore = StoreDefinition<string, any, any, NarratCustomStoreActions>;
+export interface CustomStores {
+    [key: string]: UseCustomStore;
+}
+export interface CustomMenuButton {
+    config: MenuButtonState;
+    component: any;
+}
+export declare type NarratPluginObject<T> = {
     onPageLoaded?: NarratLifecycleHook;
     onNarratSetup?: NarratLifecycleHook;
     onAppMounted?: NarratLifecycleHook;
@@ -12,9 +29,10 @@ declare type NarratPluginObject<T> = {
     onGameMounted?: NarratLifecycleHook;
     onGameUnmounted?: NarratLifecycleHook;
     customCommands?: CommandPlugin<T>[];
+    customStores?: CustomStores;
+    customMenuButtons?: CustomMenuButton[];
 };
 declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
 declare function addCommand<T>(command: CommandPlugin<T>): void;
 export { CommandRunner };
 export { CommandPlugin, NarratPlugin, registerPlugin, addCommand, generateParser, };
-export type { NarratPluginObject };

package/dist/exports/stores.d.ts

@@ -0,0 +1,11 @@
+export { useMain } from '../stores/main-store';
+export { useAudio } from '../stores/audio-store';
+export { useDialogStore } from '../stores/dialog-store';
+export { useHud } from '../stores/hud-stats-store';
+export { useInventory } from '../stores/inventory-store';
+export { useNotifications } from '../stores/notification-store';
+export { useQuests } from '../stores/quest-log';
+export { useRenderingStore } from '../stores/rendering-store';
+export { useScreens } from '../stores/screens-store';
+export { useSkills } from '../stores/skills';
+export { useVM } from '../stores/vm-store';

package/dist/lib.d.ts

@@ -12,3 +12,7 @@ declare global {
 export * from './exports/plugins';
 export * from './exports/display';
 export * from './exports/config';
+export * from './exports/events';
+export * from './exports/stores';
+export * from './exports/others';
+export * from './exports/components';

package/dist/main.d.ts

@@ -1,6 +1,7 @@
 import 'es6-promise/auto';
 import 'virtual:windi.css';
 import './css/main.css';
-import { GameConfig } from './types/app-types';
-import { AppOptions } from './config';
-export declare function startApp(config: GameConfig, options: AppOptions): Promise<void>;
+import { AppOptionsInput } from './types/app-types';
+import { AppOptionsDeprecated } from './config';
+export declare function startApp(optionsInput: AppOptionsInput, optionsOld?: AppOptionsDeprecated): Promise<any>;
+export declare function registerComponent(name: string, component: any): void;

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

@@ -0,0 +1,4 @@
+import { MenuButtonState } from '../stores/menu-store';
+export declare function registerDefaultMenuButtons(app: any): void;
+export declare function registerMenuButton(config: MenuButtonState, component: any): void;
+export declare function addMenuButtonsFromPlugins(): void;