@drincs/pixi-vn 0.6.5 → 0.6.6

package/README.md

@@ -2,7 +2,7 @@
 
 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 + [Templates](https://pixi-vn.web.app/start/getting-started.html#pivi-vn-templates) provides a complete solution and is in effect a visual novel engine.
+Pixi’VN + [Templates](#project-initialization) provides a complete solution and is in effect a visual novel engine.
 
 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.
 
@@ -39,17 +39,63 @@ For more information, visit the [Web Page](https://pixi-vn.web.app/)
 * [Stored Classes](https://pixi-vn.web.app/advanced/stored-classes.html)
 * [Intecept Events](https://pixi-vn.web.app/advanced/intercept-events.html)
 
-## Installation
+## Prerequisites
+
+* [Node.js](https://nodejs.org/) version 18 or higher.
+* Text Editor with TypeScript support.
+  * [Visual Studio Code](https://code.visualstudio.com/) is recommended.
+
+## Project Initialization
+
+To initialize a new project, you can use the following command:
 
 ```bash
+# npm
+npm create pixi-vn@latest
+
+# yarn
+yarn create pixi-vn@latest
+
+# pnpm
+pnpm create pixi-vn@latest
+
+# bun
+bun create pixi-vn@latest
+```
+
+The supported template presets are:
+
+**[Basic Visual Novel - Web page (Vite + React + MUI joy)](https://github.com/DRincs-Productions/pixi-vn-react-template)**
+
+( More templates will be added in the future, see this [issue](https://github.com/DRincs-Productions/pixi-vn/issues/162) for more information )
+
+After the project is initialized, you can open the project directory with your text editor (VSCode is recommended) and start developing your visual novel.
+
+Into all templates there is a `README.md` file with more information about the project.
+
+## Package Installation
+
+For installing the Pixi’VN package, you can use the following command:
+
+```bash
+# npm
 npm install @drincs/pixi-vn
+
+# yarn
+yarn add @drincs/pixi-vn
+
+# pnpm
+pnpm add @drincs/pixi-vn
+
+# bun
+bun add @drincs/pixi-vn
 ```
 
 ## Usage
 
 For the following example, we will use React to create the interface and Pixi'VN to manage the visual novel.
 
-```typescript
+```tsx
 // main.tsx
 
 import { GameWindowManager } from '@drincs/pixi-vn'

package/dist/classes/CharacterBaseModel.js

@@ -567,61 +567,6 @@ function geTickerInstanceById(tickerId, args, duration, priority) {
   }
 }
 
-// src/classes/StoredClassModel.ts
-var StoredClassModel = class {
-  /**
-   * @param categoryId The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.
-   * @param id The id of instance of the class. This id must be unique for the category.
-   */
-  constructor(categoryId, id) {
-    this.categoryId = categoryId;
-    this._id = id;
-  }
-  /**
-   * Is id of the stored class. is unique for this class.
-   */
-  get id() {
-    return this._id;
-  }
-  /**
-   * 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.
-   */
-  setStorageProperty(propertyName, value) {
-    let storage = GameStorageManager.getVariable(this.categoryId);
-    if (!storage) {
-      storage = {};
-    }
-    if (!storage.hasOwnProperty(this.id)) {
-      storage[this.id] = {};
-    }
-    if (value === void 0 || value === null) {
-      if (storage[this.id].hasOwnProperty(propertyName)) {
-        delete storage[this.id][propertyName];
-      }
-    } else {
-      storage[this.id] = __spreadProps(__spreadValues({}, storage[this.id]), { [propertyName]: value });
-    }
-    if (Object.keys(storage[this.id]).length === 0) {
-      delete storage[this.id];
-    }
-    GameStorageManager.setVariable(this.categoryId, storage);
-  }
-  /**
-   * Get a property from the storage.
-   * @param propertyName The name of the property to get.
-   * @returns The value of the property. If the property is not found, returns undefined.
-   */
-  getStorageProperty(propertyName) {
-    let storage = GameStorageManager.getVariable(this.categoryId);
-    if (storage && storage.hasOwnProperty(this.id) && storage[this.id].hasOwnProperty(propertyName)) {
-      return storage[this.id][propertyName];
-    }
-    return void 0;
-  }
-};
-
 // src/classes/ticker/TickerBase.ts
 var TickerBase = class {
   /**
@@ -943,6 +888,61 @@ ZoomTicker = __decorateClass([
 // src/constants.ts
 var Repeat = "repeat";
 
+// src/classes/StoredClassModel.ts
+var StoredClassModel = class {
+  /**
+   * @param categoryId The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.
+   * @param id The id of instance of the class. This id must be unique for the category.
+   */
+  constructor(categoryId, id) {
+    this.categoryId = categoryId;
+    this._id = id;
+  }
+  /**
+   * Is id of the stored class. is unique for this class.
+   */
+  get id() {
+    return this._id;
+  }
+  /**
+   * 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.
+   */
+  setStorageProperty(propertyName, value) {
+    let storage = GameStorageManager.getVariable(this.categoryId);
+    if (!storage) {
+      storage = {};
+    }
+    if (!storage.hasOwnProperty(this.id)) {
+      storage[this.id] = {};
+    }
+    if (value === void 0 || value === null) {
+      if (storage[this.id].hasOwnProperty(propertyName)) {
+        delete storage[this.id][propertyName];
+      }
+    } else {
+      storage[this.id] = __spreadProps(__spreadValues({}, storage[this.id]), { [propertyName]: value });
+    }
+    if (Object.keys(storage[this.id]).length === 0) {
+      delete storage[this.id];
+    }
+    GameStorageManager.setVariable(this.categoryId, storage);
+  }
+  /**
+   * Get a property from the storage.
+   * @param propertyName The name of the property to get.
+   * @returns The value of the property. If the property is not found, returns undefined.
+   */
+  getStorageProperty(propertyName) {
+    let storage = GameStorageManager.getVariable(this.categoryId);
+    if (storage && storage.hasOwnProperty(this.id) && storage[this.id].hasOwnProperty(propertyName)) {
+      return storage[this.id][propertyName];
+    }
+    return void 0;
+  }
+};
+
 // src/functions/ExportUtility.ts
 function createExportableElement(element) {
   try {
@@ -1776,7 +1776,7 @@ _GameWindowManager._currentTickersTimeouts = {};
 var GameWindowManager = _GameWindowManager;
 
 // src/classes/CharacterBaseModel.ts
-var CharacterBaseModel = class extends StoredClassModel {
+var CharacterBaseModel2 = class extends StoredClassModel {
   /**
    * @param id The id of the character.
    * @param props The properties of the character.
@@ -1834,6 +1834,6 @@ var CharacterBaseModel = class extends StoredClassModel {
   }
 };
 
-module.exports = CharacterBaseModel;
+module.exports = CharacterBaseModel2;
 //# sourceMappingURL=CharacterBaseModel.js.map
 //# sourceMappingURL=CharacterBaseModel.js.map