@series-inc/rundot-3d-engine 0.3.0 → 0.4.0

package/docs/systems/LightingSystem.md

@@ -1,101 +1,101 @@
-# LightingSystem
-
-Lighting components for Three.js scenes with directional and ambient lights.
-
-## Quick Start
-
-```typescript
-import { DirectionalLightComponentThree, AmbientLightComponentThree } from "@series-ai/rundot-3d-engine/systems"
-import * as THREE from "three"
-
-// Add directional light (sun)
-const sunLight = new GameObject("Sun")
-sunLight.addComponent(new DirectionalLightComponentThree(
-    0xffffff,  // Color
-    1.0        // Intensity
-))
-sunLight.position.set(10, 20, 10)
-
-// Add ambient light (fill light)
-const ambient = new GameObject("Ambient")
-ambient.addComponent(new AmbientLightComponentThree(
-    0x404040,  // Color
-    0.5        // Intensity
-))
-```
-
-## Common Use Cases
-
-### Basic Scene Lighting
-
-```typescript
-class MyGame extends VenusGame {
-    protected async onStart(): Promise<void> {
-        // Sun light
-        const sun = new GameObject("Sun")
-        const sunLight = new DirectionalLightComponentThree(0xffffff, 1.5)
-        sun.addComponent(sunLight)
-        sun.position.set(10, 20, 5)
-        sun.lookAt(0, 0, 0)
-        
-        // Ambient fill
-        const ambient = new GameObject("Ambient")
-        ambient.addComponent(new AmbientLightComponentThree(0x404040, 0.4))
-    }
-}
-```
-
-### Shadows
-
-```typescript
-// Enable shadows in VenusGame config
-protected getConfig(): VenusGameConfig {
-    return {
-        shadowMapEnabled: true,
-        shadowMapType: "vsm"
-    }
-}
-
-// Directional lights cast shadows automatically
-// Configure shadow camera for better quality
-const sunLight = sun.getComponent(DirectionalLightComponentThree)
-if (sunLight) {
-    const light = sunLight.getLight()
-    light.shadow.camera.left = -50
-    light.shadow.camera.right = 50
-    light.shadow.camera.top = 50
-    light.shadow.camera.bottom = -50
-    light.shadow.camera.far = 100
-}
-```
-
-## API Overview
-
-### DirectionalLightComponentThree
-- `new DirectionalLightComponentThree(color, intensity)` - Create directional light
-- `getLight(): THREE.DirectionalLight` - Get Three.js light
-- `setIntensity(intensity)` - Change brightness
-- `setColor(color)` - Change color
-
-### AmbientLightComponentThree
-- `new AmbientLightComponentThree(color, intensity)` - Create ambient light
-- `getLight(): THREE.AmbientLight` - Get Three.js light
-
-## Light Types
-
-### Directional Light
-- Simulates sun/moon
-- Parallel rays
-- Casts shadows
-- Position determines direction
-
-### Ambient Light
-- Uniform lighting from all directions
-- No shadows
-- Fill light to prevent pure black
-
-## Related Systems
-
-- [VenusGame](../core/VenusGame.md) - Shadow configuration
-- [GameObject](../core/GameObject.md) - Attach lights to objects
-
+# LightingSystem
+
+Lighting components for Three.js scenes with directional and ambient lights.
+
+## Quick Start
+
+```typescript
+import { DirectionalLightComponentThree, AmbientLightComponentThree } from "@series-ai/rundot-3d-engine/systems"
+import * as THREE from "three"
+
+// Add directional light (sun)
+const sunLight = new GameObject("Sun")
+sunLight.addComponent(new DirectionalLightComponentThree(
+    0xffffff,  // Color
+    1.0        // Intensity
+))
+sunLight.position.set(10, 20, 10)
+
+// Add ambient light (fill light)
+const ambient = new GameObject("Ambient")
+ambient.addComponent(new AmbientLightComponentThree(
+    0x404040,  // Color
+    0.5        // Intensity
+))
+```
+
+## Common Use Cases
+
+### Basic Scene Lighting
+
+```typescript
+class MyGame extends VenusGame {
+    protected async onStart(): Promise<void> {
+        // Sun light
+        const sun = new GameObject("Sun")
+        const sunLight = new DirectionalLightComponentThree(0xffffff, 1.5)
+        sun.addComponent(sunLight)
+        sun.position.set(10, 20, 5)
+        sun.lookAt(0, 0, 0)
+        
+        // Ambient fill
+        const ambient = new GameObject("Ambient")
+        ambient.addComponent(new AmbientLightComponentThree(0x404040, 0.4))
+    }
+}
+```
+
+### Shadows
+
+```typescript
+// Enable shadows in VenusGame config
+protected getConfig(): VenusGameConfig {
+    return {
+        shadowMapEnabled: true,
+        shadowMapType: "vsm"
+    }
+}
+
+// Directional lights cast shadows automatically
+// Configure shadow camera for better quality
+const sunLight = sun.getComponent(DirectionalLightComponentThree)
+if (sunLight) {
+    const light = sunLight.getLight()
+    light.shadow.camera.left = -50
+    light.shadow.camera.right = 50
+    light.shadow.camera.top = 50
+    light.shadow.camera.bottom = -50
+    light.shadow.camera.far = 100
+}
+```
+
+## API Overview
+
+### DirectionalLightComponentThree
+- `new DirectionalLightComponentThree(color, intensity)` - Create directional light
+- `getLight(): THREE.DirectionalLight` - Get Three.js light
+- `setIntensity(intensity)` - Change brightness
+- `setColor(color)` - Change color
+
+### AmbientLightComponentThree
+- `new AmbientLightComponentThree(color, intensity)` - Create ambient light
+- `getLight(): THREE.AmbientLight` - Get Three.js light
+
+## Light Types
+
+### Directional Light
+- Simulates sun/moon
+- Parallel rays
+- Casts shadows
+- Position determines direction
+
+### Ambient Light
+- Uniform lighting from all directions
+- No shadows
+- Fill light to prevent pure black
+
+## Related Systems
+
+- [VenusGame](../core/VenusGame.md) - Shadow configuration
+- [GameObject](../core/GameObject.md) - Attach lights to objects
+

