narrat 0.11.0 → 0.11.3

package/lib/components/Skills.vue.d.ts

@@ -1,4 +1,4 @@
-import { SkillData } from '@/types/config';
+import { SkillData } from '@/config';
 import { SkillsState } from '@/types/vuex';
 declare const _default: import("vue").DefineComponent<{
     close: any;

package/lib/components/hud.vue.d.ts

@@ -1,4 +1,4 @@
-import { HudStatConfig } from '@/types/config';
+import { HudStatConfig } from '@/config';
 import { HudStatsState } from 'vue';
 declare const _default: import("vue").DefineComponent<{}, {}, void, {
     statsConfig(): {

package/lib/config.d.ts

@@ -1,5 +1,104 @@
 import { Commit } from 'vuex';
-import { Config } from './types/config';
 export declare function setConfig(conf: Config): void;
 export declare function getConfig(): Config;
-export declare function getSkillConfig(commit: Commit, id: string): import("./types/config").SkillData;
+export declare function getSkillConfig(commit: Commit, id: string): SkillData;
+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;
+    };
+}
+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/lib/defaultConfig.d.ts

@@ -1,2 +1,2 @@
-import { Config } from './types/config';
+import { Config } from './config';
 export declare const defaultConfig: Config;

package/lib/exports/config.d.ts

@@ -0,0 +1 @@
+export { getConfig } from '../config';

package/lib/exports/display.d.ts

@@ -0,0 +1,2 @@
+import { aspectRatioFit } from '../utils/helpers';
+export { aspectRatioFit };

package/lib/exports/plugins.d.ts

@@ -0,0 +1,22 @@
+import { State } from 'vue';
+import { ActionContext } from 'vuex';
+import { NarratPlugin } from '../plugins/NarratPlugin';
+import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
+import type { CommandRunner } from '../vm/commands/command-plugin';
+export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+declare type NarratPluginObject = {
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin[];
+};
+declare function registerPlugin(plugin: NarratPluginObject): void;
+declare function addCommand(command: CommandPlugin): void;
+export declare type NarratActionContext = ActionContext<State, State>;
+export { CommandRunner };
+export { CommandPlugin, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/lib/index.d.ts

@@ -1,20 +1,23 @@
 import 'es6-promise/auto';
 import './/sass/main.css';
-import './lib';
+import { App, State } from 'vue';
 import { GameConfig } from './types/app-types';
-import * as plugins from './plugins';
-import * as display from './display';
-import * as config from './config';
+import { Store } from 'vuex';
 export interface AppOptions {
     logging: boolean;
     debug: boolean;
 }
 export declare function startApp(config: GameConfig, options: AppOptions): Promise<void>;
-export { plugins, config, display };
-declare const _default: {
-    startApp: typeof startApp;
-    plugins: typeof plugins;
-    display: typeof display;
-    config: typeof config;
+export declare type Narrat = {
+    store: Store<State>;
+    app: App;
+    state: State;
 };
-export default _default;
+declare global {
+    export interface Window {
+        narrat: Narrat;
+    }
+}
+export * from './exports/plugins';
+export * from './exports/display';
+export * from './config';

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-// Version: 0.11.0 - June 15, 2022 15:25:13
+// Version: 0.11.3 - June 15, 2022 16:22:12
 import 'es6-promise/auto';
 import { ref, reactive, readonly, defineComponent, openBlock, createElementBlock, normalizeStyle, createElementVNode, createCommentVNode, Fragment, renderList, normalizeClass, createBlock, Transition, withCtx, renderSlot, createTextVNode, resolveComponent, withDirectives, vModelText, toDisplayString, TransitionGroup, createVNode, createApp } from 'vue';
 import { createLogger, createStore } from 'vuex';
@@ -339,13 +339,6 @@ function getSkillConfig(commit, id) {
     return skill;
 }
 
-var config$2 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  setConfig: setConfig,
-  getConfig: getConfig,
-  getSkillConfig: getSkillConfig
-});
-
 var script$1 = defineComponent({
     props: {
         pictureUrl: String,
@@ -8750,20 +8743,6 @@ function addCommand(command) {
     vm$1.addCommand(command);
 }
 
-var plugins = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  CommandPlugin: CommandPlugin,
-  NarratPlugin: NarratPlugin,
-  registerPlugin: registerPlugin,
-  addCommand: addCommand,
-  generateParser: generateParser
-});
-
-var display = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  aspectRatioFit: aspectRatioFit
-});
-
 let app;
 let store$2;
 vm$1.callHook('onPageLoaded');
@@ -8772,7 +8751,7 @@ async function startApp(config, options) {
     logManager.setupDebugger(options.debug);
     const configFile = await getFile('data/config.json');
     setConfig(JSON.parse(configFile));
-    console.log('%c Narrat game engine – 0.11.0 - June 15, 2022 15:25:13', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.11.3 - June 15, 2022 16:22:12', 'background: #222; color: #bada55');
     vm$1.callHook('onNarratSetup');
     const storeSetup = setupStore(options);
     store$2 = storeSetup.store;
@@ -8811,14 +8790,7 @@ async function startApp(config, options) {
         });
     }
     startGameLoop(store$2);
