Skip to content

Kiln API / kiln / KilnConfig

Interface: KilnConfig ​

Contents of kiln.config.ts. Every field is optional.

Properties ​

PropertyTypeDescription
fixedHz?numberFixed simulation rate. Default 60.
seed?numberSeed for the Rng resource. Default 0.
mode?"2d" | "3d"'3d' (default) or '2d': orthographic camera, z as draw order, Z-only rotation, Rapier 2D.
hotReload?HotReloadMode'keep' swaps changed systems in place, 'snapshot' rebuilds and restores, false disables.
dev?booleanDev guards and read-only proxies. Default: on unless NODE_ENV=production.
maxFrameDt?numberFrame delta clamp in seconds, so a tab-away doesn't spiral. Default 0.25.
vsync?booleanPace browser frames with the display (requestAnimationFrame). Default true.
maxFps?numberCap on browser frames per second; 0 means no cap. Default 0.
maxFixedSteps?numberMost fixed steps per frame. Default 5.
record?booleanRecord every browser session in dev so F8 (or a crash) saves a replayable recording. Default true.
entry?stringModule whose default export builds the app, for the CLI and scenarios. Default 'src/main.ts'.