narrat 3.4.0 → 3.5.1

package/dist/config/config-output.d.ts

@@ -1,347 +1,31 @@
 import { AudioConfig } from '../config/audio-config';
-import { DebuggingConfig, DialogPanelConfig, InteractionTagsConfig, MenuButtonsConfig, NotificationsConfig, SavesConfig, SplashScreenConfig, TransitionsConfig, HudStatsConfig } from '../config/common-config';
+import { CommonConfig } from '../config/common-config';
 import { ItemsConfig } from '../config/items-config';
 import { QuestsConfig } from '../config/quests-config';
 import { ScreensConfig } from '../config/screens-config';
 import { SkillsConfig } from '../config/skills-config';
 import { ButtonsConfig } from './buttons-config';
 import { CharactersFilesConfig } from './characters-config';
-import { LayoutConfig } from './layout-config';
 import { TooltipsConfig } from './tooltips-config';
 import { AchievementsConfig } from './achievements-config';
 import { SkillChecksConfig } from './skillchecks-config';
-import { SettingsConfig } from './settings-config';
 import { ChoicesConfig } from './choices-config';
 import { AnimationsConfig } from './animations-config';
 export interface Config {
-    baseAssetsPath: string;
-    baseDataPath: string;
-    gameTitle: string;
-    saveFileName: string;
-    images: {
-        [key: string]: string;
-    };
-    layout: LayoutConfig;
-    settings: SettingsConfig;
-    gameFlow: {
-        labelToJumpOnScriptEnd?: string;
-    };
-    dialogPanel: DialogPanelConfig;
-    splashScreens: SplashScreenConfig;
+    common: CommonConfig;
     screens: ScreensConfig;
     buttons: ButtonsConfig;
     skills: SkillsConfig;
     skillChecks: SkillChecksConfig;
     scripts: string[];
     audio: AudioConfig;
-    notifications: NotificationsConfig;
-    tooltips: TooltipsConfig;
-    hudStats: HudStatsConfig;
     items: ItemsConfig;
     achievements: AchievementsConfig;
-    interactionTags: InteractionTagsConfig;
     quests: QuestsConfig;
-    transitions: TransitionsConfig;
-    menuButtons: MenuButtonsConfig;
-    debugging: DebuggingConfig;
-    saves: SavesConfig;
     characters: CharactersFilesConfig;
-    choices: ChoicesConfig;
     animations: AnimationsConfig;
+    tooltips: TooltipsConfig;
+    choices: ChoicesConfig;
 }
