Skip to content

Commit f59ab8e

Browse files
committed
📝 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.
1 parent 234f530 commit f59ab8e

File tree

6 files changed

+1166
-1202
lines changed

6 files changed

+1166
-1202
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ _Create stunning RGB lighting effects with modern tools_
1313

1414
</div>
1515

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.
1717

1818
## ⚡ Features
1919

2020
- **🔷 Modern TypeScript** - Full type safety prevents runtime errors
2121
- **🔮 Three.js Integration** - Powerful WebGL rendering capabilities
2222
- **🎨 Canvas 2D Support** - Traditional drawing API for simpler effects
2323
- **⚡ Hot Reloading** - Instant visual feedback while coding
24-
- **🕹️ Declarative Controls** - Define UI elements with simple HTML
25-
- **⚙️ Optimized Build Pipeline** - Production-ready effects
24+
- **🧩 Decorator-Based Controls** - Define UI elements with TypeScript decorators
25+
- **⚙️ Optimized Build Pipeline** - Production-ready effects with Vite
2626
- **🧪 Testing Framework** - Maintain quality with Vitest
2727
- **🤖 AI-Assisted Development** - Create effects with AI assistance
2828

@@ -89,16 +89,15 @@ A vibrant particle system with glowing effects using Canvas 2D rendering.
8989

9090
## 💻 Development Workflow
9191

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/`
9393

9494
```
9595
effects/your-effect-name/
9696
├── fragment.glsl # Shader code
97-
├── main.ts # Effect implementation
98-
└── template.html # HTML template with controls
97+
└── main.ts # Effect implementation with decorators
9998
```
10099

101-
2. **Register** your effect in `src/index.ts`
100+
2. **Register** your effect in the effects registry
102101

103102
3. **Develop** with live reloading
104103

@@ -118,10 +117,10 @@ A vibrant particle system with glowing effects using Canvas 2D rendering.
118117

119118
Creating a new effect is easy with the LightScript framework:
120119

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
123122
3. Create GLSL shader for visuals
124-
4. Implement TypeScript class extending BaseEffect
123+
4. Implement TypeScript class extending BaseEffect with the `@Effect` decorator
125124
5. Register your effect
126125

127126
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

Comments
 (0)