-}
-var index = {
-    startApp,
-    plugins,
-    display,
-    config: config$2,
-};
+}
 
-export default index;
-export { config$2 as config, display, plugins, startApp };
+export { CommandPlugin, NarratPlugin, addCommand, aspectRatioFit, generateParser, getConfig, getSkillConfig, registerPlugin, setConfig, startApp };
 //# sourceMappingURL=index.esm.js.map

package/lib/index.js

@@ -1,4 +1,4 @@
-// Version: 0.11.0 - June 15, 2022 15:25:13
+// Version: 0.11.3 - June 15, 2022 16:22:12
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -343,13 +343,6 @@ function getSkillConfig(commit, id) {
     return skill;
 }
 
-var config$2 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  setConfig: setConfig,
-  getConfig: getConfig,
-  getSkillConfig: getSkillConfig
-});
-
 var script$1 = vue.defineComponent({
     props: {
         pictureUrl: String,
@@ -8754,20 +8747,6 @@ function addCommand(command) {
     vm$1.addCommand(command);
 }
 
-var plugins = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  CommandPlugin: CommandPlugin,
-  NarratPlugin: NarratPlugin,
-  registerPlugin: registerPlugin,
-  addCommand: addCommand,
-  generateParser: generateParser
-});
-
-var display = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  aspectRatioFit: aspectRatioFit
-});
-
 let app;
 let store$2;
 vm$1.callHook('onPageLoaded');
@@ -8776,7 +8755,7 @@ async function startApp(config, options) {
     logManager.setupDebugger(options.debug);
     const configFile = await getFile('data/config.json');
     setConfig(JSON.parse(configFile));
-    console.log('%c Narrat game engine – 0.11.0 - June 15, 2022 15:25:13', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.11.3 - June 15, 2022 16:22:12', 'background: #222; color: #bada55');
     vm$1.callHook('onNarratSetup');
     const storeSetup = setupStore(options);
     store$2 = storeSetup.store;
@@ -8815,17 +8794,16 @@ async function startApp(config, options) {
         });
     }
     startGameLoop(store$2);
-}
-var index = {
-    startApp,
-    plugins,
-    display,
-    config: config$2,
-};
+}
 
-exports.config = config$2;
-exports.default = index;
-exports.display = display;
-exports.plugins = plugins;
+exports.CommandPlugin = CommandPlugin;
+exports.NarratPlugin = NarratPlugin;
+exports.addCommand = addCommand;
+exports.aspectRatioFit = aspectRatioFit;
+exports.generateParser = generateParser;
+exports.getConfig = getConfig;
+exports.getSkillConfig = getSkillConfig;
+exports.registerPlugin = registerPlugin;
+exports.setConfig = setConfig;
 exports.startApp = startApp;
 //# sourceMappingURL=index.js.map

package/lib/plugins/NarratPlugin.d.ts

