API Reference
The framework is published as quantum-forge (core) and quantum-forge-engine (engine) on npm, each with subpath exports. Each feature has its own entry point.
Package Exports
| Export | Import Path | Primary Exports |
|---|---|---|
| Engine | quantum-forge/engine | Engine |
| Events | quantum-forge/events | EventBus |
| Logging | quantum-forge/logging | Logger, LoggerInterface |
| Operations | quantum-forge/operations | OperationRegistry, OperationExecutor |
| Quantum | quantum-forge/quantum | QuantumPropertyManager, QuantumRecorder, ensureLoaded, startBackgroundLoad |
| Rendering | quantum-forge/rendering | PixiRenderer, CanvasRenderer, GameLoop, Camera |
| Input | quantum-forge/input | InputManager, LocalMultiplayerManager, GamepadButtons, GamepadAxes |
| Collision | quantum-forge/collision | SpatialGrid, checkCollision |
| Audio | quantum-forge/audio | AudioManager |
| Particles | quantum-forge/particles | ParticleSystem |
| Entities | quantum-forge/entities | EntityManager |
| Animation | quantum-forge/animation | Tween, easing functions |
| State Machine | quantum-forge/state-machine | StateMachine |
| Timer | quantum-forge/timer | GameTimer |
| Save | quantum-forge/save | SaveManager |
| Scenes | quantum-forge/scenes | SceneManager |
| Vite Plugin | quantum-forge/vite-plugin | quantumForgeVitePlugin |
Dependencies
Installed automatically for consumers:
eventemitter3: event systempixi.js: WebGL/WebGPU renderinghowler: audio
Detailed References
- Quantum API: QuantumPropertyManager, gates, measurement, recording
- Engine API: Engine base class
- Rendering API: PixiRenderer, CanvasRenderer, GameLoop
- Input API: InputManager, bindings, devices
- Packages API: Collision, audio, particles, animation, etc.