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

package/docs/systems/AnimationSystem.md

@@ -1,75 +1,75 @@
-# AnimationSystem
-
-Advanced animation system with state machines, blending, retargeting, and frustum culling for skeletal characters.
-
-## Quick Start
-
-```typescript
-import { AnimationControllerComponent } from "@series-ai/rundot-3d-engine/systems"
-
-// Add to character with SkeletalRenderer
-const character = new GameObject("Character")
-character.addComponent(new SkeletalRenderer("Character/player.fbx"))
-
-const animController = new AnimationControllerComponent()
-character.addComponent(animController)
-
-// Add animation states
-animController.addState("idle", "Animations/idle.fbx")
-animController.addState("walk", "Animations/walk.fbx")
-animController.addState("run", "Animations/run.fbx")
-
-// Play animation
-animController.setState("idle")
-```
-
-## Common Use Cases
-
-### State Machine
-
-```typescript
-class CharacterController extends Component {
-    private animController?: AnimationControllerComponent
-    
-    protected onCreate(): void {
-        this.animController = this.getComponent(AnimationControllerComponent)
-    }
-    
-    public update(deltaTime: number): void {
-        const speed = this.getMovementSpeed()
-        
-        if (speed === 0) {
-            this.animController?.setState("idle")
-        } else if (speed < 5) {
-            this.animController?.setState("walk")
-        } else {
-            this.animController?.setState("run")
-        }
-    }
-}
-```
-
-### Animation Culling
-
-```typescript
-// Enable frustum culling to skip animations for off-screen characters
-VenusGame.setAnimationCullingCamera(camera, 1.2)
-
-// Or distance culling
-const culling = VenusGame.getAnimationCulling()
-culling.setDistanceCullingEnabled(true)
-culling.setMaxDistance(50) // Units
-```
-
-## API Overview
-
-- `addState(name, animationPath)` - Register animation state
-- `setState(name)` - Switch to animation
-- `setBlendDuration(seconds)` - Set transition time
-- `getState(): string` - Get current state
-
-## Related Systems
-
-- [SkeletalRenderer](../rendering/SkeletalRenderer.md) - Animated character meshes
-- [AssetManager](../rendering/AssetManager.md) - Load animation clips
-
+# AnimationSystem
+
+Advanced animation system with state machines, blending, retargeting, and frustum culling for skeletal characters.
+
+## Quick Start
+
+```typescript
+import { AnimationControllerComponent } from "@series-ai/rundot-3d-engine/systems"
+
+// Add to character with SkeletalRenderer
+const character = new GameObject("Character")
+character.addComponent(new SkeletalRenderer("Character/player.fbx"))
+
+const animController = new AnimationControllerComponent()
+character.addComponent(animController)
+
+// Add animation states
+animController.addState("idle", "Animations/idle.fbx")
+animController.addState("walk", "Animations/walk.fbx")
+animController.addState("run", "Animations/run.fbx")
+
+// Play animation
+animController.setState("idle")
+```
+
+## Common Use Cases
+
+### State Machine
+
+```typescript
+class CharacterController extends Component {
+    private animController?: AnimationControllerComponent
+    
+    protected onCreate(): void {
+        this.animController = this.getComponent(AnimationControllerComponent)
+    }
+    
+    public update(deltaTime: number): void {
+        const speed = this.getMovementSpeed()
+        
+        if (speed === 0) {
+            this.animController?.setState("idle")
+        } else if (speed < 5) {
+            this.animController?.setState("walk")
+        } else {
+            this.animController?.setState("run")
+        }
+    }
+}
+```
+
+### Animation Culling
+
+```typescript
+// Enable frustum culling to skip animations for off-screen characters
+VenusGame.setAnimationCullingCamera(camera, 1.2)
+
+// Or distance culling
+const culling = VenusGame.getAnimationCulling()
+culling.setDistanceCullingEnabled(true)
+culling.setMaxDistance(50) // Units
+```
+
+## API Overview
+
+- `addState(name, animationPath)` - Register animation state
+- `setState(name)` - Switch to animation
+- `setBlendDuration(seconds)` - Set transition time
+- `getState(): string` - Get current state
+
+## Related Systems
+
+- [SkeletalRenderer](../rendering/SkeletalRenderer.md) - Animated character meshes
+- [AssetManager](../rendering/AssetManager.md) - Load animation clips
+

package/docs/systems/AudioSystem.md