package/docs/systems/ParticleSystem.md

@@ -1,44 +1,44 @@
-# ParticleSystem
-
-Flexible particle system for visual effects like smoke, fire, explosions, and magic.
-
-## Quick Start
-
-```typescript
-import { ParticleSystemPrefabComponent } from "@series-ai/rundot-3d-engine/systems"
-
-// Particles are typically created from prefabs
-// See prefab documentation for particle configuration
-```
-
-## Common Use Cases
-
-### Explosion Effect
-
-Particles are configured in prefab JSON with properties:
-- Emission rate
-- Particle lifetime
-- Velocity curves
-- Color gradients
-- Size over time
-- Sprite sheets
-
-### Smoke Trail
-
-Configure particles to:
-- Emit continuously
-- Move upward
-- Fade out over time
-- Scale up gradually
-
-## API Overview
-
-- `ParticleSystemPrefabComponent` - Prefab-based particle emitter
-- Configure via prefab JSON definitions
-- Supports sprite sheets for animated particles
-
-## Related Systems
-
-- [PrefabSystem](PrefabSystem.md) - Particle configuration
-- [GameObject](../core/GameObject.md) - Attach particles to objects
-
+# ParticleSystem
+
+Flexible particle system for visual effects like smoke, fire, explosions, and magic.
+
+## Quick Start
+
+```typescript
+import { ParticleSystemPrefabComponent } from "@series-ai/rundot-3d-engine/systems"
+
+// Particles are typically created from prefabs
+// See prefab documentation for particle configuration
+```
+
+## Common Use Cases
+
+### Explosion Effect
+
+Particles are configured in prefab JSON with properties:
+- Emission rate
+- Particle lifetime
+- Velocity curves
+- Color gradients
+- Size over time
+- Sprite sheets
+
+### Smoke Trail
+
+Configure particles to:
+- Emit continuously
+- Move upward
+- Fade out over time
+- Scale up gradually
+
+## API Overview
+
+- `ParticleSystemPrefabComponent` - Prefab-based particle emitter
+- Configure via prefab JSON definitions
+- Supports sprite sheets for animated particles
+
+## Related Systems
+
+- [PrefabSystem](PrefabSystem.md) - Particle configuration
+- [GameObject](../core/GameObject.md) - Attach particles to objects
+

package/docs/systems/PrefabSystem.md

