Web Engine Docs
Preparing documentation
Use the search bar to quickly find any topic
Preparing documentation
Use the search bar to quickly find any topic
Web Engine API
@web-engine-dev/core - Game Engine Runtime
A high-performance Entity Component System (ECS) game engine built on bitECS. Designed for 60/120 FPS with 100k+ entities using zero-allocation hot paths.
The Scene API is the simplest way to get started. It wraps ECS + Three.js complexity into a clean, ergonomic interface:
import { createScene } from '@web-engine-dev/core';
const scene = createScene({ canvas: document.querySelector('canvas')! });
scene.createBox({ position: [0, 1, 0], color: 0xff0000 });
scene.createSphere({ position: [2, 1, 0], color: 0x0066ff });
scene.start();
import { ECS, Physics, createEngine } from '@web-engine-dev/core';
const world = ECS.getWorld();
const entity = ECS.createSceneEntity(world);
ECS.Transform.position.x[entity] = 10;
import { getWorld, Transform } from '@web-engine-dev/core/ecs';
import { ClientPhysicsBridge } from '@web-engine-dev/core/physics';
import { createScene } from '@web-engine-dev/core/scene';
Re-exports deserializeScene
Renames and re-exports ensureFocusGuard
Re-exports InteractionState
Re-exports InteractableMap
Re-exports Networked
Re-exports Player
Re-exports Input
Re-exports Inventory
Re-exports InventoryMap
Re-exports GameState
Re-exports MixerSnapshot
Re-exports isWebGPURenderer
Re-exports PostProcessing
Re-exports Environment
Re-exports Light
Re-exports Transform
Re-exports RenderLayerBit
Renames and re-exports hydrateScene
Re-exports EditorSerializedScene
Renames and re-exports EditorSerializedScene
Re-exports ECSSerializedScene
Re-exports EntityId
Re-exports CameraView
Re-exports LightView
Re-exports Terrain
Re-exports EditorSerializedEntity
Re-exports SerializationFormat
Re-exports serializeScene
Re-exports TransformView
Re-exports RigidBodyView
Re-exports ColliderView
Re-exports LocalTransformView
Re-exports VelocityView
Re-exports asView
Renames and re-exports Terrain
Re-exports MeshRendererView
Re-exports AudioSourceView
Re-exports AnimationView
Re-exports CharacterControllerView
Re-exports Message
Re-exports MessageRole
Re-exports MessageContent
Re-exports ContentPart
Re-exports TextContentPart
Re-exports ImageContentPart
Re-exports FileContentPart
Re-exports ToolCall
Re-exports ToolResult
Re-exports ToolDefinition
Re-exports JSONSchema
Re-exports JSONSchemaProperty
Re-exports ChatRequest
Re-exports ChatResponse
Re-exports ChatChunk
Re-exports TokenUsage
Re-exports AgentEvent
Re-exports AgentState
Re-exports AISettings
Re-exports ProviderConfig
Re-exports DEFAULT_AI_SETTINGS
Re-exports createMessageId
Re-exports createToolCallId
Re-exports createConversationId
Re-exports initializeAssistant