@@ -1,4 +1,4 @@
-import { NarratPluginObject } from '@/types/narrat';
+import { NarratPluginObject } from '@/exports/plugins';
 export declare class NarratPlugin implements NarratPluginObject {
     onPageLoaded(): void;
     onNarratSetup(): void;

package/lib/plugins.d.ts

@@ -1,9 +1,22 @@
 import { State } from 'vue';
 import { ActionContext } from 'vuex';
 import { NarratPlugin } from './plugins/NarratPlugin';
-import { NarratPluginObject } from './types/narrat';
-import { CommandPlugin, CommandRunner, generateParser } from './vm/commands/command-plugin';
+import { CommandPlugin, generateParser } from './vm/commands/command-plugin';
+import type { CommandRunner } from './vm/commands/command-plugin';
+export declare type NarratLifecycleHook = <T extends [...any[]]>(...args: T) => void;
+declare type NarratPluginObject = {
+    onPageLoaded?: NarratLifecycleHook;
+    onNarratSetup?: NarratLifecycleHook;
+    onAppMounted?: NarratLifecycleHook;
+    onAssetsLoaded?: NarratLifecycleHook;
+    onGameSetup?: NarratLifecycleHook;
+    onGameStart?: NarratLifecycleHook;
+    onGameMounted?: NarratLifecycleHook;
+    onGameUnmounted?: NarratLifecycleHook;
+    customCommands?: CommandPlugin[];
+};
 declare function registerPlugin(plugin: NarratPluginObject): void;
 declare function addCommand(command: CommandPlugin): void;
 export declare type NarratActionContext = ActionContext<State, State>;
-export { CommandPlugin, CommandRunner, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };
+export { CommandRunner };
+export { CommandPlugin, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/lib/types/app-types.d.ts

@@ -0,0 +1,4 @@
+export interface GameConfig {
+    charactersPath: string;
+    configPath: string;
+}

package/lib/types/character-types.d.ts

@@ -0,0 +1,27 @@
+export interface CharactersConfigFile {
+    config: {
+        imagesPath: string;
+    };
+    characters: {
+        [key: string]: CharacterData;
+    };
+}
+export interface CharacterData {
+    sprites?: {
+        [key: string]: string;
+    };
+    name: string;
+    style?: DialogStyle;
+}
+export interface DialogStyle {
+    color?: string;
+    boxCss?: {
+        [key: string]: any;
+    };
+    nameCss?: {
+        [key: string]: any;
+    };
+    textCss?: {
+        [key: string]: any;
+    };
+}

package/lib/types/dialog-box-types.d.ts

@@ -0,0 +1,9 @@
+import { DialogChoice } from './vuex';
+export interface DialogBoxParameters {
+    title: string;
+    text: string;
+    styleId: string;
+    choices: DialogChoice[];
+    old: boolean;
+    interactive: boolean;
+}

package/lib/types/game-save.d.ts

@@ -0,0 +1,18 @@
+import { ButtonsState, HudStatsState } from 'vue';
+import { DataState, DialogKey, SkillCheckState, SkillsState } from './vuex';
+export interface GameSave {
+    data: DataState;
+    skills: SkillsState;
+    dialog: DialogKey[];
+    lastLabel: string;
+    buttons: ButtonsState;
+    skillChecks: {
+        [key: string]: SkillCheckState;
+    };
+    playTime: number;
+    hudStats: HudStatsState;
+    audio: {
+        currentMusic?: string;
+    };
+    currentScreen: string;
+}

package/lib/types/parser.d.ts

@@ -0,0 +1,79 @@
+declare namespace Parser {
+    interface IfOptions {
+        condition: string;
+        success: Branch;
+        failure?: Branch;
+    }
+    interface ChoiceOptions {
+        prompt: Command;
+        choices: ChoicePrompt[];
+    }
+    interface ChoicePrompt {
+        choice: string;
+        branch: Branch;
+        condition?: string;
+        skillCheck?: SkillCheckOptions;
+        index: number;
+    }
+    interface PlayOptions {
+        mode: 'sound' | 'music';
+        audio: string;
+    }
+    interface StopOptions {
+        mode: 'sound' | 'music';
+        audio?: string;
+    }
+    interface SkillCheckOptions {
+        id: string;
+        skill: string;
+        value: number;
+        hideAfterRoll: boolean;
+        success: {
+            text: string;
+            branch: Branch;
+        };
+        failure: {
+            text: string;
+            branch?: Branch;
+        };
+    }
+    interface JumpOptions {
+        label: string;
+    }
+    interface WaitOptions {
+        duration: number;
+    }
+    interface IfOptions {
+        branch: Branch;
+    }
+    interface TextOptions {
+        text: string;
+    }
+    interface SetScreenOption {
+        screen: string;
+    }
+    interface EmptyOptions {
+    }
+    type CommandOptions = IfOptions | JumpOptions | EmptyOptions | TextOptions | ChoiceOptions | SetScreenOption | PlayOptions | StopOptions | WaitOptions;
+    interface Command {
+        code: string;
+        args: string[];
+        operator: string;
+        commandType: string;
+        options: CommandOptions;
+        fileName: string;
+        line: number;
+    }
+    type Branch = Command[];
+    interface ParsedScript {
+        [key: string]: Parser.Branch;
+    }
+    interface Line {
+        code: string;
+        indentation: number;
+        line: number;
+        operator: string;
+        args: any[];
+        branch?: Line[];
+    }
+}

package/lib/utils/audio-loader.d.ts

@@ -1,4 +1,4 @@
-import { Config, MusicConfig, AudioConfig } from '@/types/config';
+import { Config, MusicConfig, AudioConfig } from '../config';
 import { Howl } from 'howler';
 import { State } from 'vue';
 import { ActionContext, Commit } from 'vuex';

package/lib/utils/images-loader.d.ts

@@ -1,4 +1,4 @@
-import { Config } from '@/types/config';
+import { Config } from '../config';
 export declare const images: {
     [key: string]: HTMLImageElement;
 };

package/lib/vm/vm.d.ts

@@ -2,7 +2,7 @@ import { ActionContext } from 'vuex';
 import { State } from 'vue';
 import { DialogChoice } from '@/types/vuex';
 import { CommandPlugin } from './commands/command-plugin';
-import { NarratPluginObject } from '@/types/narrat';
+import { NarratPluginObject } from '@/exports/plugins';
 export declare function runLine(context: ActionContext<State, State>): Promise<void>;
 export declare class VM {
     plugins: NarratPluginObject[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "narrat",
-  "version": "0.11.0",
+  "version": "0.11.3",
   "description": "narrat narrative engine",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",