@drincs/pixi-vn 1.9.0 → 1.9.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 (15) hide show
  1. package/README.md +45 -34
  2. package/dist/canvas.cjs +2 -2
  3. package/dist/canvas.d.cts +2 -2
  4. package/dist/canvas.d.ts +2 -2
  5. package/dist/canvas.mjs +1 -1
  6. package/dist/index.cjs +2 -2
  7. package/dist/index.d.cts +140 -9
  8. package/dist/index.d.ts +140 -9
  9. package/dist/index.mjs +2 -2
  10. package/dist/pixi/browser.js +163 -152
  11. package/dist/vite.cjs +4 -2
  12. package/dist/vite.d.cts +19 -0
  13. package/dist/vite.d.ts +19 -0
  14. package/dist/vite.mjs +4 -2
  15. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Pixi’VN - PixiJS Game Engine
2
2
 
3
- ![pixi-vn-cover](https://github.com/user-attachments/assets/28c41fe1-c539-4ebb-b7d4-8cb9f79e089e)
3
+ ![pixi-vn-cover](https://github.com/user-attachments/assets/6a4951d3-459f-4f8d-ae3d-1342a55570e9)
4
4
 
5
5
  <p align="center">
6
6
  <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn?label=version" alt="npm version"></a>
@@ -10,37 +10,59 @@
10
10
  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord"></a>
11
11
  </p>
12
12
 
13
- Pixi’VN is a very versatile and powerful story-driven engine. It is based on JavaScript/TypeScript and [PixiJS](https://pixijs.com/).
13
+ Pixi’VN is a very versatile and powerful story-driven engine. It is based on JavaScript/TypeScript and [PixiJS](https://pixijs.com/), and supports animated characters through [Spine 2D](https://esotericsoftware.com/) and [Live2D](https://www.live2d.com/).
14
14
 
15
- It provides the following features:
15
+ Pixi’VN aims to be an innovative and fast engine, and puts a strong emphasis on AI-assisted development: an AI agent can start your game, gain all the knowledge it needs about your project through [Agent Skills](#agent-skills), and test the game by launching it in a browser — with the ability to keep driving it from the outside while it plays.
16
16
 
17
- - narrative management
18
- - provides a 2D canvas
19
- - providing functionality to play sounds and music
20
- - storage to set and get game variables.
21
- - saves the current state of the entire game at each "story step" giving the possibility to go back
22
- - functionality to save and load the current state of the game.
17
+ You can use narrative languages that are able to take full advantage of the engine's features, as well as any custom features you add to your project. Currently supported:
23
18
 
24
- For a quick start, various [project templates](#project-initialization) are available. Less experienced developers can use these templates without much knowledge of JavaScript/TypeScript.
19
+ - [_ink_](https://pixi-vn.com/ink/ink)
25
20
 
26
- You have the option to use various types of narrative languages ​​(in addition to JavaScript/TypeScript). Currently you can use the following:
21
+ ## Templates
27
22
 
28
- - [_ink_](https://pixi-vn.com/ink/ink)
23
+ For a quick start, various project templates are available, built with React. Less experienced developers can use these templates without much knowledge of JavaScript/TypeScript.
24
+
25
+ - **[Visual Novel](https://pixi-vn.com/start/make-visual-novel)**: a classic dialogue-driven experience, with characters, backgrounds, and choices.
26
+ - **[Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)**: an adventure game where the player explores scenes and interacts with objects and characters.
27
+ - **[Interactive Fiction](https://pixi-vn.com/start/make-interactive-fiction)**: feels like reading a book. Unlike a visual novel, images are shown as vignettes, just as illustrations would appear on a page.
28
+
29
+ To create a new project from a template, run:
30
+
31
+ ```npm
32
+ npm create pixi-vn@latest
33
+ ```
34
+
35
+ ### Distribution
29
36
 
30
- 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**.
37
+ Pixi’VN is independent of any distribution technology, but strong emphasis is being placed on [Roves](https://roves.pixi-vn.com/), built by the same team behind Pixi’VN.
38
+
39
+ | Platform | [Roves](https://roves.pixi-vn.com/) | [Tauri](https://v2.tauri.app/) | [Electron](https://www.electronjs.org/) |
40
+ | ----------- | ----------------------------------- | ------------------------------ | --------------------------------------- |
41
+ | Windows | ✅ | ✅ | ✅ |
42
+ | macOS | ✅ | ✅ | ✅ |
43
+ | Linux | ✅ | ✅ | ✅ |
44
+ | Android | ✅ | ✅ | ❌ |
45
+ | iOS | 🚧 | ✅ | ❌ |
46
+ | Nintendo | 🚧 | ❌ | ❌ |
47
+ | PlayStation | 🚧 | ❌ | ❌ |
48
+ | Xbox | 🚧 | ❌ | ❌ |
31
49
 
32
50
  ## Wiki
33
51
 
34
- - [Why Pixi’VN?](https://pixi-vn.com/start/why)
35
- - [Ren'Py vs Pixi’VN](https://pixi-vn.com/start/versus-renpy)
36
52
  - [Quick Start](https://pixi-vn.com/start/getting-started)
37
53
  - [Templates](https://pixi-vn.com/start/templates)
38
- - Make your first:
39
- - [Visual Novel](https://pixi-vn.com/start/make-visual-novel)
40
- - [Point & Click Adventure](https://pixi-vn.com/nqtr/make-point-and-click)
41
- - [RPG game](https://pixi-vn.com/start/make-rpg)
42
- - [IDE or graphical editor](https://pixi-vn.com/start/make-ide)
43
- - [Game engine](https://pixi-vn.com/start/make-game-engine)
54
+ - Features:
55
+ - [Characters](https://pixi-vn.com/start/character)
56
+ - [Narration](https://pixi-vn.com/start/narration)
57
+ - [Assets](https://pixi-vn.com/start/assets)
58
+ - [Canvas WebGL/WebGPU](https://pixi-vn.com/start/canvas)
59
+ - [Sounds and music](https://pixi-vn.com/start/sound)
60
+ - [Storage](https://pixi-vn.com/start/storage)
61
+ - [User Interface (UI)](https://pixi-vn.com/start/interface)
62
+ - [Minigames](https://pixi-vn.com/start/minigames)
63
+ - [AI-Generated Content](https://pixi-vn.com/start/ai-generated-content)
64
+ - [Save and load](https://pixi-vn.com/start/save)
65
+ - [Distribution](https://pixi-vn.com/start/distribution)
44
66
 
45
67
  ## Prerequisites
46
68
 
@@ -52,18 +74,6 @@ Before starting, you must have the following tools installed:
52
74
  - [Cursor](https://www.cursor.com/)
53
75
  - [VSCodium](https://vscodium.com/)
54
76
 
55
- ## Project Initialization
56
-
57
- 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:
58
-
59
- ```npm
60
- npm create pixi-vn@latest
61
- ```
62
-
63
- You can see the list of available templates and interactive demos <DynamicLink href="/start/templates">here</DynamicLink>.
64
-
65
- After the project is initialized, open the project directory with your text editor (VSCode is recommended) and start developing your project.
66
-
67
77
  ## Installation
68
78
 
69
79
  To install the Pixi’VN package in an existing JavaScript project, use one of the following commands:
@@ -141,7 +151,7 @@ body {
141
151
  Pixi'VN ships a set of [Agent Skills](https://www.skills.sh/) that teach AI coding assistants (like Claude Code) how to correctly use each part of the engine. If you use Claude Code, you can install all of them into your project with:
142
152
 
143
153
  ```npm
144
- npx skills add DRincs-Productions/pixi-vn
154
+ npx skills add DRincs-Productions/pixi-vn --all
145
155
  ```
146
156
 
147
157
  This installs every skill below and prompts you to pick which ones to keep. To install only specific ones, add `--skill <name>` (repeat the flag to install several, e.g. `--skill canvas --skill sound`). Use `--list` instead of installing to just see what's available. Available skills:
@@ -155,5 +165,6 @@ This installs every skill below and prompts you to pick which ones to keep. To i
155
165
  - `saves` — exporting/restoring game state and persisting save files
156
166
  - `sound` — music, sound effects and audio channels
157
167
  - `storage` — game variables, flags and stored classes
168
+ - `testing` — driving/inspecting a running game from an AI agent or script via `Game.testing`, for automated play-testing
158
169
  - `ui` — mounting HTML/PixiJS UI layers over the canvas, screen navigation, theming, and connecting UI to storage
159
170
  - `migration` — upgrading an existing project to the current version