API reference

The complete surface.

Every option, method, attribute, and catalog entry. The forces, presets, conditions, and formations pages are generated from the engine's own catalog, so they can't drift from the code you install.

Reference

createField & options The entry points and every FieldOptions knob. Core requires a host; @fundamental-engine/vanilla and <field-root> wire browserHost() for you. FieldHandle The object every entry point returns — drive the field at runtime. data-* attributes Every attribute a body reads, and which force reads which. Forces (36) The full catalog — law, attributes, and example per force. Presets (8) Whole compositions as one attribute. No new engine code. Conditions, formations & modes The orthogonal axes — when, field-wide, and how it draws. Types Core types (Body, Particle, Force, Env) and platform types. API stability The frozen 0.x public surface, the experimental surface, and the compatibility rules — enforced by pnpm check:api. @fundamental-engine/dom DOM participation: the FrameScheduler + six registries (measurement, state, feedback, relationships, visual bindings, overlays) + lintPlatform(). Platform parity matrix Which FieldHandle methods ship on Three.js, Swift, and Kotlin — all three at 44/44 full parity. Metrics & diagnostics The observability surface: inspectBudget, energyReport, lintPlatform, and the live --field-* feedback channels. Platform utilities withFlip (FLIP animation), allocateAttention (conserved budget), threadOverlay, bindFieldNav, QualityGovernor, textBodies, and headlessHost.

At a glance. 36 forces · 8 presets · 6 conditions · 5 formations · 11 render modes · 4 palettes — one shared field runtime, host-native participation, a DOM adapter for the web, and a core with zero runtime dependencies.