@@ -1,79 +1,79 @@
-# AudioSystem
-
-2D and 3D audio playback with music management and volume control.
-
-## Quick Start
-
-```typescript
-import { AudioSystem, Audio2D } from "@series-ai/rundot-3d-engine/systems"
-
-// Play 2D sound effect
-const sfx = new Audio2D("SFX/click.ogg")
-sfx.play()
-
-// Play music
-AudioSystem.playMusic("Music/track_01.ogg", { loop: true, volume: 0.5 })
-```
-
-## Common Use Cases
-
-### Sound Effects
-
-```typescript
-class Button extends Component {
-    private clickSound?: Audio2D
-    
-    protected onCreate(): void {
-        this.clickSound = new Audio2D("SFX/click.ogg")
-        this.gameObject.addComponent(this.clickSound)
-    }
-    
-    private onClick(): void {
-        this.clickSound?.play()
-    }
-}
-```
-
-### Background Music
-
-```typescript
-class MyGame extends VenusGame {
-    protected async onStart(): Promise<void> {
-        // Play looping music
-        AudioSystem.playMusic("Music/track_01.ogg", {
-            loop: true,
-            volume: 0.7,
-            fadeInDuration: 2.0
-        })
-    }
-}
-```
-
-### Volume Control
-
-```typescript
-// Master volume
-AudioSystem.mainListener?.setMasterVolume(0.5)
-
-// Individual sound volume
-sfx.setVolume(0.8)
-```
-
-## API Overview
-
-### AudioSystem
-- `playMusic(path, options?)` - Play background music
-- `stopMusic(fadeOutDuration?)` - Stop music
-- `mainListener` - Global audio listener
-
-### Audio2D Component
-- `play()` - Play sound
-- `stop()` - Stop sound
-- `setVolume(volume)` - Set volume (0-1)
-- `setLoop(loop)` - Enable/disable looping
-
-## Related Systems
-
-- [VenusGame](../core/VenusGame.md) - Creates audio listener
-- [Component](../core/Component.md) - Audio2D is a component
-
+# AudioSystem
+
+2D and 3D audio playback with music management and volume control.
+
+## Quick Start
+
+```typescript
+import { AudioSystem, Audio2D } from "@series-ai/rundot-3d-engine/systems"
+
+// Play 2D sound effect
+const sfx = new Audio2D("SFX/click.ogg")
+sfx.play()
+
+// Play music
+AudioSystem.playMusic("Music/track_01.ogg", { loop: true, volume: 0.5 })
+```
+
+## Common Use Cases
+
+### Sound Effects
+
+```typescript
+class Button extends Component {
+    private clickSound?: Audio2D
+    
+    protected onCreate(): void {
+        this.clickSound = new Audio2D("SFX/click.ogg")
+        this.gameObject.addComponent(this.clickSound)
+    }
+    
+    private onClick(): void {
+        this.clickSound?.play()
+    }
+}
+```
+
+### Background Music
+
+```typescript
+class MyGame extends VenusGame {
+    protected async onStart(): Promise<void> {
+        // Play looping music
+        AudioSystem.playMusic("Music/track_01.ogg", {
+            loop: true,
+            volume: 0.7,
+            fadeInDuration: 2.0
+        })
+    }
+}
+```
+
+### Volume Control
+
+```typescript
+// Master volume
+AudioSystem.mainListener?.setMasterVolume(0.5)
+
+// Individual sound volume
+sfx.setVolume(0.8)
+```
+
+## API Overview
+
+### AudioSystem
+- `playMusic(path, options?)` - Play background music
+- `stopMusic(fadeOutDuration?)` - Stop music
+- `mainListener` - Global audio listener
+
+### Audio2D Component
+- `play()` - Play sound
+- `stop()` - Stop sound
+- `setVolume(volume)` - Set volume (0-1)
+- `setLoop(loop)` - Enable/disable looping
+
+## Related Systems
+
+- [VenusGame](../core/VenusGame.md) - Creates audio listener
+- [Component](../core/Component.md) - Audio2D is a component
+

package/docs/systems/InputManager.md

