narrat 0.11.2 → 0.11.5

package/lib/app.vue.d.ts

@@ -1,8 +1,9 @@
 import { PropType } from 'vue';
-import { DialogKey } from './types/vuex';
+import { DialogKey } from './types/state';
 import { DialogBoxParameters } from './types/dialog-box-types';
 import { GameConfig } from './types/app-types';
 import { AppOptions } from '.';
+import { Parser } from './types/parser';
 declare const _default: import("vue").DefineComponent<{
     config: PropType<GameConfig>;
     options: PropType<AppOptions>;

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

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

package/lib/components/debug/debug-menu.vue.d.ts

@@ -1,5 +1,5 @@
-import { SkillCheckState, SkillsState } from '@/types/vuex';
-import { ErrorState } from 'vue';
+import { ErrorState, SkillCheckState, SkillsState } from '@/types/state';
+import { Parser } from '@/types/parser';
 declare const _default: import("vue").DefineComponent<{}, {}, {
     showDebug: boolean;
     jumping: boolean;

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

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

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

@@ -1,4 +1,4 @@
-import { NotificationState } from 'vue';
+import { NotificationState } from '@/types/state';
 declare const _default: import("vue").DefineComponent<{}, {}, void, {
     notifications(): {
         [key: string]: NotificationState;

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/dialog-box.vue.d.ts

@@ -1,7 +1,7 @@
 import { PropType } from 'vue';
 import { DialogStyle } from './types/character-types';
 import { DialogBoxParameters } from './types/dialog-box-types';
-import { DialogChoice } from './types/vuex';
+import { DialogChoice } from './types/state';
 declare const _default: import("vue").DefineComponent<{
     options: {
         type: PropType<DialogBoxParameters>;

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 { ActionContext } from 'vuex';
+import { NarratPlugin } from '../plugins/NarratPlugin';
+import { CommandPlugin, generateParser } from '../vm/commands/command-plugin';
+import type { CommandRunner } from '../vm/commands/command-plugin';
+import { NarratState } from '@/types/state';
+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<NarratState, NarratState>;
+export { CommandRunner };
+export { CommandPlugin, NarratPluginObject, NarratPlugin, registerPlugin, addCommand, generateParser, };

package/lib/index.d.ts

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

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-// Version: 0.11.2 - June 15, 2022 15:56:51
+// Version: 0.11.5 - June 15, 2022 16:55:24
 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';
@@ -8000,7 +8000,7 @@ function setupStore(options) {
         mutations: {
             setLoadedData(state, save) {
                 state.machine.data = save.data;
-                state.skills = cjs(state.skillChecks, save.skills);
+                state.skills = cjs(state.skills, save.skills);
                 state.dialog = save.dialog;
                 state.buttons = cjs(state.buttons, save.buttons);
                 state.lastLabel = save.lastLabel;
@@ -8751,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.2 - June 15, 2022 15:56:51', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.11.5 - June 15, 2022 16:55:24', 'background: #222; color: #bada55');
     vm$1.callHook('onNarratSetup');
     const storeSetup = setupStore(options);
     store$2 = storeSetup.store;

package/lib/index.js

@@ -1,4 +1,4 @@
-// Version: 0.11.2 - June 15, 2022 15:56:51
+// Version: 0.11.5 - June 15, 2022 16:55:24
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -8004,7 +8004,7 @@ function setupStore(options) {
         mutations: {
             setLoadedData(state, save) {
                 state.machine.data = save.data;
-                state.skills = cjs(state.skillChecks, save.skills);
+                state.skills = cjs(state.skills, save.skills);
                 state.dialog = save.dialog;
                 state.buttons = cjs(state.buttons, save.buttons);
                 state.lastLabel = save.lastLabel;
@@ -8755,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.2 - June 15, 2022 15:56:51', 'background: #222; color: #bada55');
+    console.log('%c Narrat game engine – 0.11.5 - June 15, 2022 16:55:24', 'background: #222; color: #bada55');
     vm$1.callHook('onNarratSetup');
     const storeSetup = setupStore(options);
     store$2 = storeSetup.store;

package/lib/plugins/NarratPlugin.d.ts

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

package/lib/store.d.ts

@@ -1,7 +1,7 @@
 import { InjectionKey, State } from 'vue';
 import { Store } from 'vuex';
-import { DialogKey, MachineStack } from './types/vuex';
 import { AppOptions } from '.';
+import { DialogKey, MachineStack } from './types/state';
 export declare type AddDialogParams = Omit<DialogKey, 'id'>;
 export interface SetupStoreResult {
     store: Store<State>;

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 './state';
+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,17 @@
+import { ButtonsState, HudStatsState, DataState, DialogKey, SkillCheckState, SkillsState } from './state';
+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,76 @@
+export 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 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/types/state.d.ts

@@ -0,0 +1,99 @@
+import { AppOptions } from '..';
+import { Parser } from './parser';
+export declare type DialogCallback = (choice: number) => void;
+export interface MachineStack {
+    currentIndex: number;
+    branch: Parser.Branch;
+    label: string;
+}
+export interface DialogKey {
+    speaker: string;
+    text: string;
+    pose?: string;
+    choices?: DialogChoice[];
+    interactive: boolean;
+    id: string;
+}
+export interface DialogChoice {
+    choice: string;
+    originalIndex: number;
+    allowed: boolean;
+}
+export interface SkillState {
+    level: number;
+    xp: number;
+}
+export interface SkillsState {
+    [key: string]: SkillState;
+}
+export interface DataState {
+    [key: string]: any;
+}
+export interface SkillCheckState {
+    passed: boolean;
+    available: boolean;
+}
+export interface Vue {
+    $mq: 'sm' | 'md' | 'lg';
+}
+export interface NarratState {
+    machine: {
+        stack: MachineStack[];
+        script: Parser.ParsedScript;
+        data: DataState;
+    };
+    skillChecks: {
+        [key: string]: SkillCheckState;
+    };
+    buttons: ButtonsState;
+    dialog: DialogKey[];
+    count: number;
+    ready: boolean;
+    skills: SkillsState;
+    lastLabel: string;
+    playing: boolean;
+    currentScreen: string;
+    rendering: RenderingState;
+    hudStats: HudStatsState;
+    audio: {
+        currentMusic?: string;
+        musicHowlId?: number;
+    };
+    errors: ErrorState[];
+    playTime: {
+        start: number;
+        previousPlaytime: number;
+    };
+    notifications: {
+        [key: string]: NotificationState;
+    };
+    options: AppOptions;
+    flowState: 'menu' | 'playing';
+    openModal: string | false;
+    paused: boolean;
+}
+export interface HudStatsState {
+    [key: string]: HudStat;
+}
+export declare type HudStat = number;
+export interface NotificationState {
+    text: string;
+}
+export interface ButtonsState {
+    [key: string]: {
+        enabled: boolean;
+    };
+}
+export interface RenderingState {
+    screenWidth: number;
+    screenHeight: number;
+    canvasWidth: number;
+    canvasHeight: number;
+    renderRatio: number;
+    topOffset: number;
+    leftOffset: number;
+    layoutMode: 'horizontal' | 'vertical';
+}
+export interface ErrorState {
+    text: string;
+}

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/data-helpers.d.ts

@@ -3,7 +3,7 @@ export declare function findDataHelper<T>(sourceObj: any, path: string): [T, str
 export declare function setDataHelper<T>(sourceObj: any, path: string, value: T): void;
 export declare function addDataHelper<T>(sourceObj: any, path: string, value: T): void;
 export declare function getModifiableData(state: State): {
-    data: import("../types/vuex").DataState;
-    skills: import("../types/vuex").SkillsState;
-    buttons: import("vue").ButtonsState;
+    data: import("../types/state").DataState;
+    skills: import("../types/state").SkillsState;
+    buttons: import("../types/state").ButtonsState;
 };

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/utils/skillchecks.d.ts

@@ -1,5 +1,5 @@
 import { SkillCheckParams } from '@/vm/vm-helpers';
-import { SkillCheckState } from '@/types/vuex';
+import { SkillCheckState } from '@/types/state';
 import { State } from 'vue';
 import { ActionContext } from 'vuex';
 export declare function createSkillCheckState(): SkillCheckState;

package/lib/vm/commands/choice.d.ts

@@ -1,6 +1,7 @@
 import { State } from 'vue';
 import { ActionContext } from 'vuex';
 import { CommandPlugin, CommandRunner } from './command-plugin';
+import { Parser } from '@/types/parser';
 export declare const choice: CommandRunner;
 export declare function runChoice(context: ActionContext<State, State>, cmd: Parser.Command): Promise<void>;
 export declare const choicePlugin: CommandPlugin;

package/lib/vm/commands/command-plugin.d.ts

@@ -1,8 +1,8 @@
-import { DialogChoice } from '@/types/vuex';
-import { State } from 'vue';
+import { Parser } from '../../types/parser';
+import { DialogChoice, NarratState } from '../../types/state';
 import { ActionContext } from 'vuex';
 import { ParserContext } from '../vm-parser';
-export declare type CommandRunner = (context: ActionContext<State, State>, cmd: Parser.Command, choices?: DialogChoice[]) => Promise<void>;
+export declare type CommandRunner = (context: ActionContext<NarratState, NarratState>, cmd: Parser.Command, choices?: DialogChoice[]) => Promise<void>;
 export declare type CommandParserFunction = (ctx: CommandParsingContext) => void;
 export declare type ProcessCommandsFunction = (ctx: ParserContext, lines: Parser.Line[], parentLine: Parser.Line | undefined) => Parser.Branch;
 export interface CommandParsingContext {

package/lib/vm/vm-helpers.d.ts

@@ -1,4 +1,5 @@
 import { AddDialogParams } from '@/store';
+import { Parser } from '@/types/parser';
 import { State } from 'vue';
 import { ActionContext, Commit } from 'vuex';
 export declare function processSkillCheck(ctx: ActionContext<State, State>, skillcheck: Parser.SkillCheckOptions): boolean;

package/lib/vm/vm-parser.d.ts

@@ -1,3 +1,4 @@
+import { Parser } from '../types/parser';
 import { ProcessCommandsFunction } from './commands/command-plugin';
 export declare type ParserErrorHandler = (ctx: ParserContext, line: number, text: string) => void;
 export interface ParserContext {

package/lib/vm/vm.d.ts

@@ -1,8 +1,9 @@
 import { ActionContext } from 'vuex';
 import { State } from 'vue';
-import { DialogChoice } from '@/types/vuex';
+import { DialogChoice } from '@/types/state';
 import { CommandPlugin } from './commands/command-plugin';
-import { NarratPluginObject } from '@/plugins';
+import { NarratPluginObject } from '@/exports/plugins';
+import { Parser } from '@/types/parser';
 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.2",
+  "version": "0.11.5",
   "description": "narrat narrative engine",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",