API Reference
The framework is published as @quantum-realm-games/quantum-forge-framework with subpath exports. Each feature has its own entry point.
Package Exports
| Export | Import Path | Primary Exports |
|---|---|---|
| Engine | quantum-forge-framework/engine | Engine |
| Events | quantum-forge-framework/events | EventBus |
| Logging | quantum-forge-framework/logging | Logger, LoggerInterface |
| Operations | quantum-forge-framework/operations | OperationRegistry, OperationExecutor |
| Quantum | quantum-forge-framework/quantum | QuantumPropertyManager, ensureLoaded, startBackgroundLoad |
| Rendering | quantum-forge-framework/rendering | PixiRenderer, CanvasRenderer, GameLoop, Camera |
| Input | quantum-forge-framework/input | InputManager, LocalMultiplayerManager, GamepadButtons, GamepadAxes |
| Collision | quantum-forge-framework/collision | SpatialGrid, checkCollision |
| Audio | quantum-forge-framework/audio | AudioManager |
| Particles | quantum-forge-framework/particles | ParticleSystem |
| Entities | quantum-forge-framework/entities | EntityManager |
| Animation | quantum-forge-framework/animation | Tween, easing functions |
| State Machine | quantum-forge-framework/state-machine | StateMachine |
| Timer | quantum-forge-framework/timer | GameTimer |
| Save | quantum-forge-framework/save | SaveManager |
| Scenes | quantum-forge-framework/scenes | SceneManager |
| Vite Plugin | quantum-forge-framework/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.