@strixit/storyscript 0.0.0-stage → 1.0.0

package/LiveTemplates/StoryScript.xml

@@ -0,0 +1,271 @@
+<templateSet group="StoryScript">
+  <template name="ssdestination" value="{&#10;    name: '$name$',&#10;    target: null$target$&#10;}$END$" description="StoryScript - Add a location destination" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="target" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+      <option name="TS_STATEMENT" value="true" />
+    </context>
+  </template>
+  <template name="ssbarriers" value="barriers: [&#10;    [ '$id$', {&#10;        name: '$name$',&#10;        actions: [&#10;            $actions$&#10;        ]&#10;    }]&#10;]$END$" description="StoryScript - Add destination barriers" toReformat="false" toShortenFQNames="true">
+    <variable name="id" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="actions" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_EXPRESSION" value="false" />
+      <option name="TS_STATEMENT" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssbarrier" value="[ '$id$', {&#10;    name: '$name$',&#10;    actions: [&#10;        $actions$&#10;    ]&#10;}]$END$" description="StoryScript - Add a destination barrier" toReformat="false" toShortenFQNames="true">
+    <variable name="id" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="actions" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssinlinefeature" value="{&#10;    name: '$name$',&#10;    combinations: {&#10;        combine: [&#10;            $combine$&#10;        ]&#10;    }&#10;}$END$" description="StoryScript - Add an inline feature" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="combine" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssmaplocation" value="{&#10;    location: $location$,&#10;    coords: '$coordinates$'&#10; }$END$" description="StoryScript - Add a map location" toReformat="false" toShortenFQNames="true">
+    <variable name="location" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="coordinates" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssaction" value="[ '$id$', {&#10;    text: '$text$',&#10;    execute: (game: IGame) =&gt; {&#10;        $executeFunc$&#10;    }&#10;}]$END$" description="StoryScript - Add an action" toReformat="false" toShortenFQNames="true">
+    <variable name="id" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="executeFunc" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="sscombinationaction" value="{&#10;    text: '$text$',&#10;    preposition: '$preposition$',&#10;    requiresTool: false$requiresTool$,&#10;    failText: (game: IGame, target: ICombinable, tool: ICombinable): string =&gt; &#10;        '$failText$'&#10;}$END$" description="StoryScript - Add a combination action" toReformat="false" toShortenFQNames="true">
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="preposition" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="requiresTool" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="failText" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="sscombinations" value="combinations: {&#10;    combine: [&#10;        $acombination$,&#10;    ]&#10;}$END$" description="StoryScript - Add combinations" toReformat="false" toShortenFQNames="true">
+    <variable name="acombination" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="sscombine" value="{&#10;    combinationType: '$type$',&#10;    match: (game: IGame, target: ICombinable, tool: ICombinable): string | { text: string, removeTarget: boolean } =&gt; {&#10;        return '$matchResult$';&#10;    }&#10;}$END$" description="StoryScript - Add a combination" toReformat="false" toShortenFQNames="true">
+    <variable name="type" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="matchResult" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssconversationaction" value="['$id$', (game: IGame, person: IPerson) =&gt; {&#10;    $actionBody$&#10;}]$END$" description="StoryScript - Add a conversation action" toReformat="false" toShortenFQNames="true">
+    <variable name="id" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="actionBody" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="sstrade" value="trade : {&#10;    name: '$name$',&#10;    text: '$text$',&#10;    ownItemsOnly: true$ownItemsOnly$,&#10;    buy: {&#10;        text: '$buyText$',&#10;        emptyText: '$emptyBuyText$',&#10;        itemSelector: (game: IGame, item: IItem): boolean =&gt; {&#10;            return true$buyItemSelector$;&#10;        }&#10;    },&#10;    sell: {&#10;        text: '$sellText$',&#10;        emptyText: '$emptySellText$',&#10;        itemSelector: (game: IGame, item: IItem): boolean =&gt; {&#10;            return true$sellItemSelector$;&#10;        }&#10;    }&#10;}$END$" description="StoryScript - Add a trade object" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="ownItemsOnly" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="buyText" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="emptyBuyText" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="buyItemSelector" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="sellText" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="emptySellText" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="sellItemSelector" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TSX_HTML" value="false" />
+      <option name="TS_CLASS" value="false" />
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_CLASS_MEMBER_STATEMENT" value="false" />
+      <option name="TS_DOT_PROPERTY_ACCESS" value="false" />
+      <option name="TS_TOP_LEVEL_STATEMENT" value="false" />
+      <option name="TypeScript" value="true" />
+    </context>
+  </template>
+  <template name="ssattributes" value="{&#10;    attributes: [&#10;        $attributes$&#10;    ]&#10;}$END$" description="StoryScript - Add character creation attributes" toReformat="false" toShortenFQNames="true">
+    <variable name="attributes" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssattribute" value="{&#10;    question: '$question$',&#10;    entries: [&#10;        $entries$&#10;    ]&#10;}$END$" description="StoryScript - Add a character creation attribute" toReformat="false" toShortenFQNames="true">
+    <variable name="question" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="entries" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssattributeentry" value="{&#10;    attribute: '$attribute$',&#10;    min: $min$,&#10;    max: $max$,&#10;    value: '$value$'&#10;}$END$" description="StoryScript - Add a character creation attribute entry" toReformat="false" toShortenFQNames="true">
+    <variable name="attribute" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="min" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="max" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="value" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssquestions" value="{&#10;    questions: [&#10;        $questions$&#10;    ]&#10;}$END$" description="StoryScript - Add character creation questions" toReformat="false" toShortenFQNames="true">
+    <variable name="questions" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssquestion" value="{&#10;    question: '$question$',&#10;    entries: [&#10;        $entries$&#10;    ]&#10;}$END$" description="StoryScript - Add a character creation question" toReformat="false" toShortenFQNames="true">
+    <variable name="question" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="entries" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssquestionentry" value="{&#10;    text: '$text$',&#10;    value: '$value$',&#10;    bonus: $bonus$&#10;}$END$" description="StoryScript - Add a character creation question entry" toReformat="false" toShortenFQNames="true">
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="value" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="bonus" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="TS_CLASS_MEMBER_EXPRESSION" value="false" />
+      <option name="TS_EXPRESSION" value="true" />
+    </context>
+  </template>
+  <template name="ssdescription" value="&lt;description name=&quot;$name$&quot;&gt;&#10;    $content$&#10;&lt;/description&gt;&#10;$END$" description="StoryScript - Add a description node" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="content" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssaudio" value="&lt;audio controls=&quot;controls&quot; autoplay=&quot;autoplay&quot;&gt;&#10;    &lt;source :src=&quot;'resources/$filename$.mp3'&quot; type=&quot;audio/mp3&quot; /&gt;&#10;    Your browser does not support audio.&#10;&lt;/audio&gt;&#10;$END$" description="StoryScript - Add an audio node" toReformat="false" toShortenFQNames="true">
+    <variable name="filename" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssvisualfeatures" value="&lt;visual-features img=&quot;$filename$&quot;&gt;&#10;    &lt;area name=&quot;$name$&quot; shape=&quot;$shape$&quot; coords=&quot;$coords$&quot; /&gt;&#10;&lt;/visual-features&gt;$END$" description="StoryScript - Add visual features" toReformat="false" toShortenFQNames="true">
+    <variable name="filename" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="shape" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="coords" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssfeature" value="&lt;feature name=&quot;$name$&quot;&gt;$text$&lt;/feature&gt;&#10;$END$" description="StoryScript - Add a feature" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssvisualFeature" value="&lt;area name=&quot;$name$&quot; shape=&quot;$shape$&quot; coords=&quot;$coords$&quot; /&gt;&#10;$END$" description="StoryScript - Add a visual feature" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="shape" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="coords" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssconversation" value="&lt;conversation&gt;&#10;    &lt;default-reply&gt;&#10;    &lt;/default-reply&gt;&#10;    &lt;node name=&quot;$name$&quot; trigger=&quot;$trigger$&quot;&gt;&#10;        &lt;p&gt;&#10;            $text$&#10;        &lt;/p&gt;&#10;        &lt;replies default-reply=&quot;&quot;&gt;&#10;            $replies$&#10;        &lt;/replies&gt;&#10;    &lt;/node&gt;&#10;&lt;/conversation&gt;&#10;$END$" description="StoryScript - Add a conversation" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="trigger" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="replies" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssconversationnode" value="&lt;node name=&quot;$name$&quot; trigger=&quot;$trigger$&quot;&gt;&#10;    &lt;p&gt;&#10;        $text$&#10;    &lt;/p&gt;&#10;    &lt;replies default-reply=&quot;&quot;&gt;&#10;        $replies$&#10;    &lt;/replies&gt;&#10;&lt;/node&gt;&#10;$END$" description="StoryScript - Add a conversation node" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="trigger" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="replies" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="ssconversationreply" value="&lt;reply node=&quot;$name$&quot; set-start=&quot;&quot; requires=&quot;&quot; trigger=&quot;&quot; quest-complete=&quot;&quot;&gt;&#10;    $text$&#10;&lt;/reply&gt;&#10;$END$" description="StoryScript - Add a conversation reply" toReformat="false" toShortenFQNames="true">
+    <variable name="name" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+  <template name="sstrigger" value="&lt;span data-trigger=&quot;$trigger$&quot;&gt;$text$&lt;/span&gt;&#10;$END$" description="StoryScript - add a trigger" toReformat="false" toShortenFQNames="true">
+    <variable name="trigger" expression="" defaultValue="" alwaysStopAt="true" />
+    <variable name="text" expression="" defaultValue="" alwaysStopAt="true" />
+    <context>
+      <option name="HTML_TEXT" value="true" />
+    </context>
+  </template>
+</templateSet>

package/README.md

@@ -1,3 +1,10 @@
-# Temporary Holding Version
+# StoryScript
+StoryScript is an engine to create games for the web. Games that run anywhere, online or offline, 
+on any device, and work well with both mouse and touch control. You play your games while you 
+build them! Your changes are shown immediately, allowing you to shape your world as you move 
+through it.
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+StoryScript uses TypeScript, Vue and Vite and works especially well with Visual Studio Code 
+and Rider, for which it has Code Snippets / Live Templates.
+
+To get started, find examples or read the tutorials, please visit the [StoryScript Website](https://www.storyscript.nl).

package/baseViteConfig.js

@@ -0,0 +1,112 @@
+import fs from 'fs';
+import {normalizePath} from 'vite';
+import checker from 'vite-plugin-checker';
+import {viteStaticCopy} from 'vite-plugin-static-copy';
+import path from 'path';
+import vue from '@vitejs/plugin-vue';
+import jsonfile from "jsonfile";
+import {VitePWA} from 'vite-plugin-pwa'
+import {fileURLToPath} from "url";
+
+const {readFileSync} = jsonfile;
+
+const __filename = fileURLToPath(import.meta.url);
+let __dirname = path.dirname(__filename);
+const rootFolder = __dirname.includes('/node_modules/') ? `${__dirname.split('/node_modules/')[0]}` : __dirname;
+
+const srcPath = `${rootFolder}/src`;
+
+export const getBaseViteConfig = (gamePath) => {
+    const gameInfoPath = `${gamePath}/webroot/gameinfo.json`;
+
+    let gameInfo;
+
+    if (fs.existsSync(gameInfoPath)) {
+        gameInfo = readFileSync(gameInfoPath);
+    }
+
+    return {
+        base: ``,
+        publicDir: path.resolve(gamePath, 'webroot'),
+        define: {
+            'process.env': {}
+        },
+        resolve: {
+            alias: {
+                src: srcPath,
+                game: gamePath,
+                $resources: path.resolve(gamePath, 'resources')
+            }
+        },
+        plugins: [
+            {
+                name: 'set-game-name-and-description',
+                transformIndexHtml(html) {
+                    return gameInfo ? html
+                        .replace(/%STORYSCRIPT_GAME_NAME%/g, gameInfo.name)
+                        .replace(/%STORYSCRIPT_GAME_DESCRIPTION%/g, gameInfo.description) : html;
+                }
+            },
+            vue(),
+            checker({
+                typescript: true,
+                vueTsc: true
+            }),
+            viteStaticCopy({
+                watch: {
+                    reloadPageOnChange: true
+                },
+                silent: true,
+                targets: [
+                    {
+                        src: normalizePath(path.resolve(gamePath, 'resources/**/*.*')),
+                        dest: 'resources',
+                        // This is relative to the project root. So ./src/Games/{GameName}/resources will be trimmed. We
+                        // cannot use 'stripBase: true' because we want to support placing resources in subdirectories.
+                        rename: {stripBase: 4}
+                    }
+                ]
+            }),
+            {
+                name: 'run-postbuild',
+                apply: 'build',
+                async writeBundle() {
+                    const {postBuild} = await import('./scripts/postbuild.js');
+                    await postBuild();
+                }
+            },
+            VitePWA({
+                registerType: 'autoUpdate',
+                devOptions: {
+                    enabled: false
+                },
+                workbox: {
+                    globDirectory: 'dist',
+                    globPatterns: [
+                        'assets/**/*',
+                        'resources/**/*',
+                        'index.html',
+                        'manifest.webmanifest',
+                    ],
+                }
+            })
+        ],
+        server: {
+            port: 3000,
+            open: true
+        },
+        preview: {
+            port: 8080,
+        },
+        build: {
+            target: 'esnext',
+            outDir: "./dist",
+            sourcemap: false,
+            rolldownOptions: {
+                output: {
+                    keepNames: true
+                }
+            }
+        }
+    };
+};

package/clientFiles/currentGameName.js

@@ -0,0 +1 @@
+export const currentGameName = '';

package/clientFiles/gitignore

@@ -0,0 +1,12 @@
+# Visual Studio Code and Rider Settings
+/.vscode
+/.idea
+
+# dependencies
+/node_modules
+
+# Copied and generated files for StoryScript, resource files that should not be checked in
+/dist/*
+/src/Tests/**/coverage/*
+
+stats.html

package/clientFiles/tsconfig.json

@@ -0,0 +1,34 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "ES2022",
+        "lib": ["ES2022", "DOM", "DOM.Iterable"],
+
+        "paths": {
+            "storyScript": ["./node_modules/storyscript"],
+            "src/*": ["./src/*"]
+        },
+        "typeRoots": ["./node_modules/@types"],
+        "types": ["node", "vite/client"],
+
+        "sourceMap": true,
+        "noEmitOnError": true,
+        "removeComments": false,
+        "useDefineForClassFields": true,
+        "skipLibCheck": true,
+
+        /* Linting */
+        "strict": true,
+        "noImplicitAny": false,
+        "strictNullChecks": false,
+        
+        /* Bundler mode */
+        "moduleResolution": "bundler",
+        "allowSyntheticDefaultImports": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "noEmit": true,
+        "allowJs": true,
+    },
+    "exclude": ["currentGameName.js"]
+}

package/clientFiles/vite.config.ts

@@ -0,0 +1,14 @@
+import {getBaseViteConfig} from "storyscript/vite-config";
+import {defineConfig} from "vite";
+import {fileURLToPath} from "url";
+import path from "path";
+import {currentGameName} from "./currentGameName.js";
+
+const __filename = fileURLToPath(import.meta.url);
+let __dirname = path.dirname(__filename);
+const gamePath = `${__dirname}/src/Games/${currentGameName}`;
+
+const config = getBaseViteConfig(gamePath);
+config.resolve.alias['storyScript'] = `${__dirname}/node_modules/storyscript`;
+
+export default defineConfig(config);

package/clientFiles/vitest.config.ts

@@ -0,0 +1,29 @@
+import {defineConfig, mergeConfig} from 'vitest/config'
+// @ts-ignore
+import viteConfig from './vite.config.ts'
+import {currentGameName} from "./currentGameName.js";
+
+export default mergeConfig(viteConfig, defineConfig({
+    test: {
+        environment: 'jsdom',
+        coverage: {
+            enabled: true,
+            provider: 'v8',
+            reporter: ['json', 'html'],
+            reportsDirectory: './src/Tests/coverage',
+            reportOnFailure: true,
+            include: [
+                `src/Games/${currentGameName}/**`
+            ],
+            exclude: [
+                '**/*.html',
+                '**/*.d.ts',
+                "**/*.json",
+                '**/[iI]nterfaces/**',
+                "**/resources/**",
+                "**/ui/styles/**",
+                "**/webroot/**"
+            ]
+        }
+    }
+}));

package/dist/src/Engine/Actions/index.d.ts

@@ -0,0 +1,2 @@
+export { Open } from './open';
+export { OpenWithKey } from './openWithKey';

package/dist/src/Engine/Actions/open.d.ts

@@ -0,0 +1,6 @@
+import { IBarrier, IDestination, IGame } from '../..';
+/**
+ * A basic function to remove a barrier and then execute a callback function.
+ * @param callback
+ */
+export declare function Open(callback?: (game: IGame, barrier: [string, IBarrier], destination: IDestination) => void): (game: IGame, barrier: [string, IBarrier], destination: IDestination) => void;

package/dist/src/Engine/Actions/openWithKey.d.ts

@@ -0,0 +1,7 @@
+import { IBarrier, IDestination, IGame } from '../..';
+/**
+ * A basic function to remove a barrier using a key and then execute a callback function. When it is not specified that the player
+ * should keep the key after using it, it is removed from his item list.
+ * @param callback The callback function to invoke after the barrier is removed.
+ */
+export declare function OpenWithKey(callback?: (game: IGame, barrier: [string, IBarrier], destination: IDestination) => void): (game: IGame, barrier: [string, IBarrier], destination: IDestination) => void;

package/dist/src/Engine/EntityCreatorFunctions.d.ts

@@ -0,0 +1,18 @@
+import { ICompiledLocation, IDefinitions, IDestination, IEnemy, IFeature, IItem, IKey, ILocation, IMap, IPerson, IQuest } from '..';
+export declare function Location(entity: ILocation): ILocation;
+export declare function LocationMap(entity: IMap): IMap;
+export declare function Enemy<T extends IEnemy>(entity: T): T;
+export declare function Person<T extends IPerson>(entity: T): T;
+export declare function Item<T extends IItem>(entity: T): T;
+export declare function Key<T extends IKey>(entity: T): T;
+export declare function Feature<T extends IFeature>(entity: T): IFeature;
+export declare function Quest<T extends IQuest>(entity: T): T;
+export declare function DynamicEntity<T>(entityFunction: () => T, id?: string): T;
+export declare function customEntity<T, C extends {
+    name: string;
+}>(definition: () => T, customData: C): T;
+export declare function buildEntities(definitions: IDefinitions): Record<string, Record<string, any>>;
+export declare function InitEntityCollection(entity: any, property: string): void;
+export declare function setDestination(destination: IDestination): void;
+export declare function getBasicFeatureData(location: ICompiledLocation, node: HTMLElement): IFeature;
+export declare function getParsedDocument(tag: string, value?: string, wrapIfNotFound?: boolean): HTMLCollectionOf<Element>;

package/dist/src/Engine/Interfaces/action.d.ts

@@ -0,0 +1,37 @@
+import { IGame } from './game';
+import { ActionType } from './enumerations/actionType';
+import { ActionStatus } from './enumerations/actionStatus';
+/**
+ * Actions available to the player when exploring the location.
+ */
+export interface IAction {
+    /**
+     * The text shown for this action (e.g. 'Search').
+     */
+    text?: string;
+    /**
+     * How to visually identify this action to the player.
+     */
+    actionType?: ActionType;
+    /**
+     * The action status or a function that returns an action status to set the status dynamically.
+     */
+    status?: ActionStatus | ((game: IGame) => ActionStatus);
+    /**
+     * The function to execute or game event to raise when the player selects the action. Return
+     * true if the action should be allowed to execute more than once. When an event is raised
+     * the action is considered to be allowed to execute more than once.
+     */
+    execute: string | ((game: IGame) => boolean | void);
+    /**
+     * If the player should confirm executing the action, specify a text to ask for confirmation here.
+     * The player will then be asked to confirm before the action is executed, and he'll have the
+     * option to cancel.
+     */
+    confirmationText?: string;
+    /**
+     * When this flag is set to true, the action is not shown to the player. Useful to only conditionally
+     * make actions present on a location.
+     */
+    inactive?: boolean;
+}

package/dist/src/Engine/Interfaces/autoplayStep.d.ts

@@ -0,0 +1,11 @@
+import { IGame } from '../..';
+export interface IAutoplayStep {
+    /**
+     * The action to execute for this step.
+     */
+    action: (game: IGame) => void;
+    /**
+     * The number of milliseconds to wait before executing this step.
+     */
+    delay: number;
+}

package/dist/src/Engine/Interfaces/barrier.d.ts

@@ -0,0 +1,16 @@
+import { IKey } from './key';
+import { IBarrierAction } from './barrierAction';
+import { ICombinable } from './combinations/combinable';
+/**
+ * The base properties for barriers that block a player from moving between one world location to the next.
+ */
+export interface IBarrier extends ICombinable {
+    /**
+     * The actions the player can perform on the barrier (e.g. inspect or open).
+     */
+    actions?: [string, IBarrierAction][];
+    /**
+     * The key to use to remove this barrier.
+     */
+    key?: (() => IKey) | string;
+}

package/dist/src/Engine/Interfaces/barrierAction.d.ts

@@ -0,0 +1,19 @@
+import { IGame } from './game';
+import { IBarrier } from './barrier';
+import { IDestination } from './destination';
+/**
+ * Actions that can be performed on barriers, like opening doors or rowing across rivers.
+ */
+export interface IBarrierAction {
+    /**
+     * The name of the barrier action as show to the player.
+     */
+    text: string;
+    /**
+     * The function to execute when the player selects this action.
+     * @param game The game object
+     * @param barrier The barrier
+     * @param destination The destination the barrier is for
+     */
+    execute(game: IGame, barrier: [string, IBarrier], destination: IDestination): void;
+}