@drincs/pixi-vn 0.8.4 → 0.8.9

package/README.md

@@ -1,18 +1,18 @@
 # Pixi'VN - PixiJS Visual Novel Engine
 
-Pixi’VN is a npm package that provides various features for creating visual novels, has functions to manage story steps, saving and loading, variable storage, dialogues, character,canvas management, and much more.
+![pixi-vn-cover](https://github.com/user-attachments/assets/28c41fe1-c539-4ebb-b7d4-8cb9f79e089e)
 
-Pixi’VN + [Templates](#project-initialization) provides a complete solution and is in effect a visual novel engine.
+Pixi’VN is a very versatile and powerful visual novel/2D game engine. It is based on JavaScript/TypeScript and uses the [Pixi.js](https://pixijs.com/) library for rendering.
 
-It is designed for web developers, with basic experience in JavaScript/TypeScript, who want to create a visual novel with a modern 2D rendering engine and their favorite JavaScript framework.
+Its great versatility is due to the fact that Pixi’VN is a npm package, that provides various core features to manage story steps, dialogues, character, canvas management, variable storage, saving and loading, and much more. This means that it can be used both to create visual novels and to create other types of 2D games (such as Point and Click Adventure Games, RPGs, etc...), with your favorite JavaScript framework (React, Vue, Angular, etc...).
+
+Pixi’VN provides the ability to use [Templates](#project-initialization) to get started quickly. Less experienced developers can use these templates to create a visual novel without much knowledge of JavaScript/TypeScript.
 
 With the [PixiVNJson](https://pixi-vn.web.app/advanced/pixi-vn-json.html) implementation you have the option to use various types of narrative languages ​​(in addition to JavaScript/TypeScript). Currently you can use the following:
 
-* [Ink](https://pixi-vn.web.app/ink/ink.html)
+* [*ink*](https://pixi-vn.web.app/ink/ink.html)
 * [Ren'Py](https://pixi-vn.web.app/renpy/renpy.html)
 
-It is based on [Pixi.js](https://pixijs.com/), a rendering engine that allows you to create fast 2D graphics. It is based on WebGL and is very fast and efficient. It is used by many developers to create games, websites, and applications.
-
 Pixi’VN offers the possibility of adding an HTML Element with the same dimensions as the [PixiJS Canvas](https://pixi-vn.web.app/start/canvas.html) to add an **UI** with JavaScript frameworks.
 
 By "UI" is meant the elements that are above the canvas, such as buttons, forms, etc.
@@ -27,31 +27,36 @@ This allows the use of systems such as React, Vue, Angular, etc. to create much
 
 ## Wiki
 
-For more information, visit the [Web Page](https://pixi-vn.web.app/)
-
 * [Why Pixi’VN?](https://pixi-vn.web.app/start/why.html)
 * [Get Started](https://pixi-vn.web.app/start/getting-started.html)
 
 ### First steps
 
 * [Characters](https://pixi-vn.web.app/start/character.html)
-* [Narration (JS/TS)](https://pixi-vn.web.app/start/narration.html):
-  * [Dialogue](https://pixi-vn.web.app/start/dialogue.html)
-  * [Label and Game Step](https://pixi-vn.web.app/start/labels.html)
-  * [Choice Menus](https://pixi-vn.web.app/start/choices.html)
-  * [Input](https://pixi-vn.web.app/start/input.html)
-  * [History](https://pixi-vn.web.app/start/history.html)
-  * [Translating](https://pixi-vn.web.app/start/translate.html)
-  * [Typewriter effect](https://pixi-vn.web.app/start/typewriter.html)
-  * [Style Text (Markdown)](https://pixi-vn.web.app/start/markdown.html)
-* [Narration with Ink](https://pixi-vn.web.app/ink/ink.html):
-  * [Characters](https://pixi-vn.web.app/ink/ink-character.html)
-  * [Style Text (Markdown)](https://pixi-vn.web.app/ink/ink-markdown.html)
-  * [Input](https://pixi-vn.web.app/ink/ink-input.html)
-  * [Canvas](https://pixi-vn.web.app/ink/ink-canvas.html)
-  * [Sounds and Music](https://pixi-vn.web.app/ink/ink-sound.html)
-  * [Translating](https://pixi-vn.web.app/ink/ink-translate.html)
-* [Narration with Ren’Py](https://pixi-vn.web.app/renpy/renpy.html)
+* [Narration](https://pixi-vn.web.app/start/narration.html):
+  * [Narration with ink](https://pixi-vn.web.app/ink/ink.html):
+    * [Characters](https://pixi-vn.web.app/ink/ink-character.html)
+    * [Open a knot](https://pixi-vn.web.app/ink/ink-label.html)
+    * [Variables](https://pixi-vn.web.app/ink/ink-variables.html)
+    * [Style Text (Markdown)](https://pixi-vn.web.app/ink/ink-markdown.html)
+    * [Input](https://pixi-vn.web.app/ink/ink-input.html)
+    * [Canvas](https://pixi-vn.web.app/ink/ink-canvas.html)
+    * [Sounds and Music](https://pixi-vn.web.app/ink/ink-sound.html)
+    * [Pause](https://pixi-vn.web.app/ink/ink-pause.html)
+    * [Translating](https://pixi-vn.web.app/ink/ink-translate.html)
+    * [Text replacement](https://pixi-vn.web.app/ink/ink-replacement.html)
+    * [Custom Hashtag Script](https://pixi-vn.web.app/ink/ink-hashtag.html)
+  * [Narration with Ren’Py](https://pixi-vn.web.app/renpy/renpy.html)
+  * Narration with JS/TS:
+    * [Dialogue](https://pixi-vn.web.app/start/dialogue.html)
+    * [Label and Game Step](https://pixi-vn.web.app/start/labels.html)
+    * [Choice Menus](https://pixi-vn.web.app/start/choices.html)
+    * [Input](https://pixi-vn.web.app/start/input.html)
+    * [History](https://pixi-vn.web.app/start/history.html)
+    * [Translating](https://pixi-vn.web.app/start/translate.html)
+    * [Typewriter effect](https://pixi-vn.web.app/start/typewriter.html)
+    * [Style Text (Markdown)](https://pixi-vn.web.app/start/markdown.html)
+    * [Other features](https://pixi-vn.web.app/start/other-narrative-features.html)
 * [PixiJS Canvas](https://pixi-vn.web.app/start/canvas.html):
   * [Images](https://pixi-vn.web.app/start/images.html)
   * [Video](https://pixi-vn.web.app/start/videos.html)
@@ -73,11 +78,15 @@ For more information, visit the [Web Page](https://pixi-vn.web.app/)
 
 * [Intecept Events](https://pixi-vn.web.app/advanced/intercept-events.html)
 * [Distribution](https://pixi-vn.web.app/advanced/distribution.html)
-  * [Mobile distribution](https://pixi-vn.web.app/advanced/distribution%E2%80%90mobile.html)
-* [Pixi’VN + Json](https://pixi-vn.web.app/advanced/pixi-vn-json.html)
+  * [Website distribution](https://pixi-vn.web.app/advanced/distribution-website.html)
+  * [Desktop distribution](https://pixi-vn.web.app/advanced/distribution-desktop.html)
+  * [Mobile distribution](https://pixi-vn.web.app/advanced/distribution-mobile.html)
+* [Pixi’VN + Json](pixi-vn-json)
 
 ## Prerequisites
 
+Before starting, you must have the following tools installed:
+
 * [Node.js](https://nodejs.org/) version 18 or higher.
 * Text Editor with TypeScript support.
   * [Visual Studio Code](https://code.visualstudio.com/) is recommended.

package/dist/{chunk-T4KKYU4J.js → chunk-4KV6VMUV.js}

@@ -1,30 +1,114 @@
+import {
+  videoTest
+} from "./chunk-GNFWXAOE.js";
+import {
+  imagesAnimationsTest
+} from "./chunk-GEWQS6GP.js";
+import {
+  inputTestLabel
+} from "./chunk-FIQXZ3P3.js";
+import {
+  markdownTest
+} from "./chunk-TNQKYUOG.js";
+import {
+  soundTestLabel
+} from "./chunk-SZWI2CBA.js";
+import {
+  stepLabelTestLAbel
+} from "./chunk-5A543GJ4.js";
+import {
+  baseCanvasElementTestLabel
+} from "./chunk-BHVKSBFZ.js";
+import {
+  canvasEventsTestLabel
+} from "./chunk-GKLIT4GX.js";
 import {
   eggHeadImage,
   eggHeadName,
   juliette
-} from "./chunk-UWXYEVOE.js";
+} from "./chunk-FM5SFYXO.js";
 import {
   CanvasSprite,
+  ChoiceMenuOption,
   TickerBase,
   canvas,
   canvasElementDecorator,
   narration,
   newLabel
-} from "./chunk-3FJYYZOP.js";
+} from "./chunk-D3ZQSJKZ.js";
 import {
   tickerDecorator
 } from "./chunk-JTQGULTR.js";
+import {
+  version
+} from "./chunk-A4NKPUL5.js";
 import {
   Assets
 } from "./chunk-2PXN34ON.js";
 import {
-  Rectangle,
-  Sprite
+  Rectangle
 } from "./chunk-PZXJFPCN.js";
 import {
   __decorateClass
 } from "./chunk-N342G4HO.js";
 
+// src/labels/StartLabel.ts
+var pixivnTestStartLabel = newLabel(
+  "___pixi_vn_example_start_label___",
+  [
+    () => {
+      let currentTimeName = "";
+      const hour = (/* @__PURE__ */ new Date()).getHours();
+      if (hour >= 5 && hour < 12) {
+        currentTimeName = "morning\u{1F505}";
+      } else if (hour >= 12 && hour < 18) {
+        currentTimeName = "afternoon\u{1F506}";
+      } else if (hour >= 18 && hour < 22) {
+        currentTimeName = "evening\u26C5";
+      } else {
+        currentTimeName = "night\u{1F319}";
+      }
+      narration.dialogue = { character: juliette, text: `Good ${currentTimeName}! I'm ${juliette.name}, your virtual assistant. I'm here to help you with your tests.` };
+    },
+    () => narration.dialogue = { character: juliette, text: `You are running the Pixi\u2019VN v${version} test. This test will guide you through the different features of the library.` },
+    (props) => narration.jumpLabel(pixivnTestStartLabel2, props)
+  ]
+);
+var openLink = newLabel(
+  "___pixi_vn_open_link___",
+  [
+    async (props) => {
+      window.open(props.link);
+      await narration.goNext(props);
+    }
+  ]
+);
+var RESTART_TEST_LABEL = "___pixi_vn_restart_test_label___";
+var pixivnTestStartLabel2 = newLabel(
+  RESTART_TEST_LABEL,
+  [
+    () => {
+      canvas.clear();
+      narration.dialogue = { character: juliette, text: "Which test would you like to start with?" };
+      narration.choiceMenuOptions = [
+        new ChoiceMenuOption("Open Pixi\u2019VN Wiki", openLink, { link: "https://pixi-vn.web.app/" }),
+        new ChoiceMenuOption("Open Pixi\u2019VN Discord", openLink, { link: "https://discord.gg/E95FZWakzp" }),
+        new ChoiceMenuOption("Open Pixi\u2019VN Github Issues", openLink, { link: "https://github.com/DRincs-Productions/pixi-vn/issues" }),
+        new ChoiceMenuOption("Images, Transitions and Animations Test", imagesAnimationsTest, {}),
+        new ChoiceMenuOption("Video Test", videoTest, {}),
+        new ChoiceMenuOption("Canvas Events Test", canvasEventsTestLabel, {}),
+        new ChoiceMenuOption("Sound Test", soundTestLabel, {}),
+        new ChoiceMenuOption("Base Canvas Element Test", baseCanvasElementTestLabel, {}),
+        new ChoiceMenuOption("Custom Ticker Canvas Element Test", customTickerCanvasElementTestLabel, {}),
+        new ChoiceMenuOption("Steps and Labels Test", stepLabelTestLAbel, {}),
+        new ChoiceMenuOption("Markdown Test", markdownTest, {}),
+        new ChoiceMenuOption("Input Test", inputTestLabel, {})
+      ];
+    },
+    (props) => narration.jumpLabel(RESTART_TEST_LABEL, props)
+  ]
+);
+
 // src/labels/CustomTickerCanvasElementTestLabel.ts
 var AlienTintingTest = class extends CanvasSprite {
   get memory() {
@@ -45,7 +129,7 @@ var AlienTintingTest = class extends CanvasSprite {
   turningSpeed = 0;
   speed = 0;
   static from(source, skipCache) {
-    let sprite = Sprite.from(source, skipCache);
+    let sprite = CanvasSprite.from(source, skipCache);
     let mySprite = new AlienTintingTest();
     mySprite.texture = sprite.texture;
     return mySprite;
@@ -120,5 +204,7 @@ var customTickerCanvasElementTestLabel = newLabel(
 
 export {
   TintingTestTicker,
-  customTickerCanvasElementTestLabel
+  customTickerCanvasElementTestLabel,
+  pixivnTestStartLabel,
+  pixivnTestStartLabel2
 };

package/dist/{chunk-M6X6FHCH.js → chunk-5A543GJ4.js}

@@ -1,10 +1,10 @@
 import {
   juliette
-} from "./chunk-UWXYEVOE.js";
+} from "./chunk-FM5SFYXO.js";
 import {
   narration,
   newLabel
-} from "./chunk-3FJYYZOP.js";
+} from "./chunk-D3ZQSJKZ.js";
 
 // src/labels/StepLabelTest.ts
 var STEP_LABEL_TEST_LABEL = "___pixi_vn_step_label_test___";

package/dist/{chunk-FYCYVQTG.js → chunk-A4NKPUL5.js}

@@ -2,8 +2,10 @@ import {
   filters_exports
 } from "./chunk-RATGPKD3.js";
 
+// package.json
+var version = "0.8.9";
+
 // src/constants.ts
-var PIXIVN_VERSION = "0.8.3";
 var Repeat = "repeat";
 function Pause(duration) {
   return {
@@ -122,11 +124,13 @@ var videoFormats = [
   "asf",
   "vob"
 ];
+var CANVAS_APP_STAGE_ALIAS = "_stage_";
 
 export {
-  PIXIVN_VERSION,
+  version,
   Repeat,
   Pause,
   filters,
-  videoFormats
+  videoFormats,
+  CANVAS_APP_STAGE_ALIAS
 };

package/dist/{chunk-2FSBBQFF.js → chunk-BHVKSBFZ.js}

@@ -1,7 +1,7 @@
 import {
   bunnyImage,
   juliette
-} from "./chunk-UWXYEVOE.js";
+} from "./chunk-FM5SFYXO.js";
 import {
   CanvasContainer,
   CanvasSprite,
@@ -10,7 +10,7 @@ import {
   canvas,
   narration,
   newLabel
-} from "./chunk-3FJYYZOP.js";
+} from "./chunk-D3ZQSJKZ.js";
 import {
   Assets
 } from "./chunk-2PXN34ON.js";