@@ -1,101 +1,101 @@
-# InputManager
-
-Cross-platform input system for keyboard, mouse, and touch with mobile support.
-
-## Quick Start
-
-```typescript
-import { InputManager } from "@series-ai/rundot-3d-engine/systems"
-
-// Check keyboard input
-if (InputManager.isKeyDown("w")) {
-    player.moveForward()
-}
-
-// Check mouse button
-if (InputManager.isMouseButtonDown(0)) { // Left click
-    fireWeapon()
-}
-
-// Get mouse position
-const mousePos = InputManager.getMousePosition()
-```
-
-## Common Use Cases
-
-### Keyboard Input
-
-```typescript
-class PlayerController extends Component {
-    public update(deltaTime: number): void {
-        const speed = 5
-        
-        if (InputManager.isKeyDown("w")) {
-            this.gameObject.position.z -= speed * deltaTime
-        }
-        if (InputManager.isKeyDown("s")) {
-            this.gameObject.position.z += speed * deltaTime
-        }
-        if (InputManager.isKeyDown("a")) {
-            this.gameObject.position.x -= speed * deltaTime
-        }
-        if (InputManager.isKeyDown("d")) {
-            this.gameObject.position.x += speed * deltaTime
-        }
-    }
-}
-```
-
-### Mouse Input
-
-```typescript
-// Mouse buttons
-if (InputManager.isMouseButtonDown(0)) { // Left
-    console.log("Left click")
-}
-if (InputManager.isMouseButtonDown(2)) { // Right
-    console.log("Right click")
-}
-
-// Mouse position (screen coordinates)
-const pos = InputManager.getMousePosition()
-console.log(`Mouse at ${pos.x}, ${pos.y}`)
-```
-
-### Touch Input (Mobile)
-
-```typescript
-// Touch is automatically mapped to mouse on mobile
-// isMouseButtonDown(0) works for taps
-// getMousePosition() returns touch position
-```
-
-## API Overview
-
-### Keyboard
-- `isKeyDown(key: string): boolean` - Check if key is pressed
-- `isKeyPressed(key: string): boolean` - Check if key was just pressed this frame
-- `isKeyReleased(key: string): boolean` - Check if key was just released
-
-### Mouse
-- `isMouseButtonDown(button: number): boolean` - Check mouse button (0=left, 1=middle, 2=right)
-- `getMousePosition(): {x: number, y: number}` - Get mouse/touch position
-- `getMouseDelta(): {x: number, y: number}` - Get mouse movement since last frame
-
-### System
-- `initialize()` - Initialize input (called by VenusGame)
-- `update()` - Update input state (automatic)
-
-## Key Codes
-
-Use standard keyboard keys:
-- Letters: `"a"`, `"b"`, `"w"`, etc.
-- Numbers: `"1"`, `"2"`, etc.
-- Special: `"Space"`, `"Enter"`, `"Shift"`, `"Control"`, `"Alt"`
-- Arrows: `"ArrowUp"`, `"ArrowDown"`, `"ArrowLeft"`, `"ArrowRight"`
-
-## Related Systems
-
-- [VenusGame](../core/VenusGame.md) - Initializes InputManager
-- [Component](../core/Component.md) - Use input in update()
-
+# InputManager
+
+Cross-platform input system for keyboard, mouse, and touch with mobile support.
+
+## Quick Start
+
+```typescript
+import { InputManager } from "@series-ai/rundot-3d-engine/systems"
+
+// Check keyboard input
+if (InputManager.isKeyDown("w")) {
+    player.moveForward()
+}
+
+// Check mouse button
+if (InputManager.isMouseButtonDown(0)) { // Left click
+    fireWeapon()
+}
+
+// Get mouse position
+const mousePos = InputManager.getMousePosition()
+```
+
+## Common Use Cases
+
+### Keyboard Input
+
+```typescript
+class PlayerController extends Component {
+    public update(deltaTime: number): void {
+        const speed = 5
+        
+        if (InputManager.isKeyDown("w")) {
+            this.gameObject.position.z -= speed * deltaTime
+        }
+        if (InputManager.isKeyDown("s")) {
+            this.gameObject.position.z += speed * deltaTime
+        }
+        if (InputManager.isKeyDown("a")) {
+            this.gameObject.position.x -= speed * deltaTime
+        }
+        if (InputManager.isKeyDown("d")) {
+            this.gameObject.position.x += speed * deltaTime
+        }
+    }
+}
+```
+
+### Mouse Input
+
+```typescript
+// Mouse buttons
+if (InputManager.isMouseButtonDown(0)) { // Left
+    console.log("Left click")
+}
+if (InputManager.isMouseButtonDown(2)) { // Right
+    console.log("Right click")
+}
+
+// Mouse position (screen coordinates)
+const pos = InputManager.getMousePosition()
+console.log(`Mouse at ${pos.x}, ${pos.y}`)
+```
+
+### Touch Input (Mobile)
+
+```typescript
+// Touch is automatically mapped to mouse on mobile
+// isMouseButtonDown(0) works for taps
+// getMousePosition() returns touch position
+```
+
+## API Overview
+
+### Keyboard
+- `isKeyDown(key: string): boolean` - Check if key is pressed
+- `isKeyPressed(key: string): boolean` - Check if key was just pressed this frame
+- `isKeyReleased(key: string): boolean` - Check if key was just released
+
+### Mouse
+- `isMouseButtonDown(button: number): boolean` - Check mouse button (0=left, 1=middle, 2=right)
+- `getMousePosition(): {x: number, y: number}` - Get mouse/touch position
+- `getMouseDelta(): {x: number, y: number}` - Get mouse movement since last frame
+
+### System
+- `initialize()` - Initialize input (called by VenusGame)
+- `update()` - Update input state (automatic)
+
+## Key Codes
+
+Use standard keyboard keys:
+- Letters: `"a"`, `"b"`, `"w"`, etc.
+- Numbers: `"1"`, `"2"`, etc.
+- Special: `"Space"`, `"Enter"`, `"Shift"`, `"Control"`, `"Alt"`
+- Arrows: `"ArrowUp"`, `"ArrowDown"`, `"ArrowLeft"`, `"ArrowRight"`
+
+## Related Systems
+
+- [VenusGame](../core/VenusGame.md) - Initializes InputManager
+- [Component](../core/Component.md) - Use input in update()
+