@drincs/pixi-vn 0.4.0 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +96 -0
  2. package/dist/index.d.mts +8 -8
  3. package/dist/index.d.ts +8 -8
  4. package/dist/index.js +2 -2
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +3 -3
  7. package/dist/index.mjs.map +1 -1
  8. package/package.json +2 -2
package/README.md CHANGED
@@ -12,3 +12,99 @@ This allows the use of systems such as React, Vue, Angular, etc. to create much
12
12
  ## Wiki
13
13
 
14
14
  For more information, visit the [Web Page](https://pixi-vn.web.app/)
15
+
16
+ * [Why Pixi’VN?](https://pixi-vn.web.app/start/why.html)
17
+ * [Get Started](https://pixi-vn.web.app/start/getting-started.html)
18
+ * [Interface with JavaScript Framework](https://pixi-vn.web.app/start/interface.html)
19
+
20
+ ### First steps
21
+
22
+ * [Characters](https://pixi-vn.web.app/start/character.html)
23
+ * [Dialogue and Narration](https://pixi-vn.web.app/start/narration.html)
24
+ * [Choice Menus](https://pixi-vn.web.app/start/choices.html)
25
+ * [Label and Game Step](https://pixi-vn.web.app/start/labels.html)
26
+ * [Game Storage](https://pixi-vn.web.app/start/storage.html)
27
+ * [Flags Management](https://pixi-vn.web.app/start/flags.html)
28
+ * [Save and Load](https://pixi-vn.web.app/start/save.html)
29
+ * [Images and Animations](https://pixi-vn.web.app/start/images.html)
30
+
31
+ ### Advanced topics
32
+
33
+ * [Canvas Elements](https://pixi-vn.web.app/advanced/canvas-elements.html)
34
+ * [Animations and Effects](https://pixi-vn.web.app/advanced/animations-effects.html)
35
+ * [Tickers](https://pixi-vn.web.app/advanced/tickers.html)
36
+ * [Stored Classes](https://pixi-vn.web.app/advanced/stored-classes.html)
37
+ * [Intecept Events](https://pixi-vn.web.app/advanced/intercept-events.html)
38
+
39
+ ## Installation
40
+
41
+ ```bash
42
+ npm install @drincs/pixi-vn
43
+ ```
44
+
45
+ ## Usage
46
+
47
+ For the following example, we will use React to create the interface and Pixi'VN to manage the visual novel.
48
+
49
+ ```typescript
50
+ // main.tsx
51
+
52
+ import { GameWindowManager } from '@drincs/pixi-vn'
53
+ import { createRoot } from 'react-dom/client'
54
+ import App from './App'
55
+ import './index.css'
56
+
57
+ // Canvas setup with PIXI
58
+ const body = document.body
59
+ if (!body) {
60
+ throw new Error('body element not found')
61
+ }
62
+
63
+ GameWindowManager.initialize(body, 1920, 1080, {
64
+ backgroundColor: "#303030"
65
+ }).then(() => {
66
+ // React setup with ReactDOM
67
+ const root = document.getElementById('root')
68
+ if (!root) {
69
+ throw new Error('root element not found')
70
+ }
71
+
72
+ GameWindowManager.initializeHTMLLayout(root)
73
+ const reactRoot = createRoot(GameWindowManager.htmlLayout)
74
+
75
+ reactRoot.render(
76
+ <App />
77
+ )
78
+ })
79
+ ```
80
+
81
+ This is the HTML file that will be used to load the application.
82
+
83
+ ```html
84
+ <!-- index.html -->
85
+ <!doctype html>
86
+ <html lang="en">
87
+ <head>
88
+ <meta charset="UTF-8" />
89
+ <link rel="icon" type="image/svg+xml" href="/pixiVN.svg" />
90
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
91
+ <title>Pixi'VN</title>
92
+ </head>
93
+ <body>
94
+ <div id="root"></div>
95
+ <script type="module" src="/src/main.tsx"></script>
96
+ </body>
97
+ </html>
98
+ ```
99
+
100
+ ```css
101
+ /* index.css */
102
+ :root {
103
+ background-color: #242424;
104
+ }
105
+
106
+ body {
107
+ margin: 0;
108
+ display: flex;
109
+ }
110
+ ```
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as pixi_js from 'pixi.js';
2
- import { ContainerOptions, SpriteOptions, TextOptions, Container, Sprite, ContainerEvents, EventEmitter, Texture, TextureSourceLike, Text, UPDATE_PRIORITY, Ticker, TickerCallback, Application, ApplicationOptions } from 'pixi.js';
2
+ import { ContainerOptions, SpriteOptions, TextOptions, Container, Sprite, ContainerEvents, ContainerChild, EventEmitter, Texture, TextureSourceLike, Text, UPDATE_PRIORITY, Ticker, TickerCallback, Application, ApplicationOptions } from 'pixi.js';
3
3
  export { Assets } from 'pixi.js';
4
4
  import deepDiff from 'deep-diff';
5
5
 
@@ -531,13 +531,13 @@ declare class CanvasSprite<Memory extends SpriteOptions & ICanvasBaseMemory = IC
531
531
  * @param fn
532
532
  * @param context
533
533
  */
534
- on<T extends keyof ContainerEvents | keyof {
534
+ on<T extends keyof ContainerEvents<ContainerChild> | keyof {
535
535
  [K: symbol]: any;
536
536
  [K: {} & string]: any;
537
- }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents & {
537
+ }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents<ContainerChild> & {
538
538
  [K: symbol]: any;
539
539
  [K: {} & string]: any;
540
- }>[Extract<T, keyof ContainerEvents | keyof {
540
+ }>[Extract<T, keyof ContainerEvents<ContainerChild> | keyof {
541
541
  [K: symbol]: any;
542
542
  [K: {} & string]: any;
543
543
  }>]) => void, context?: any): this;
@@ -574,7 +574,7 @@ interface CanvasImageOptions extends SpriteOptions {
574
574
  * ```
575
575
  */
576
576
  declare class CanvasImage extends CanvasSprite<ICanvasImageMemory> {
577
- constructor(options?: CanvasImageOptions | Texture | undefined);
577
+ constructor(options?: CanvasImageOptions | Texture);
578
578
  get memory(): ICanvasImageMemory;
579
579
  set memory(memory: ICanvasImageMemory);
580
580
  imageLink: string;
@@ -642,13 +642,13 @@ declare class CanvasText extends Text implements CanvasBase<ICanvasTextMemory> {
642
642
  * @param fn
643
643
  * @param context
644
644
  */
645
- on<T extends keyof ContainerEvents | keyof {
645
+ on<T extends keyof ContainerEvents<ContainerChild> | keyof {
646
646
  [K: symbol]: any;
647
647
  [K: {} & string]: any;
648
- }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents & {
648
+ }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents<ContainerChild> & {
649
649
  [K: symbol]: any;
650
650
  [K: {} & string]: any;
651
- }>[Extract<T, keyof ContainerEvents | keyof {
651
+ }>[Extract<T, keyof ContainerEvents<ContainerChild> | keyof {
652
652
  [K: symbol]: any;
653
653
  [K: {} & string]: any;
654
654
  }>]) => void, context?: any): this;
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as pixi_js from 'pixi.js';
2
- import { ContainerOptions, SpriteOptions, TextOptions, Container, Sprite, ContainerEvents, EventEmitter, Texture, TextureSourceLike, Text, UPDATE_PRIORITY, Ticker, TickerCallback, Application, ApplicationOptions } from 'pixi.js';
2
+ import { ContainerOptions, SpriteOptions, TextOptions, Container, Sprite, ContainerEvents, ContainerChild, EventEmitter, Texture, TextureSourceLike, Text, UPDATE_PRIORITY, Ticker, TickerCallback, Application, ApplicationOptions } from 'pixi.js';
3
3
  export { Assets } from 'pixi.js';
4
4
  import deepDiff from 'deep-diff';
5
5
 
@@ -531,13 +531,13 @@ declare class CanvasSprite<Memory extends SpriteOptions & ICanvasBaseMemory = IC
531
531
  * @param fn
532
532
  * @param context
533
533
  */
534
- on<T extends keyof ContainerEvents | keyof {
534
+ on<T extends keyof ContainerEvents<ContainerChild> | keyof {
535
535
  [K: symbol]: any;
536
536
  [K: {} & string]: any;
537
- }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents & {
537
+ }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents<ContainerChild> & {
538
538
  [K: symbol]: any;
539
539
  [K: {} & string]: any;
540
- }>[Extract<T, keyof ContainerEvents | keyof {
540
+ }>[Extract<T, keyof ContainerEvents<ContainerChild> | keyof {
541
541
  [K: symbol]: any;
542
542
  [K: {} & string]: any;
543
543
  }>]) => void, context?: any): this;
@@ -574,7 +574,7 @@ interface CanvasImageOptions extends SpriteOptions {
574
574
  * ```
575
575
  */
576
576
  declare class CanvasImage extends CanvasSprite<ICanvasImageMemory> {
577
- constructor(options?: CanvasImageOptions | Texture | undefined);
577
+ constructor(options?: CanvasImageOptions | Texture);
578
578
  get memory(): ICanvasImageMemory;
579
579
  set memory(memory: ICanvasImageMemory);
580
580
  imageLink: string;
@@ -642,13 +642,13 @@ declare class CanvasText extends Text implements CanvasBase<ICanvasTextMemory> {
642
642
  * @param fn
643
643
  * @param context
644
644
  */
645
- on<T extends keyof ContainerEvents | keyof {
645
+ on<T extends keyof ContainerEvents<ContainerChild> | keyof {
646
646
  [K: symbol]: any;
647
647
  [K: {} & string]: any;
648
- }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents & {
648
+ }>(event: T, fn: (...args: EventEmitter.ArgumentMap<ContainerEvents<ContainerChild> & {
649
649
  [K: symbol]: any;
650
650
  [K: {} & string]: any;
651
- }>[Extract<T, keyof ContainerEvents | keyof {
651
+ }>[Extract<T, keyof ContainerEvents<ContainerChild> | keyof {
652
652
  [K: symbol]: any;
653
653
  [K: {} & string]: any;
654
654
  }>]) => void, context?: any): this;
package/dist/index.js CHANGED
@@ -665,7 +665,7 @@ function setMemorySprite(element, memory) {
665
665
 
666
666
  // src/classes/canvas/CanvasImage.ts
667
667
  var CanvasImage = class _CanvasImage extends CanvasSprite {
668
- constructor(options) {
668
+ constructor(options = import_pixi5.Texture.EMPTY) {
669
669
  super(options);
670
670
  this.imageLink = "";
671
671
  if (options && typeof options === "object" && "textureImage" in options && options.textureImage) {
@@ -1118,7 +1118,7 @@ function showImageWithDissolveTransition(tag, imageUrl, speed, priority) {
1118
1118
  }
1119
1119
 
1120
1120
  // src/constants.ts
1121
- var PIXIVN_VERSION = "0.4.0";
1121
+ var PIXIVN_VERSION = "0.4.2";
1122
1122
 
1123
1123
  // src/functions/SavesUtility.ts
1124
1124
  function getSaveData() {