@needle-tools/engine 4.13.0 → 4.13.1-next.6cb1b73

package/CHANGELOG.md

@@ -4,9 +4,16 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.13.1] - 2026-02-13
+- Improved code documentation across the engine
+- Improved ContactShadows to allow updating darkness and opacity dynamically at runtime
+- Fix: Support for Lightmaps and ReflectionProbes on the same object
+- Fix: Eventlist bug with instantiation ([Forum post](<https://forum.needle.tools/t/camera-orbit-controls-nan-in-new-scene/2779/6>))
+
 ## [4.13.0] - 2026-02-10
 - **NEW**: Needle Engine MaterialX loader added to core. No extra dependency to @needle-tools/materialx is required anymore
-- Fix: ContactShadows not correctly rendering anymore
+- Fix: ContactShadows rendering
+- Fix: Memory issue caused by ReflectionProbes component
 
 ## [4.12.5] - 2026-02-09
 - Update three.js dependency

package/README.md

@@ -50,6 +50,43 @@ npm install @needle-tools/engine
 
 **Explore Examples:** [Try our interactive samples](https://engine.needle.tools/samples) to see what's possible ⚡
 
+## Basic Usage
+
+### Creating a Custom Component
+
+```typescript
+import { Behaviour, serializable } from "@needle-tools/engine";
+
+export class MyComponent extends Behaviour {
+    @serializable()
+    speed: number = 1;
+
+    start() {
+        console.log("Component started on:", this.gameObject.name);
+    }
+
+    update() {
+        this.gameObject.rotateY(this.context.time.deltaTime * this.speed);
+    }
+}
+```
+
+### Using Lifecycle Hooks (without components)
+
+```typescript
+import { onStart, onUpdate } from "@needle-tools/engine";
+
+onStart((context) => {
+    console.log("Engine started!");
+});
+
+onUpdate((context) => {
+    // Called every frame
+});
+```
+
+[→ See API Documentation](https://engine.needle.tools/docs/api/latest)
+
 ---
 
 *Available under commercial and educational licenses*