@@ -1,60 +1,60 @@
-# PrefabSystem
-
-Prefab system for instantiating pre-configured GameObjects with components from JSON definitions.
-
-## Quick Start
-
-```typescript
-import { PrefabLoader, PrefabCollection } from "@series-ai/rundot-3d-engine/systems"
-
-// Load prefabs (done via StowKitSystem)
-const prefabs = await StowKitSystem.getInstance().loadFromBuildJson(buildJson, config)
-
-// Instantiate prefab
-const prefab = prefabs.getPrefabByName("burger_station")
-const instance = PrefabLoader.instantiatePrefab(prefab)
-
-// Instance is a GameObject with all components attached
-instance.position.set(5, 0, 5)
-```
-
-## Common Use Cases
-
-### Creating from Prefab
-
-```typescript
-class Instantiation {
-    private static prefabCollection?: PrefabCollection
-    
-    public static async initialize() {
-        const stowkit = StowKitSystem.getInstance()
-        const buildJson = (await import("../prefabs/build.json")).default
-        this.prefabCollection = await stowkit.loadFromBuildJson(buildJson, {
-            fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
-        })
-    }
-    
-    public static instantiate(prefabPath: string): PrefabInstance | null {
-        const prefab = this.prefabCollection?.getPrefabByName(prefabPath)
-        if (!prefab) {
-            throw new Error(`Prefab not found: ${prefabPath}`)
-        }
-        return PrefabLoader.instantiatePrefab(prefab)
-    }
-}
-
-// Use it
-const enemy = Instantiation.instantiate("enemy_prefab")
-```
-
-## API Overview
-
-- `PrefabLoader.instantiatePrefab(prefab, parent?, options?)` - Create instance
-- `PrefabCollection.getPrefabByName(name)` - Get prefab by name
-- `ComponentRegistry.register(type, class)` - Register custom components
-
-## Related Systems
-
-- [StowKitSystem](StowKitSystem.md) - Loads prefab definitions
-- [GameObject](../core/GameObject.md) - Prefabs create GameObjects
-
+# PrefabSystem
+
+Prefab system for instantiating pre-configured GameObjects with components from JSON definitions.
+
+## Quick Start
+
+```typescript
+import { PrefabLoader, PrefabCollection } from "@series-ai/rundot-3d-engine/systems"
+
+// Load prefabs (done via StowKitSystem)
+const prefabs = await StowKitSystem.getInstance().loadFromBuildJson(buildJson, config)
+
+// Instantiate prefab
+const prefab = prefabs.getPrefabByName("burger_station")
+const instance = PrefabLoader.instantiatePrefab(prefab)
+
+// Instance is a GameObject with all components attached
+instance.position.set(5, 0, 5)
+```
+
+## Common Use Cases
+
+### Creating from Prefab
+
+```typescript
+class Instantiation {
+    private static prefabCollection?: PrefabCollection
+    
+    public static async initialize() {
+        const stowkit = StowKitSystem.getInstance()
+        const buildJson = (await import("../prefabs/build.json")).default
+        this.prefabCollection = await stowkit.loadFromBuildJson(buildJson, {
+            fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
+        })
+    }
+    
+    public static instantiate(prefabPath: string): PrefabInstance | null {
+        const prefab = this.prefabCollection?.getPrefabByName(prefabPath)
+        if (!prefab) {
+            throw new Error(`Prefab not found: ${prefabPath}`)
+        }
+        return PrefabLoader.instantiatePrefab(prefab)
+    }
+}
+
+// Use it
+const enemy = Instantiation.instantiate("enemy_prefab")
+```
+
+## API Overview
+
+- `PrefabLoader.instantiatePrefab(prefab, parent?, options?)` - Create instance
+- `PrefabCollection.getPrefabByName(name)` - Get prefab by name
+- `ComponentRegistry.register(type, class)` - Register custom components
+
+## Related Systems
+
+- [StowKitSystem](StowKitSystem.md) - Loads prefab definitions
+- [GameObject](../core/GameObject.md) - Prefabs create GameObjects
+

package/docs/systems/StowKitSystem.md

