cinematic-renderer2d 0.2.0 → 0.3.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/README.md +43 -4
- package/dist/angular.cjs +50 -50
- package/dist/angular.cjs.map +1 -1
- package/dist/angular.js +50 -50
- package/dist/angular.js.map +1 -1
- package/dist/cli/index.js +2 -1
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +48 -48
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +583 -1
- package/dist/index.d.ts +583 -1
- package/dist/index.js +48 -48
- package/dist/index.js.map +1 -1
- package/dist/metafile-cjs.json +1 -1
- package/dist/metafile-esm.json +1 -1
- package/dist/react.cjs +26 -26
- package/dist/react.cjs.map +1 -1
- package/dist/react.js +26 -26
- package/dist/react.js.map +1 -1
- package/docs/API.md +110 -0
- package/docs/EXAMPLES.md +1 -1
- package/docs/GETTING_STARTED.md +2 -2
- package/docs/NAVIGATION.md +5 -5
- package/docs/README.md +3 -3
- package/docs/TUTORIALS.md +422 -8
- package/docs/index.html +3 -3
- package/package.json +11 -5
package/README.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
High-performance, framework-agnostic NPM library that renders cinematic experiences from JSON specifications targeting 60-120fps performance across web frameworks.
|
|
4
4
|
|
|
5
|
+
## 🎮 Interactive Playground
|
|
6
|
+
|
|
7
|
+
**[Try it Live!](https://cinematicrenderer2d.purpuldigital.com)** - Explore examples and create your own cinematic experiences
|
|
8
|
+
|
|
5
9
|
## Features
|
|
6
10
|
|
|
7
11
|
- 🚀 **High Performance**: Targets 60-120fps with optimized rendering backends and precompiled animations
|
|
@@ -22,6 +26,7 @@ High-performance, framework-agnostic NPM library that renders cinematic experien
|
|
|
22
26
|
- 🌫️ **New Layer Types**: Fog, enhanced vignette, parallax groups, and glow effects
|
|
23
27
|
- 🔄 **State Machine**: Well-defined renderer and scene states with lifecycle management
|
|
24
28
|
- 📦 **Asset Preloader**: Intelligent preloading with caching and priority loading
|
|
29
|
+
- 🔷 **Shape Layers (NEW)**: Native geometric shapes (circles, rectangles, stars, polygons) with full animation support
|
|
25
30
|
|
|
26
31
|
## Installation
|
|
27
32
|
|
|
@@ -33,6 +38,8 @@ npm install cinematic-renderer2d
|
|
|
33
38
|
|
|
34
39
|
📚 **[Complete Documentation](./docs/index.html)** - Interactive documentation landing page
|
|
35
40
|
|
|
41
|
+
🎮 **[Live Playground](https://cinematicrenderer2d.purpuldigital.com)** - Try examples and create your own
|
|
42
|
+
|
|
36
43
|
### Quick Links
|
|
37
44
|
- 🚀 [Getting Started Guide](./docs/GETTING_STARTED.md) - Installation and quick start
|
|
38
45
|
- 📖 [API Reference](./docs/API.md) - Complete API documentation
|
|
@@ -40,7 +47,7 @@ npm install cinematic-renderer2d
|
|
|
40
47
|
- ⚛️ [React Integration](./docs/REACT_INTEGRATION.md) - Using with React
|
|
41
48
|
- 🅰️ [Angular Integration](./docs/ANGULAR_INTEGRATION.md) - Using with Angular
|
|
42
49
|
- ⚡ [Performance Guide](./docs/PERFORMANCE.md) - Optimization tips
|
|
43
|
-
-
|
|
50
|
+
- 🎓 [Tutorials](./docs/TUTORIALS.md) - Step-by-step tutorials including Shape Layers
|
|
44
51
|
|
|
45
52
|
## Quick Start
|
|
46
53
|
|
|
@@ -389,6 +396,38 @@ interface AnimationTrackSpec {
|
|
|
389
396
|
}
|
|
390
397
|
```
|
|
391
398
|
|
|
399
|
+
#### Shape Layer (NEW) 🔷
|
|
400
|
+
```json
|
|
401
|
+
{
|
|
402
|
+
"type": "shape",
|
|
403
|
+
"config": {
|
|
404
|
+
"shapeType": "circle",
|
|
405
|
+
"radius": 50,
|
|
406
|
+
"x": "50%",
|
|
407
|
+
"y": "50%",
|
|
408
|
+
"fillColor": "#ff6b6b",
|
|
409
|
+
"strokeColor": "#ffffff",
|
|
410
|
+
"strokeWidth": 2,
|
|
411
|
+
"opacity": 0.8,
|
|
412
|
+
"rotation": 0,
|
|
413
|
+
"scaleX": 1,
|
|
414
|
+
"scaleY": 1
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
**Supported Shape Types:**
|
|
420
|
+
- `rectangle` - Configurable width and height
|
|
421
|
+
- `square` - Configurable size
|
|
422
|
+
- `circle` - Configurable radius
|
|
423
|
+
- `ellipse` - Configurable radiusX and radiusY
|
|
424
|
+
- `triangle` - Custom vertices
|
|
425
|
+
- `trapezoid` - Configurable top/bottom widths and height
|
|
426
|
+
- `polygon` - Configurable sides (≥3) and radius
|
|
427
|
+
- `star` - Configurable points (≥3), inner/outer radius
|
|
428
|
+
|
|
429
|
+
**All shape properties are fully animatable!**
|
|
430
|
+
|
|
392
431
|
### Canvas2D Layers
|
|
393
432
|
|
|
394
433
|
#### Particles Layer
|
|
@@ -944,7 +983,7 @@ This project follows semantic versioning and uses changesets for release managem
|
|
|
944
983
|
### Development Setup
|
|
945
984
|
|
|
946
985
|
```bash
|
|
947
|
-
git clone https://github.com/rvshekhar10/
|
|
986
|
+
git clone https://github.com/rvshekhar10/cinematicRenderer2D.git
|
|
948
987
|
cd cinematic-renderer2d
|
|
949
988
|
npm install
|
|
950
989
|
npm run dev
|
|
@@ -973,6 +1012,6 @@ MIT License - see [LICENSE](LICENSE) file for details.
|
|
|
973
1012
|
## Support
|
|
974
1013
|
|
|
975
1014
|
- 📖 **Documentation**: This README and TypeScript definitions
|
|
976
|
-
- 🐛 **Issues**: [GitHub Issues](https://github.com/rvshekhar10/
|
|
977
|
-
- 💬 **Discussions**: [GitHub Discussions](https://github.com/rvshekhar10/
|
|
1015
|
+
- 🐛 **Issues**: [GitHub Issues](https://github.com/rvshekhar10/cinematicRenderer2D/issues)
|
|
1016
|
+
- 💬 **Discussions**: [GitHub Discussions](https://github.com/rvshekhar10/cinematicRenderer2D/discussions)
|
|
978
1017
|
- 📧 **Email**: support@cinematicrenderer2d.com
|