API Reference
Auto-generated TypeScript API documentation for key Web Engine Dev packages.
TIP
For usage guides and tutorials, see the Getting Started section. For package overviews, see Packages.
Meta
| Package | Description |
|---|---|
@web-engine-dev/engine | The complete web game engine - umbrella package that re-exports all modules |
Core
| Package | Description |
|---|---|
@web-engine-dev/ecs | A high-performance, feature-rich Entity Component System (ECS) library for TypeScript/JavaScript. Built for game engines and simulations with support for parallel execution, SharedArrayBuffer, worker threads, and advanced query systems. |
@web-engine-dev/math | High-performance vector, matrix, and quaternion math library for game engines. Immutable by design. |
@web-engine-dev/events | Double-buffered event system with frame lifecycle for web-engine-dev |
@web-engine-dev/time | Time management, fixed timestep, and timers for web-engine-dev |
@web-engine-dev/resources | Global singleton/resource management for web-engine-dev |
@web-engine-dev/scheduler | System ordering and parallel execution for web-engine-dev |
Systems
| Package | Description |
|---|---|
@web-engine-dev/input | Unified input system with action mapping for web-engine-dev |
@web-engine-dev/audio | Game audio engine with spatial audio, buses, and adaptive music for web-engine-dev |
@web-engine-dev/physics2d | 2D physics engine with collision detection, rigid body dynamics, and constraints for web-engine-dev |
@web-engine-dev/physics3d | Reference 3D physics implementation (use physics3d-rapier for production) |
@web-engine-dev/animation | Animation system with skeletal animation, blending, state machines, and IK for web-engine-dev |
Rendering
| Package | Description |
|---|---|
@web-engine-dev/renderer | Scene-graph agnostic web rendering library with full render graph, materials, lighting, and post-processing. WebGPU-first renderer. |
@web-engine-dev/render-graph | WebGPU/WebGL render graph system for organizing render passes |
Other Packages
The engine includes 92+ packages total. Packages not listed above can be explored in the Packages section, which includes documentation generated from each package's README.