narrat 0.18.0 → 1.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Liana Pigeot
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Liana Pigeot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,30 +1,30 @@
-# 🚀 Narrat
-
-![example workflow](https://github.com/nialna/narrat/actions/workflows/main.yml/badge.svg)
-
-A narrative game engine for text-based games. Inspired by renpy syntax, but built to be customisable, extendable and web-focused. See the [website](https://get-narrat.com)
-
-![Narrat banner image](https://gblobscdn.gitbook.com/assets%2F-Mh95QNKFZeeRV90-ZSq%2F-MiI7tyjjriQTQI80bhM%2F-MiI83Ys6ED75AlZ_dVT%2Fnarrat-banner.jpg?alt=media&token=9d72e03f-c2ba-4fcb-8579-491b0f8940d8)
-
-You can [try a little demo](https://get-narrat.com/demo/). It contains a built version of the [narrat demo repo](https://github.com/nialna/narrat-demo).
-
-Game dialogue info is written in files with a similar syntax to Renpy (.rpy files). Those files get loaded by the game engine which plays through them. This allows us to use [renpy syntax highlighting](https://marketplace.visualstudio.com/items?itemName=LuqueDaniel.languague-renpy) in vs code easily. It is **not renpy** though, just inspired from it. Eventually narrat might have its own language and file extension support.
-
-## Usage
-
-See the [Documentation](https://docs.get-narrat.com/) for more info, or jump directly in the [Getting Started Guide](https://docs.get-narrat.com/getting-started)
-
-## Features
-
-* Flexible dialog writing with branching and conditions
-* Multiple script files support with labels and jumps to organise script writing
-* Multiple speaking characters support with icons and poses
-* Custom variables in scripts to create flags or other data the game needs to track
-* Seamless saving and reloading
-* UI with buttons that can be used for example to create world maps with clickable locations (the buttons can be controlled in scripts)
-* Sound and music support
-* Delays between script lines
-* Electron build to turn the game into a pc/mac/linux app (template to be updated with example soon)
-* Skill checks (Feature still early, needs a UI for viewing skills and creating characters)
-
-
+# 🚀 Narrat
+
+![example workflow](https://github.com/nialna/narrat/actions/workflows/main.yml/badge.svg)
+
+A narrative game engine for text-based games. Inspired by renpy syntax, but built to be customisable, extendable and web-focused. See the [website](https://get-narrat.com)
+
+![Narrat banner image](https://gblobscdn.gitbook.com/assets%2F-Mh95QNKFZeeRV90-ZSq%2F-MiI7tyjjriQTQI80bhM%2F-MiI83Ys6ED75AlZ_dVT%2Fnarrat-banner.jpg?alt=media&token=9d72e03f-c2ba-4fcb-8579-491b0f8940d8)
+
+You can [try a little demo](https://get-narrat.com/demo/). It contains a built version of the [narrat demo repo](https://github.com/nialna/narrat-demo).
+
+Game dialogue info is written in files with a similar syntax to Renpy (.rpy files). Those files get loaded by the game engine which plays through them. This allows us to use [renpy syntax highlighting](https://marketplace.visualstudio.com/items?itemName=LuqueDaniel.languague-renpy) in vs code easily. It is **not renpy** though, just inspired from it. Eventually narrat might have its own language and file extension support.
+
+## Usage
+
+See the [Documentation](https://docs.get-narrat.com/) for more info, or jump directly in the [Getting Started Guide](https://docs.get-narrat.com/getting-started)
+
+## Features
+
+* Flexible dialog writing with branching and conditions
+* Multiple script files support with labels and jumps to organise script writing
+* Multiple speaking characters support with icons and poses
+* Custom variables in scripts to create flags or other data the game needs to track
+* Seamless saving and reloading
+* UI with buttons that can be used for example to create world maps with clickable locations (the buttons can be controlled in scripts)
+* Sound and music support
+* Delays between script lines
+* Electron build to turn the game into a pc/mac/linux app (template to be updated with example soon)
+* Skill checks (Feature still early, needs a UI for viewing skills and creating characters)
+
+

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

@@ -5,10 +5,12 @@ declare const _default: import("vue").DefineComponent<Readonly<import("vue").Com
 }, {
     showSkills(): boolean;
     showInventory(): boolean;
+    showQuests(): boolean;
 }, {
     openMenu(): void;
     openSkills(): void;
     openInventory(): void;
+    openQuests(): void;
     closeMenu(): void;
     toggleMenu(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, readonly string[] | Readonly<import("vue").ExtractPropTypes<Readonly<import("vue").ComponentObjectPropsOptions<{

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

@@ -0,0 +1,25 @@
+import { QuestState, ObjectiveState } from '../stores/quest-log';
+declare const _default: import("vue").DefineComponent<{
+    close: any;
+}, {
+    quests: import("vue").ComputedRef<{
+        [key: string]: QuestState;
+    }>;
+}, unknown, {
+    questsToDisplay(): {
+        [key: string]: QuestState;
+    };
+}, {
+    getQuestData(questId: string): import("../config").QuestData;
+    getObjectiveData(questId: string, objectiveId: string): import("../config").ObjectiveData;
+    getDisplayTextForQuestState(quest: QuestState): " Hidden" | "" | " (Completed)" | " Unknown";
+    getQuestDescription(quest: QuestState): string;
+    getAvailableObjectives(quest: QuestState): {
+        [key: string]: ObjectiveState;
+    };
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    close: any;
+}>>, {
+    close: any;
+}>;
+export default _default;

package/lib/config.d.ts

@@ -2,6 +2,8 @@ export declare function setConfig(conf: Config): void;
 export declare function getConfig(): Config;
 export declare function getSkillConfig(id: string): SkillData;
 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 Config {
     gameTitle: string;
     images: {
@@ -69,6 +71,20 @@ export interface Config {
     items: {
         [key: string]: ItemData;
     };
+    quests: {
+        [key: string]: QuestData;
+    };
+}
+export interface QuestData {
+    title: string;
+    description: string;
+    objectives: {
+        [key: string]: ObjectiveData;
+    };
+}
+export interface ObjectiveData {
+    description: string;
+    hidden?: boolean;
 }
 export interface ItemData {
     name: string;

package/lib/demo/bitsy/bitsy.d.ts

@@ -0,0 +1,27 @@
+import { NarratPlugin } from '@/index';
+import { CommandPlugin } from '@/vm/commands/command-plugin';
+import { State } from 'vue';
+import { ActionContext } from 'vuex';
+declare global {
+    interface Window {
+        defaultFontName: string;
+        attachCanvas: (canvas: HTMLCanvasElement) => void;
+        loadGame: (gameData: any, defaultFontData: any) => void;
+    }
+}
+export declare function bitsyHacks(): void;
+export declare function attachBitsyGameToNarrat(): HTMLCanvasElement;
+export interface BitsyPluginOptions {
+    showOnGameStart?: boolean;
+}
+export declare class BitsyPlugin extends NarratPlugin {
+    canvas: HTMLCanvasElement;
+    customCommands: CommandPlugin[];
+    options: BitsyPluginOptions;
+    oldInputs: any;
+    onGameMounted(): void;
+    constructor(options?: BitsyPluginOptions);
+    showBitsyCommand({ dispatch, commit }: ActionContext<State, State>): Promise<void>;
+    hideBitsyCommand({ dispatch, commit }: ActionContext<State, State>): Promise<any>;
+    hideBitsy(): void;
+}

package/lib/display.d.ts

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