You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
📝 Update documentation for decorator-based control system
Replace HTML template references with TypeScript decorators throughout docs
This change updates all documentation to reflect the new decorator-based
control system:
- Remove HTML template examples and references across all docs
- Update code examples to use @effect and control decorators
- Add documentation for advanced decorator techniques
- Update project structure descriptions to match core module system
- Add build system & plugins documentation
The documentation now properly reflects the architectural changes made
in the recent framework restructuring.
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,16 @@ _Create stunning RGB lighting effects with modern tools_
13
13
14
14
</div>
15
15
16
-
LightScript Workshop is a modern TypeScript framework for creating beautiful RGB lighting effects for [SignalRGB](https://signalrgb.com/). Transform the way you build Lightscripts with a type-safe, component-based approach featuring hot reloading, WebGL integration, and an efficient build system.
16
+
LightScript Workshop is a modern TypeScript framework for creating beautiful RGB lighting effects for [SignalRGB](https://signalrgb.com/). Transform the way you build Lightscripts with a type-safe, decorator-based approach featuring hot reloading, WebGL integration, and an efficient build system.
17
17
18
18
## ⚡ Features
19
19
20
20
-**🔷 Modern TypeScript** - Full type safety prevents runtime errors
-**🧩 Decorator-Based Controls** - Define UI elements with TypeScript decorators
25
+
-**⚙️ Optimized Build Pipeline** - Production-ready effects with Vite
26
26
-**🧪 Testing Framework** - Maintain quality with Vitest
27
27
-**🤖 AI-Assisted Development** - Create effects with AI assistance
28
28
@@ -89,16 +89,15 @@ A vibrant particle system with glowing effects using Canvas 2D rendering.
89
89
90
90
## 💻 Development Workflow
91
91
92
-
1.**Create** a new effect directory in `src/effects/your-effect-name/`
92
+
1.**Create** a new effect directory in `effects/your-effect-name/`
93
93
94
94
```
95
95
effects/your-effect-name/
96
96
├── fragment.glsl # Shader code
97
-
├── main.ts # Effect implementation
98
-
└── template.html # HTML template with controls
97
+
└── main.ts # Effect implementation with decorators
99
98
```
100
99
101
-
2.**Register** your effect in `src/index.ts`
100
+
2.**Register** your effect in the effects registry
102
101
103
102
3.**Develop** with live reloading
104
103
@@ -118,10 +117,10 @@ A vibrant particle system with glowing effects using Canvas 2D rendering.
118
117
119
118
Creating a new effect is easy with the LightScript framework:
120
119
121
-
1. Create effect directory structure
122
-
2. Define HTML template with controls
120
+
1. Create effect directory structure in `effects/`
121
+
2. Define controls using TypeScript decorators in your effect class
123
122
3. Create GLSL shader for visuals
124
-
4. Implement TypeScript class extending BaseEffect
123
+
4. Implement TypeScript class extending BaseEffect with the `@Effect` decorator
125
124
5. Register your effect
126
125
127
126
Check the [Developer Guide](/docs/developer-guide.md) for a complete walkthrough or try the [AI-Assisted Development](/docs/ai-assisted-development.md) approach for faster results.
0 commit comments