-export declare const defaultConfig: {
-    baseAssetsPath: string;
-    baseDataPath: string;
-    gameTitle: string;
-    saveFileName: string;
-    images: {};
-    layout: {
-        minTextWidth?: number | undefined;
-        defaultFontSize?: number | undefined;
-        backgrounds: {
-            width: number;
-            height: number;
-        };
-        dialogBottomPadding: string | number;
-        verticalLayoutThreshold: number;
-        portraits: {
-            offset?: {
-                landscape?: {
-                    right: number;
-                    bottom: number;
-                } | undefined;
-                portrait?: {
-                    right: number;
-                    bottom: number;
-                } | undefined;
-            } | undefined;
-            width: number;
-            height: number;
-        };
-    };
-    settings: {};
-    gameFlow: {};
-    dialogPanel: {
-        overlayMode: boolean;
-        rightOffset: number;
-        bottomOffset: number;
-        width: number;
-        height: number;
-        textSpeed: number;
-        animateText: boolean;
-        timeBetweenLines: number;
-        showDuringTransition: boolean;
-        showAfterScriptEnd: boolean;
-    };
-    splashScreens: {};
-    screens: {
-        screens: Record<string, {
-            video?: {
-                loop?: boolean | undefined;
-                muted?: boolean | undefined;
-            } | undefined;
-            buttons?: (string | ({
-                text?: string | undefined;
-                background?: string | undefined;
-                cssClass?: string | undefined;
-                anchor?: {
-                    x: number;
-                    y: number;
-                } | undefined;
-                action?: string | undefined;
-                actionType?: string | undefined;
-                scriptClickable?: boolean | undefined;
-                tag?: string | undefined;
-                enabled: boolean;
-                position: {
-                    width?: number | undefined;
-                    height?: number | undefined;
-                    left: number;
-                    top: number;
-                };
-            } & {
-                id: string;
-            }))[] | undefined;
-            background: string;
-        }>;
-    };
-    buttons: {
-        clickableDuringScriptsByDefault?: boolean | undefined;
-        buttons: Record<string, {
-            text?: string | undefined;
-            background?: string | undefined;
-            cssClass?: string | undefined;
-            anchor?: {
-                x: number;
-                y: number;
-            } | undefined;
-            action?: string | undefined;
-            actionType?: string | undefined;
-            scriptClickable?: boolean | undefined;
-            tag?: string | undefined;
-            enabled: boolean;
-            position: {
-                width?: number | undefined;
-                height?: number | undefined;
-                left: number;
-                top: number;
-            };
-        }>;
-    };
-    skills: {
-        skills: Record<string, {
-            hidden?: boolean | undefined;
-            name: string;
-            description: string;
-            startingLevel: number;
-            icon: string;
-        }>;
-        skillOptions: {
-            xpPerLevel: number;
-            notifyLevelUp: boolean;
-        };
-    };
-    skillChecks: {
-        options: {
-            extraDicePerLevel?: number | undefined;
-            finalRollIsHighest?: boolean | undefined;
-            finalRollIsLowest?: boolean | undefined;
-            failOnRollsEqualToThreshold?: boolean | undefined;
-            diceRange: [number, number];
-            diceCount: number;
-            difficultyText: [number, string][];
-            extraPointsPerLevel: number;
-            successOnRollsBelowThreshold: boolean;
-            showDifficultyText: boolean;
-            showDifficultyNumber: boolean;
-            showDifficultyWithoutModifiers: boolean;
-        };
-        skillChecks: Record<string, {
-            winsNeeded?: number | undefined;
-            hideAfterRoll?: boolean | undefined;
-            repeatable?: boolean | undefined;
-            skill: string;
-            difficulty: number;
-        }>;
-    };
-    scripts: never[];
-    audio: AudioConfig;
-    notifications: {
-        timeOnScreen: number;
-        alsoPrintInDialogue: boolean;
-    };
-    tooltips: {
-        options: {
-            delay?: number | undefined;
-            screenEdgesMinimumMargin?: number | undefined;
-            styling?: {
-                cssClass?: string | undefined;
-                textCssClass?: string | undefined;
-                titleCssClass?: string | undefined;
-            } | undefined;
-            width: number;
-            keywordsPrefix: string;
-        };
-        tooltips: {
-            styling?: {
-                cssClass?: string | undefined;
-                textCssClass?: string | undefined;
-                titleCssClass?: string | undefined;
-            } | undefined;
-            title: string;
-            description: string;
-            keywords: string[];
-        }[];
-    };
-    hudStats: {};
-    achievements: {
-        secretAchievements?: {
-            censorDescription?: boolean | undefined;
-            censorName?: boolean | undefined;
-            hideUntilObtained?: boolean | undefined;
-        } | undefined;
-        categories: {
-            title: string;
-            id: string;
-        }[];
-        achievements: Record<string, {
-            icon?: string | undefined;
-            category?: string | undefined;
-            lockedIcon?: string | undefined;
-            secret?: boolean | undefined;
-            name: string;
-            description: string;
-        }>;
-        defaultAchievementIcon: string;
-        notifyNewAchievements: boolean;
-    };
-    items: {
-        categories: {
-            title: string;
-            id: string;
-        }[];
-        items: Record<string, {
-            tag?: string | undefined;
-            onUse?: {
-                label: string;
-                action: string;
-            } | undefined;
-            category?: string | undefined;
-            showIfEmpty?: boolean | undefined;
-            name: string;
-            description: string;
-            icon: string;
-        }>;
-    };
-    interactionTags: {
-        default: {
-            onlyInteractOutsideOfScripts: boolean;
-        };
-    };
-    quests: {
-        categories: {
-            title: string;
-            id: string;
-        }[];
-        quests: Record<string, {
-            category?: string | undefined;
-            succeededDescription?: string | undefined;
-            failedDescription?: string | undefined;
-            endings?: Record<string, {
-                description: string;
-                success: boolean;
-            }> | undefined;
-            title: string;
-            description: string;
-            objectives: Record<string, {
-                hidden?: boolean | undefined;
-                succeededDescription?: string | undefined;
-                failedDescription?: string | undefined;
-                description: string;
-            }>;
-        }>;
-    };
-    transitions: {};
-    menuButtons: {};
-    debugging: {
-        showScriptFinishedMessage: boolean;
-    };
-    saves: {
-        mode: string;
-        slots: number;
-    };
-    characters: {
-        config: {
-            playerCharacter?: string | undefined;
-            gameCharacter?: string | undefined;
-            imagesPath: string;
-        };
-        characters: Record<string, {
-            style?: {
-                portraitCssClass?: string | undefined;
-                color?: string | undefined;
-                boxCss?: Record<string, any> | undefined;
-                nameCss?: Record<string, any> | undefined;
-                textCss?: Record<string, any> | undefined;
-            } | undefined;
-            sprites?: Record<string, string | {
-                loop?: boolean | undefined;
-                width?: number | undefined;
-                height?: number | undefined;
-                autoplay?: boolean | undefined;
-                muted?: boolean | undefined;
-                video: string;
-            } | {
-                width?: number | undefined;
-                height?: number | undefined;
-                image: string;
-            }> | undefined;
-            name: string;
-        }>;
-    };
-    choices: {
-        choiceTextTemplate: string;
-        choicePrompts: Record<string, {
-            cssClass?: string | undefined;
-            textTemplate?: string | undefined;
-        }>;
-    };
-    animations: {
-        animations: Record<string, {
-            options?: {
-                fill?: string | undefined;
-                delay?: number | undefined;
-                duration?: number | undefined;
-                direction?: string | undefined;
-                easing?: string | undefined;
-                endDelay?: number | undefined;
-                iterationStart?: number | undefined;
-                iterations?: number | undefined;
-                keyframes?: any;
-            } | undefined;
-            keyframes: string | any[];
-        }>;
-        keyframes: Record<string, any[]>;
-    };
-};
+export declare const defaultConfig: Config;
 export declare const defaultConfigTyped: Config;

