narrat 2.7.2 → 2.8.0-rc2

package/dist/config.d.ts

@@ -1,244 +1,154 @@
 import { AppOptions } from './types/app-types';
-import { TransitionSettings } from './utils/transition';
-export declare function loadConfig(options: AppOptions): Promise<void>;
+import { Config } from './config/config-output';
+import { ConfigInput } from './config/config-input';
+export declare function setupConfig(configInput: ConfigInput): Promise<Config>;
+export declare function loadConfig(options: AppOptions): Promise<Config>;
 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 declare function getDialogPanelWidth(): number;
-export interface AppOptionsDeprecated {
-    logging: boolean;
-    debug: boolean;
-}
-export interface SplitConfig {
-    screens: Config['screens'];
-    buttons: Config['buttons'];
-    skills: {
-        skills: Config['skills'];
-        options: Config['skillOptions'];
-        skillChecks: Config['skillChecks'];
-    };
-    scripts: Config['scripts'];
-    audio: {
-        files: Config['audio'];
-        options: Config['audioOptions'];
-    };
-    items: Config['items'];
-    quests: Config['quests'];
-}
-export interface Config {
-    baseAssetsPath?: string;
-    baseDataPath?: string;
-    gameTitle: string;
-    images: {
-        [key: string]: string;
-    };
-    layout: {
-        dialogPanel?: {
-            overlayMode?: boolean;
-            rightOffset?: number;
-            bottomOffset?: number;
-            width?: number;
-            height?: number;
-        };
-        backgrounds: {
-            width: number;
-            height: number;
-        };
-        dialogBottomPadding: number;
-        minTextWidth?: number;
-        mobileDialogHeightPercentage: number;
-        verticalLayoutThreshold: number;
-        portraits: {
-            width: number;
-            height: number;
-            offset?: {
-                landscape?: {
-                    right: number;
-                    bottom: number;
-                };
-                portrait?: {
-                    right: number;
-                    bottom: number;
-                };
-            };
-        };
-    };
-    gameFlow: {
-        labelToJumpOnScriptEnd?: string;
-    };
-    dialoguePanel: {
-        animateText?: boolean;
-        textSpeed?: number;
-        timeBetweenLines?: number;
-    };
-    splashScreens: {
-        engineSplashScreen?: {
-            skip?: boolean;
-            fadeDuration?: number;
-            timeBeforeFadeout?: number;
-            overrideText?: string;
-            overrideLogo?: string;
-        };
-        gameSplashScreen?: {
-            startButtonText?: string;
-        };
-    };
-    screens: {
-        [key: string]: ScreenConfig;
-    };
-    buttons: {
-        [key: string]: ButtonConfig;
-    };
-    skills: {
-        [key: string]: SkillData;
-    };
-    skillOptions: {
-        xpPerLevel: number;
-        notifyLevelUp: boolean;
-    };
+export declare function audioConfig(): import("./config/audio-config").AudioConfig;
+export declare function skillsConfig(): {
+    skills: Record<string, {
+        hidden?: boolean | undefined;
+        description: string;
+        name: string;
+        startingLevel: number;
+        icon: string;
+    }>;
     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;
+        difficultyText: [number, string][];
     };
-    notifications: {
-        timeOnScreen: number;
-        alsoPrintInDialogue?: boolean;
-    };
-    hudStats: {
-        [key: string]: HudStatConfig;
-    };
-    items: {
-        categories: ItemCategory[];
-        items: {
-            [key: string]: ItemData;
-        };
+    skillOptions: {
+        xpPerLevel: number;
+        notifyLevelUp: boolean;
     };
-    interactionTags: {
-        [key: string]: {
-            onlyInteractOutsideOfScripts: boolean;
+};
+export declare function itemsConfig(): {
+    items: Record<string, {
+        onUse?: {
+            label: string;
+            action: string;
+        } | undefined;
+        tag?: string | undefined;
+        category?: string | undefined;
+        description: string;
+        name: string;
+        icon: string;
+    }>;
+    categories: {
+        title: string;
+        id: string;
+    }[];
+};
+export declare function questsConfig(): {
+    quests: Record<string, {
+        title: string;
+        description: string;
+        objectives: Record<string, {
+            hidden?: boolean | undefined;
+            description: string;
+        }>;
+    }>;
+};
+export declare function screensConfig(): {
+    screens: Record<string, {
+        buttons?: (string | ({
+            anchor?: {
+                x: number;
+                y: number;
+            } | undefined;
+            text?: string | undefined;
+            tag?: string | undefined;
+            cssClass?: string | undefined;
+            background?: string | undefined;
+            actionType?: string | undefined;
+            action: string;
+            enabled: boolean;
+            position: {
+                width?: number | undefined;
+                height?: number | undefined;
+                left: number;
+                top: number;
+            };
+        } & {
+            id: string;
+        }))[] | undefined;
+        background: string;
+    }>;
+};
+export declare function buttonsConfig(): {
+    buttons: Record<string, {
+        anchor?: {
+            x: number;
+            y: number;
+        } | undefined;
+        text?: string | undefined;
+        tag?: string | undefined;
+        cssClass?: string | undefined;
+        background?: string | undefined;
+        actionType?: string | undefined;
+        action: string;
+        enabled: boolean;
+        position: {
+            width?: number | undefined;
+            height?: number | undefined;
+            left: number;
+            top: number;
         };
-    };
-    quests: {
-        [key: string]: QuestData;
-    };
-    transitions: {
-        [key: string]: TransitionSettings;
-    };
-    audioTriggers: {
-        [key: string]: string;
-    };
-    menuButtons: {
-        [key: string]: MenuButtonData;
-    };
-    debugging: {
-        showScriptFinishedMessage?: boolean;
-    };
-    saves: {
-        mode: 'game-slots' | 'manual';
-        slots: number;
-    };
-}
-export interface ScreenConfig {
-    background: string;
-    buttons: Array<string | InlineButtonConfig>;
-}
-export interface MenuButtonData {
-    text: string;
-}
-export interface QuestData {
-    title: string;
-    description: string;
-    objectives: {
-        [key: string]: ObjectiveData;
-    };
-}
-export interface ObjectiveData {
+    }>;
+};
+export declare function getSkillConfig(id: string): {
+    hidden?: boolean | undefined;
     description: string;
-    hidden?: boolean;
-}
-export interface ItemData {
-    name: string;
-    description: string;
-    icon: string;
-    onUse?: {
-        action: 'jump' | 'run';
-        label: string;
-    };
-    tag?: string;
-    category?: string;
-}
-export interface ItemCategory {
-    id: string;
-    title: string;
-}
-export interface HudStatConfig {
     name: string;
+    startingLevel: number;
     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 {
+};
+export declare function getImageUrl(imageKeyOrUrl: string): string;
+export declare function getAssetUrl(assetPath: string): string;
+export declare function getSplitConfigUrl(basePath: string, url: string): string;
+export declare function getDataUrl(dataPath: string): string;
+export declare function getButtonConfig(button: string): {
+    anchor?: {
+        x: number;
+        y: number;
+    } | undefined;
+    text?: string | undefined;
+    tag?: string | undefined;
+    cssClass?: string | undefined;
+    background?: string | undefined;
+    actionType?: string | undefined;
+    action: string;
     enabled: boolean;
-    background?: string;
-    text?: string;
-    cssClass?: string;
     position: {
+        width?: number | undefined;
+        height?: number | undefined;
         left: number;
         top: number;
-        width?: number;
-        height?: number;
     };
-    anchor?: {
-        x: number;
-        y: number;
-    };
-    action: string;
-    actionType?: 'jump' | 'run';
-    tag?: string;
-}
-export interface InlineButtonConfig extends ButtonConfig {
-    id: string;
-}
-export interface SkillData {
-    name: string;
+};
+export declare function getItemConfig(id: string): {
+    onUse?: {
+        label: string;
+        action: string;
+    } | undefined;
+    tag?: string | undefined;
+    category?: string | undefined;
     description: string;
-    startingLevel: number;
-    hidden?: boolean;
+    name: string;
     icon: string;
-}
+};
+export declare function getQuestConfig(questId: string): {
+    title: string;
+    description: string;
+    objectives: Record<string, {
+        hidden?: boolean | undefined;
+        description: string;
+    }>;
+};
+export declare function getObjectiveConfig(quest: string, objectiveId: string): {
+    hidden?: boolean | undefined;
+    description: string;
+};
+export declare function getDialogPanelWidth(): number;

package/dist/constants.d.ts

@@ -8,3 +8,5 @@ export declare type ReturnSignal = typeof JUMP_SIGNAL | typeof RETURN_SIGNAL | t
 export declare function isReturnSignal(s: string): s is ReturnSignal;
 export declare const VERSION: string;
 export declare const BUILD_DATE: Date;
+export declare const DEFAULT_DIALOG_WIDTH = 400;
+export declare const DEFAULT_TEXT_SPEED = 20;

package/dist/main.d.ts

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