spryte 0.2.0 → 0.2.1

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 (2) hide show
  1. package/README.md +23 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ <img src="https://debuff.jp/spryte/icon.svg" alt="spryte" width="96">
2
+
1
3
  # spryte
2
4
 
3
5
  **Blazing fast 2D rendering for the web: 2–4× faster than the most popular renderer, at a ninth of its size.** Every number is checked pixel for pixel in [2dbench](https://github.com/debuffjp/2dbench), an open benchmark you can [run on your own device](https://debuffjp.github.io/2dbench/mobile.html).
@@ -31,6 +33,16 @@ function frame() {
31
33
  requestAnimationFrame(frame);
32
34
  ```
33
35
 
36
+ ## What it's for
37
+
38
+ Games are where spryte started, but anything that draws lots of moving 2D things in a browser fits:
39
+
40
+ - **Games:** bullet hells, particle effects, crowds, tile maps, sprite-sheet animation.
41
+ - **Data visualisation:** animated scatter plots, flow fields, live sensor and market data with thousands of points.
42
+ - **Creative coding and generative art:** particle systems, trails and shader effects, without a framework.
43
+ - **Interactive sites and product UI:** hero animations, confetti, backgrounds and effects that stay smooth on phones.
44
+ - **Simulations and education:** agent-based models, physics demos and visual explanations.
45
+
34
46
  ## Why spryte
35
47
 
36
48
  Against PixiJS 8 on the same machine, assets and simulation, over 3 interleaved rounds, after a pixel-parity gate (desktop Chrome, RTX 5060 laptop). The comparison survived an adversarial fairness review, which lowered two of our earlier numbers. Method, raw data and caveats are in [benchmarks](https://github.com/debuffjp/spryte/blob/main/docs/benchmarks.md).
@@ -57,6 +69,9 @@ draw.withShader(crt, () => draw.sprite(scene, 0, 0, { origin: [0, 0] }));
57
69
 
58
70
  ## Docs
59
71
 
72
+ - **Guides on debuff.jp:** [getting started](https://debuff.jp/spryte/getting-started), [sprites and frames](https://debuff.jp/spryte/sprites), [bulk sprites and particles](https://debuff.jp/spryte/bulk-sprites), [shapes and text](https://debuff.jp/spryte/shapes-and-text), [transforms and clipping](https://debuff.jp/spryte/transforms-and-clipping), [render targets and shaders](https://debuff.jp/spryte/render-targets-and-shaders), [pixel art](https://debuff.jp/spryte/pixel-art)
73
+ - **[Migrating from PixiJS](https://debuff.jp/spryte/migrating-from-pixijs):** the mental model, a mapping table, and moving just your hot path first
74
+ - [Changelog](https://github.com/debuffjp/spryte/blob/main/CHANGELOG.md)
60
75
  - [API reference](https://github.com/debuffjp/spryte/blob/main/docs/api.md)
61
76
  - [Architecture](https://github.com/debuffjp/spryte/blob/main/docs/architecture.md)
62
77
  - [Benchmarks and method](https://github.com/debuffjp/spryte/blob/main/docs/benchmarks.md)
@@ -71,6 +86,14 @@ draw.withShader(crt, () => draw.sprite(scene, 0, 0, { origin: [0, 0] }));
71
86
  - `draw.dispose()` releases every GPU resource and listener. Using a disposed `Draw` throws.
72
87
  - WebGL context loss is handled: drawing pauses while the context is lost (`draw.contextLost`), and textures re-upload after it's restored. Render targets come back blank. This is checked with a real GPU context loss in `npm run test:browser`.
73
88
 
89
+ ## Help and feedback
90
+
91
+ Questions, ideas and show-and-tell: [Discord](https://discord.gg/jshbDHSpCY). Bugs: [open an issue](https://github.com/debuffjp/spryte/issues/new/choose) with your browser, GPU and a small repro.
92
+
93
+ ## Sponsors
94
+
95
+ All of our projects are free and MIT licensed. [Sponsor on GitHub](https://github.com/sponsors/debuffjp) to keep them that way: from Power-up ($100/month) your logo goes here and on [debuff.jp](https://debuff.jp), with bigger placements as you level up. Studios after performance help or a bigger partnership: [greg@updog.jp](mailto:greg@updog.jp).
96
+
74
97
  ## Licence
75
98
 
76
99
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spryte",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Blazing fast 2D renderer for the web: 2–4× faster than the most popular one, at a ninth of its size. Verified in an open benchmark.",
5
5
  "keywords": [
6
6
  "2d",