package/dist/config.d.ts

@@ -2,10 +2,15 @@ import { AppOptions } from './types/app-types';
 import { Config } from './config/config-output';
 import { ScreenConfig } from './config/screens-config';
 import { ButtonConfig } from './config/buttons-config';
-import { ConfigInput } from './config/config-input';
+import { CommonConfig } from './config/common-config';
+import { ConfigInput, ConfigInputWithCommon, ConfigInputWithoutCommon } from './config/config-input';
+export declare function extendBaseConfig(newConfig: Config, configInput: ConfigInputWithCommon): Promise<void>;
+export declare function copyValue<T>(value: T, base?: T): T;
+export declare function addOldBaseConfig(newConfig: Config, configInput: ConfigInputWithoutCommon): Promise<void>;
 export declare function setupConfig(configInput: ConfigInput): Promise<Config>;
 export declare function loadConfig(options: AppOptions): Promise<Config>;
 export declare function getConfig(): Config;
+export declare function getCommonConfig(): CommonConfig;
 export declare function audioConfig(): import("./config/audio-config").AudioConfig;
 export declare function audioFileConfig(key: string): {
     path?: string | undefined;
@@ -65,11 +70,11 @@ export declare function itemsConfig(): {
         id: string;
     }[];
     items: Record<string, {
-        tag?: string | undefined;
         onUse?: {
             label: string;
             action: string;
         } | undefined;
+        tag?: string | undefined;
         category?: string | undefined;
         showIfEmpty?: boolean | undefined;
         name: string;
@@ -108,16 +113,16 @@ export declare function screensConfig(): {
         } | undefined;
         buttons?: (string | ({
             text?: string | undefined;
+            action?: string | undefined;
+            tag?: string | undefined;
             background?: string | undefined;
             cssClass?: string | undefined;
             anchor?: {
                 x: number;
                 y: number;
             } | undefined;
-            action?: string | undefined;
             actionType?: string | undefined;
             scriptClickable?: boolean | undefined;
-            tag?: string | undefined;
             enabled: boolean;
             position: {
                 width?: number | undefined;
@@ -135,16 +140,16 @@ export declare function buttonsConfig(): {
     clickableDuringScriptsByDefault?: boolean | undefined;
     buttons: Record<string, {
         text?: string | undefined;
+        action?: string | undefined;
+        tag?: string | undefined;
         background?: string | undefined;
         cssClass?: string | undefined;
         anchor?: {
             x: number;
             y: number;
         } | undefined;
-        action?: string | undefined;
         actionType?: string | undefined;
         scriptClickable?: boolean | undefined;
-        tag?: string | undefined;
         enabled: boolean;
         position: {
             width?: number | undefined;
@@ -214,6 +219,7 @@ export declare function choicesConfig(): {
     }>;
 };
 export declare function animationsConfig(): {
+    keyframes: Record<string, any[]>;
     animations: Record<string, {
         options?: {
             fill?: string | undefined;
@@ -228,7 +234,6 @@ export declare function animationsConfig(): {
         } | undefined;
         keyframes: string | any[];
     }>;
-    keyframes: Record<string, any[]>;
 };
 export declare function getChoicePromptConfig(flag: string): {
     cssClass?: string | undefined;
@@ -266,11 +271,11 @@ export declare function getSplitConfigUrl(basePath: string, url: string): string
 export declare function getDataUrl(dataPath: string): string;
 export declare function getButtonConfig(button: string): ButtonConfig;
 export declare function getItemConfig(id: string): {
-    tag?: string | undefined;
     onUse?: {
         label: string;
         action: string;
     } | undefined;
+    tag?: string | undefined;
     category?: string | undefined;
     showIfEmpty?: boolean | undefined;
     name: string;
@@ -287,6 +292,7 @@ export declare function getAchievementsConfig(): {
         title: string;
         id: string;
     }[];
+    defaultAchievementIcon: string;
     achievements: Record<string, {
         icon?: string | undefined;
         category?: string | undefined;
@@ -295,7 +301,6 @@ export declare function getAchievementsConfig(): {
         name: string;
         description: string;
     }>;
-    defaultAchievementIcon: string;
     notifyNewAchievements: boolean;
 };
 export declare function getAchievementConfig(id: string): {

package/dist/demo/themes-demo.d.ts

@@ -0,0 +1 @@
+export declare function setupThemesDemo(): void;

package/dist/examples/default/config/defaultGameConfig.d.ts

@@ -0,0 +1,2 @@
+import { ModuleConfigInput } from '../../../config/config-input';
+export declare const defaultGameConfigs: ModuleConfigInput;

package/dist/examples/default/scripts/defaultGameScripts.d.ts

@@ -0,0 +1 @@
+export declare const defaultGameScripts: any[];

package/dist/examples/demo/scripts.d.ts

@@ -1,2 +1,2 @@
-declare const _default: any[];
-export default _default;
+export declare const demoScripts: any[];
+export declare const demoYamls: NarratYaml[];

package/dist/exports/config.d.ts

@@ -1,4 +1,4 @@
-export { getConfig } from '../config';
+export { getCommonConfig as getConfig } from '../config';
 export type { Config } from '../config/config-output';
 export * from '../config/config-input';
 export { audioConfig, skillsConfig, itemsConfig, questsConfig, screensConfig, buttonsConfig, tooltipsConfig, charactersConfig, getSkillConfig, getImageUrl, getAssetUrl, getSplitConfigUrl, getDataUrl, getButtonConfig, getScreenConfig, getItemConfig, getQuestConfig, getObjectiveConfig, } from '../config';

package/dist/exports/exports.d.ts

@@ -8,3 +8,4 @@ export * from '../exports/others';
 export * from '../exports/components';
 export * from '../exports/utils';
 export * from '../exports/optionals';
+export * from '../exports/plugins-list';

package/dist/exports/plugins-list.d.ts

@@ -0,0 +1,3 @@
+export * from '../plugins/narrat-themes/NarratThemesPlugin';
+export * from '../plugins/godot-plugin';
+export * from '../plugins/narrat-themes';

package/dist/exports/plugins.d.ts

@@ -1,69 +1 @@
-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 { MenuState, MenuTabState } from '../stores/menu-store';
-import { CustomSetting } from '../config/settings-config';
-export type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
-export interface NarratCustomStoreActions {
-    save?: () => any;
-    load?: (data: any) => void;
-    setup?: () => Promise<void>;
-    start?: () => void;
-    reset: () => void;
-}
-export type UseCustomStore = StoreDefinition<string, any, any, NarratCustomStoreActions>;
-export interface CustomStores {
-    [key: string]: UseCustomStore;
-}
-export interface CustomMenuButton {
-    menuId: string;
-    config: MenuState;
-    components: {
-        [key: string]: any;
-    };
-}
-export interface CustomMenuTab {
-    menuId: string;
-    config: MenuTabState;
-    component: any;
-}
-export type NarratPluginObject<T> = {
-    pluginId: string;
-    onPageLoaded?: NarratLifecycleHook;
-    onNarratSetup?: NarratLifecycleHook;
-    onAppMounted?: NarratLifecycleHook;
-    onAssetsLoaded?: NarratLifecycleHook;
-    onGameSetup?: NarratLifecycleHook;
-    onGameStart?: NarratLifecycleHook;
-    onGameMounted?: NarratLifecycleHook;
-    onGameUnmounted?: NarratLifecycleHook;
-    customCommands?: CommandPlugin<T>[];
-    customStores?: CustomStores;
-    customMenuButtons?: CustomMenuButton[];
-    customMenuTabs?: CustomMenuTab[];
-    startMenuButtons?: CustomStartMenuButton[];
-    customSettings?: Record<string, CustomSetting>;
-    save?: () => any;
-    load?: (data: any) => void;
-    reset?: () => void;
-    loadingPromises?: Promise<any>[];
-};
-/**
- * Custom buttons that get added to the start menu (where the New Game etc buttons are)
- * Action option is to provide a function to run on click
- * popupComponent option is to provide a component to display in a modal window on click (for custom pieces of UI)
- */
-export interface CustomStartMenuButton {
-    id: string;
-    text: string;
-    action?: () => void;
-    popupComponent?: {
-        name: string;
-        component: any;
-    };
-}
-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 * from '../plugins/plugins';

package/dist/exports/utils.d.ts

@@ -12,3 +12,4 @@ export type { Vector2 } from '../utils/Vector2';
 export { gameloop } from '../utils/gameloop';
 export { debounce } from '../utils/debounce';
 export * from '../utils/construct-narrat';
+export * from '../utils/type-utils';

package/dist/hmr/hmr.d.ts

@@ -1,4 +1,6 @@
-import { NarratScript } from '../types/app-types';
+import { NarratScript, NarratYaml } from '../types/app-types';
 import { ModuleNamespace } from 'vite/types/hot';
+export declare function isModuleValid(newModule: ModuleNamespace | undefined): newModule is ModuleNamespace;
 export declare function handleHMR(newModule: ModuleNamespace | undefined): void;
 export declare function isNarratScript(scriptModule: any): scriptModule is NarratScript;
+export declare function isNarratYaml(scriptModule: any): scriptModule is NarratYaml;