@neutrinoparticles/js-v1.1 1.0.0
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.
- package/CHANGELOG.md +8 -0
- package/README.md +50 -0
- package/dist/neutrinoparticles.js-v1.1.umd.js +1350 -0
- package/dist/neutrinoparticles.js-v1.1.umd.js.map +1 -0
- package/package.json +39 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## CurrentVersion
|
|
4
|
+
|
|
5
|
+
- Initial JS v1.1 runtime with GPU geometry construction support
|
|
6
|
+
- All effect simulation state lives in a single ArrayBuffer; cloning an
|
|
7
|
+
effect instance is now a single buffer copy with no JS-side mirror
|
|
8
|
+
fields, enabling timeline scrubbing and rollback at near-memcpy speed.
|
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @neutrinoparticles/js-v1.1
|
|
2
|
+
|
|
3
|
+
Core JavaScript runtime library for simulating [NeutrinoParticles](https://neutrinoparticles.com/) effects (format **v1.1**).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
For most projects you should **not** install this package directly — install an
|
|
8
|
+
integration package instead. It pulls this core library in as a dependency:
|
|
9
|
+
|
|
10
|
+
- [`@neutrinoparticles/js-v1.1-pixi8`](https://www.npmjs.com/package/@neutrinoparticles/js-v1.1-pixi8) — PIXI.js v8
|
|
11
|
+
- [`@neutrinoparticles/js-v1.1-pixi7`](https://www.npmjs.com/package/@neutrinoparticles/js-v1.1-pixi7) — PIXI.js v7
|
|
12
|
+
- [`@neutrinoparticles/js-v1.1-phaser`](https://www.npmjs.com/package/@neutrinoparticles/js-v1.1-phaser) — Phaser 3
|
|
13
|
+
|
|
14
|
+
If you are writing a custom renderer:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @neutrinoparticles/js-v1.1
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Export Target in Editor
|
|
21
|
+
|
|
22
|
+
In the NeutrinoParticles Editor, set the export target to **JavaScript v1.1**.
|
|
23
|
+
|
|
24
|
+
After export you get a `.js` file (e.g. `my_effect.js`) containing the effect model.
|
|
25
|
+
|
|
26
|
+
## What Is This Package?
|
|
27
|
+
|
|
28
|
+
This is the v1.1 simulation engine. It advances particle state on the CPU and
|
|
29
|
+
packs the result into a **data texture**; the GPU reconstructs the particle
|
|
30
|
+
geometry in a vertex shader. The exported `.js` effect file references types
|
|
31
|
+
from this package.
|
|
32
|
+
|
|
33
|
+
Because geometry is reconstructed on the GPU, **every v1.1 renderer requires a
|
|
34
|
+
WebGL2 context** (`texelFetch` / integer bit ops are GLSL ES 3.00 features). The
|
|
35
|
+
integration packages surface this requirement in their own READMEs.
|
|
36
|
+
|
|
37
|
+
## v1.1 vs v1.0
|
|
38
|
+
|
|
39
|
+
v1.1 is a separate effect format with its own runtime and its own exporter
|
|
40
|
+
target. It is not a drop-in upgrade of v1.0 — effects must be re-exported as
|
|
41
|
+
**JavaScript v1.1**, and you must use a `js-v1.1-*` integration package. The
|
|
42
|
+
v1.0 runtime (`@neutrinoparticles/js-v1.0`) is unaffected and stays supported.
|
|
43
|
+
|
|
44
|
+
## Documentation
|
|
45
|
+
|
|
46
|
+
Full documentation at [neutrinoparticles.com](https://neutrinoparticles.com/en/docs/199).
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
Copyright (c) Yurii Miroshnyk. All rights reserved.
|