@drincs/pixi-vn 1.8.1 → 1.8.3

package/README.md

@@ -25,27 +25,22 @@ For a quick start, various [project templates](#project-initialization) are avai
 
 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)
-- [Ren'Py](https://pixi-vn.web.app/renpy/renpy)
+- [_ink_](https://pixi-vn.com/ink/ink)
 
 Pixi’VN does not provide built-in components to create the game UI. Instead, you should use external JavaScript frameworks to build your UI. This allows you to leverage systems such as React, Vue, etc., to create complex and high-performance **UI screens**.
 
-- [React](https://pixi-vn.web.app/start/interface-react)
-- [Vue](https://pixi-vn.web.app/start/interface-vue)
-- [PixiJS](https://pixi-vn.web.app/start/interface-pixijs)
-
 ## Wiki
 
-- [Why Pixi’VN?](https://pixi-vn.web.app/start/why)
-  - [Ren'Py vs Pixi’VN](https://pixi-vn.web.app/start/versus-renpy)
-- [Quick Start](https://pixi-vn.web.app/start/getting-started)
-  - [Templates](https://pixi-vn.web.app/start/templates)
+- [Why Pixi’VN?](https://pixi-vn.com/start/why)
+  - [Ren'Py vs Pixi’VN](https://pixi-vn.com/start/versus-renpy)
+- [Quick Start](https://pixi-vn.com/start/getting-started)
+  - [Templates](https://pixi-vn.com/start/templates)
 - Make your first:
-  - [Visual Novel](https://pixi-vn.web.app/start/make-visual-novel)
-  - [Point & Click Adventure](https://pixi-vn.web.app/nqtr/make-point-and-click)
-  - [RPG game](https://pixi-vn.web.app/start/make-rpg)
-  - [IDE or graphical editor](https://pixi-vn.web.app/start/make-ide)
-  - [Game engine](https://pixi-vn.web.app/start/make-game-engine)
+  - [Visual Novel](https://pixi-vn.com/start/make-visual-novel)
+  - [Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)
+  - [RPG game](https://pixi-vn.com/start/make-rpg)
+  - [IDE or graphical editor](https://pixi-vn.com/start/make-ide)
+  - [Game engine](https://pixi-vn.com/start/make-game-engine)
 
 ## Prerequisites
 
@@ -56,69 +51,31 @@ Before starting, you must have the following tools installed:
   - [Visual Studio Code](https://code.visualstudio.com/)
   - [Cursor](https://www.cursor.com/)
   - [VSCodium](https://vscodium.com/)
-- (Recommended) [Git](https://git-scm.com/)
-  - A [GitHub account](https://github.com/)
 
 ## Project Initialization
 
 If you want to start from a new project, you can use the following command to initialize a new project with the Pixi’VN templates:
 
-```bash
-# npm
+```npm
 npm create pixi-vn@latest
-
-# yarn
-yarn create pixi-vn
-
-# pnpm
-pnpm create pixi-vn
-
-# bun
-bun create pixi-vn
-
-# deno
-deno init --npm pixi-vn
 ```
 
-You can see the list of available templates and interactive demos [here](https://pixi-vn.web.app/start/templates).
+You can see the list of available templates and interactive demos <DynamicLink href="/start/templates">here</DynamicLink>.
 
 After the project is initialized, open the project directory with your text editor (VSCode is recommended) and start developing your project.
 
-All templates include a `README.md` file with more information about the project.
-
 ## Installation
 
 To install the Pixi’VN package in an existing JavaScript project, use one of the following commands:
 
-```bash
-# npm
+```npm
 npm install @drincs/pixi-vn
-
-# yarn
-yarn add @drincs/pixi-vn
-
-# pnpm
-pnpm add @drincs/pixi-vn
-
-# bun
-bun add @drincs/pixi-vn
-
-# deno
-deno install npm:@drincs/pixi-vn
 ```
 
 ## Initialize
 
 Before using the Pixi’VN engine, you must initialize the game. You can do this by calling the `Game.init` method.
 
-This function has the following parameters:
-
-- `element`: The HTML element to append the canvas to.
-- `options`: Equivalent to the options you can use when initializing a [PixiJS Application](https://pixijs.com/8.x/guides/basics/getting-started#creating-an-application). The following options are mandatory:
-  - `width`: The width of the canvas.
-  - `height`: The height of the canvas.
-- `devtoolsOptions`: Equivalent to the options you can use when initializing the [PixiJS Devtools](https://pixi-vn.web.app/it/start/canvas#use-pixijs-devtools-with-pixivn).
-
 ```ts title="src/main.tsx"
 import { Game } from "@drincs/pixi-vn";
 
@@ -136,7 +93,7 @@ Game.init(body, {
   Game.start("start", {});
 });
 
-// read more here: https://pixi-vn.web.app/start/other-narrative-features.html#how-manage-the-end-of-the-game
+// read more here: https://pixi-vn.com/start/other-narrative-features.html#how-manage-the-end-of-the-game
 Game.onEnd(async (props) => {
   Game.clear();
   // navigate to main menu
@@ -178,4 +135,3 @@ body {
   overflow: hidden;
 }
 ```
-

package/dist/{HistoryChoiceMenuOption-BP9Tsbyd.d.ts → HistoryChoiceMenuOption-CS41KG13.d.ts}

@@ -1,6 +1,6 @@
 import { ChoiceInterface, StepLabelProps, StepLabelResult, CharacterInterface } from '@drincs/pixi-vn';
 import { Difference } from 'microdiff';
-import { a as StorageElementType } from './StorageElementType-DkJ394kq.js';
+import { S as StorageElementType } from './StorageElementType-C7ETezlL.js';
 
 type CloseType = "close";
 
@@ -179,4 +179,4 @@ type HistoryChoiceMenuOption = {
     hidden: boolean;
 };
 
-export type { ChoiceOptionInterface as C, DialogueInterface as D, HistoryStep as H, LabelIdType as L, NarrationHistory as N, OpenedLabel as O, StepLabelType as S, LabelRunModeType as a, CloseChoiceOptionInterface as b, CloseType as c, StepLabelPropsType as d, StepLabelResultType as e, StoredIndexedChoiceInterface as f, StoredChoiceInterface as g, HistoryChoiceMenuOption as h };
+export type { ChoiceOptionInterface as C, DialogueInterface as D, HistoryChoiceMenuOption as H, LabelIdType as L, NarrationHistory as N, OpenedLabel as O, StepLabelPropsType as S, CloseChoiceOptionInterface as a, CloseType as b, HistoryStep as c, LabelRunModeType as d, StepLabelResultType as e, StepLabelType as f, StoredChoiceInterface as g, StoredIndexedChoiceInterface as h };

package/dist/{HistoryChoiceMenuOption-DSSNUXEq.d.cts → HistoryChoiceMenuOption-DdwePsOm.d.cts}

@@ -1,6 +1,6 @@
 import { ChoiceInterface, StepLabelProps, StepLabelResult, CharacterInterface } from '@drincs/pixi-vn';
 import { Difference } from 'microdiff';
-import { a as StorageElementType } from './StorageElementType-DkJ394kq.cjs';
+import { S as StorageElementType } from './StorageElementType-C7ETezlL.cjs';
 
 type CloseType = "close";
 
@@ -179,4 +179,4 @@ type HistoryChoiceMenuOption = {
     hidden: boolean;
 };
 
-export type { ChoiceOptionInterface as C, DialogueInterface as D, HistoryStep as H, LabelIdType as L, NarrationHistory as N, OpenedLabel as O, StepLabelType as S, LabelRunModeType as a, CloseChoiceOptionInterface as b, CloseType as c, StepLabelPropsType as d, StepLabelResultType as e, StoredIndexedChoiceInterface as f, StoredChoiceInterface as g, HistoryChoiceMenuOption as h };
+export type { ChoiceOptionInterface as C, DialogueInterface as D, HistoryChoiceMenuOption as H, LabelIdType as L, NarrationHistory as N, OpenedLabel as O, StepLabelPropsType as S, CloseChoiceOptionInterface as a, CloseType as b, HistoryStep as c, LabelRunModeType as d, StepLabelResultType as e, StepLabelType as f, StoredChoiceInterface as g, StoredIndexedChoiceInterface as h };

package/dist/{StorageElementType-DkJ394kq.d.cts → StorageElementType-C7ETezlL.d.cts}

@@ -16,4 +16,4 @@ type StorageElementType = StorageElementInternalType | Record<string | number |
  */
 type StorageObjectType = Record<string | number | symbol, StorageElementType>;
 
-export type { StorageObjectType as S, StorageElementType as a };
+export type { StorageElementType as S, StorageObjectType as a };

package/dist/{StorageElementType-DkJ394kq.d.ts → StorageElementType-C7ETezlL.d.ts}

@@ -16,4 +16,4 @@ type StorageElementType = StorageElementInternalType | Record<string | number |
  */
 type StorageObjectType = Record<string | number | symbol, StorageElementType>;
 
-export type { StorageObjectType as S, StorageElementType as a };
+export type { StorageElementType as S, StorageObjectType as a };

package/dist/{StoredClassModel-a4pvgJXD.d.ts → StoredClassModel-C9mQxPg-.d.cts}

@@ -1,4 +1,4 @@
-import { a as StorageElementType } from './StorageElementType-DkJ394kq.js';
+import { S as StorageElementType } from './StorageElementType-C7ETezlL.cjs';
 
 /**
  * StoredClassModel is a abstract class that contains the methods to store a class in the game.
@@ -11,19 +11,19 @@ import { a as StorageElementType } from './StorageElementType-DkJ394kq.js';
  *         this.defaultName = props.name
  *         this.defaultSurname = props.surname
  *     }
- *     private defaultName: string = ""
+ *     readonly defaultName: string = ""
  *     get name(): string {
  *         return this.getStorageProperty<string>("name") || this.defaultName
  *     }
  *     set name(value: string) {
- *         this.setStorageProperty<string>("name", value)
+ *         this.setStorageProperty("name", value)
  *     }
- *     private defaultSurname?: string
+ *     readonly defaultSurname?: string
  *     get surname(): string | undefined {
  *         return this.getStorageProperty<string>("surname") || this.defaultSurname
  *     }
  *     set surname(value: string | undefined) {
- *         this.setStorageProperty<string>("surname", value)
+ *         this.setStorageProperty("surname", value)
  *     }
  * }
  * ```
@@ -41,7 +41,10 @@ declare class StoredClassModel {
     readonly id: string;
     private categoryId;
     /**
-     * @deprecated Remove the type parameter, it is not needed and it is not used in the implementation.
+     * Update a property in the storage.
+     * @param propertyName The name of the property to set.
+     * @param value The value to set. If is undefined, the property will be removed from the storage.
+     * @template T The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)
      */
     protected setStorageProperty<T>(propertyName: string, value: StorageElementType): void;
     /**

package/dist/{StoredClassModel-LtyakzOw.d.cts → StoredClassModel-upXPNQTp.d.ts}

@@ -1,4 +1,4 @@
-import { a as StorageElementType } from './StorageElementType-DkJ394kq.cjs';
+import { S as StorageElementType } from './StorageElementType-C7ETezlL.js';
 
 /**
  * StoredClassModel is a abstract class that contains the methods to store a class in the game.
@@ -11,19 +11,19 @@ import { a as StorageElementType } from './StorageElementType-DkJ394kq.cjs';
  *         this.defaultName = props.name
  *         this.defaultSurname = props.surname
  *     }
- *     private defaultName: string = ""
+ *     readonly defaultName: string = ""
  *     get name(): string {
  *         return this.getStorageProperty<string>("name") || this.defaultName
  *     }
  *     set name(value: string) {
- *         this.setStorageProperty<string>("name", value)
+ *         this.setStorageProperty("name", value)
  *     }
- *     private defaultSurname?: string
+ *     readonly defaultSurname?: string
  *     get surname(): string | undefined {
  *         return this.getStorageProperty<string>("surname") || this.defaultSurname
  *     }
  *     set surname(value: string | undefined) {
- *         this.setStorageProperty<string>("surname", value)
+ *         this.setStorageProperty("surname", value)
  *     }
  * }
  * ```
@@ -41,7 +41,10 @@ declare class StoredClassModel {
     readonly id: string;
     private categoryId;
     /**
-     * @deprecated Remove the type parameter, it is not needed and it is not used in the implementation.
+     * Update a property in the storage.
+     * @param propertyName The name of the property to set.
+     * @param value The value to set. If is undefined, the property will be removed from the storage.
+     * @template T The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)
      */
     protected setStorageProperty<T>(propertyName: string, value: StorageElementType): void;
     /**