@@ -1,77 +1,77 @@
-# StowKitSystem
-
-StowKitSystem loads assets from .stow pack files with automatic caching, prefab support, and material conversion.
-
-## Quick Start
-
-```typescript
-import { StowKitSystem } from "@series-ai/rundot-3d-engine/systems"
-import RundotGameAPI from "@series-inc/rundot-game-sdk/api"
-
-// Load from build.json (includes all packs and prefabs)
-const buildJson = await import("../prefabs/build.json")
-const prefabs = await StowKitSystem.getInstance().loadFromBuildJson(buildJson.default, {
-    fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
-})
-
-// Access meshes synchronously after loading
-const mesh = StowKitSystem.getInstance().getMeshSync("restaurant_display_Money")
-```
-
-## Common Use Cases
-
-### Loading Assets
-
-```typescript
-class MyGame extends VenusGame {
-    protected async onStart(): Promise<void> {
-        const stowkit = StowKitSystem.getInstance()
-        const buildJson = (await import("../prefabs/build.json")).default
-        
-        // Load everything
-        await stowkit.loadFromBuildJson(buildJson, {
-            fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
-        })
-        
-        // Now use meshes
-        this.createGameObjects()
-    }
-}
-```
-
-### Getting Meshes
-
-```typescript
-const stowkit = StowKitSystem.getInstance()
-
-// Async (loads if not cached)
-const mesh = await stowkit.getMesh("asset_name")
-
-// Sync (returns null if not loaded)
-const mesh = stowkit.getMeshSync("asset_name")
-```
-
-### Using with MeshRenderer
-
-```typescript
-// MeshRenderer uses StowKitSystem automatically
-const renderer = new MeshRenderer("restaurant_display_Money")
-const obj = new GameObject("Mesh")
-obj.addComponent(renderer)
-// Mesh loads from StowKit automatically
-```
-
-## API Overview
-
-- `getInstance(): StowKitSystem` - Get singleton instance
-- `loadFromBuildJson(json, config)` - Load packs and prefabs
-- `getMesh(name): Promise<THREE.Group>` - Load mesh async
-- `getMeshSync(name): THREE.Group | null` - Get cached mesh
-- `cloneMeshSync(mesh, castShadow, receiveShadow)` - Clone with shadows
-- `getBounds(mesh): THREE.Vector3` - Get mesh bounds
-
-## Related Systems
-
-- [MeshRenderer](../rendering/MeshRenderer.md) - Uses StowKit for loading
-- [PrefabSystem](PrefabSystem.md) - Prefabs from StowKit
-
+# StowKitSystem
+
+StowKitSystem loads assets from .stow pack files with automatic caching, prefab support, and material conversion.
+
+## Quick Start
+
+```typescript
+import { StowKitSystem } from "@series-ai/rundot-3d-engine/systems"
+import RundotGameAPI from "@series-inc/rundot-game-sdk/api"
+
+// Load from build.json (includes all packs and prefabs)
+const buildJson = await import("../prefabs/build.json")
+const prefabs = await StowKitSystem.getInstance().loadFromBuildJson(buildJson.default, {
+    fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
+})
+
+// Access meshes synchronously after loading
+const mesh = StowKitSystem.getInstance().getMeshSync("restaurant_display_Money")
+```
+
+## Common Use Cases
+
+### Loading Assets
+
+```typescript
+class MyGame extends VenusGame {
+    protected async onStart(): Promise<void> {
+        const stowkit = StowKitSystem.getInstance()
+        const buildJson = (await import("../prefabs/build.json")).default
+        
+        // Load everything
+        await stowkit.loadFromBuildJson(buildJson, {
+            fetchBlob: (path) => RundotGameAPI.cdn.fetchAsset(path)
+        })
+        
+        // Now use meshes
+        this.createGameObjects()
+    }
+}
+```
+
+### Getting Meshes
+
+```typescript
+const stowkit = StowKitSystem.getInstance()
+
+// Async (loads if not cached)
+const mesh = await stowkit.getMesh("asset_name")
+
+// Sync (returns null if not loaded)
+const mesh = stowkit.getMeshSync("asset_name")
+```
+
+### Using with MeshRenderer
+
+```typescript
+// MeshRenderer uses StowKitSystem automatically
+const renderer = new MeshRenderer("restaurant_display_Money")
+const obj = new GameObject("Mesh")
+obj.addComponent(renderer)
+// Mesh loads from StowKit automatically
+```
+
+## API Overview
+
+- `getInstance(): StowKitSystem` - Get singleton instance
+- `loadFromBuildJson(json, config)` - Load packs and prefabs
+- `getMesh(name): Promise<THREE.Group>` - Load mesh async
+- `getMeshSync(name): THREE.Group | null` - Get cached mesh
+- `cloneMeshSync(mesh, castShadow, receiveShadow)` - Clone with shadows
+- `getBounds(mesh): THREE.Vector3` - Get mesh bounds
+
+## Related Systems
+
+- [MeshRenderer](../rendering/MeshRenderer.md) - Uses StowKit for loading
+- [PrefabSystem](PrefabSystem.md) - Prefabs from StowKit
+