Product media placeholder
Replace this area with a screenshot or short walkthrough video during the media sweep.
A .fmtion file is JSON. The generated schema is broad because it supports legacy and modern authoring paths, but the v1 docs should be explicit about which fields are current and which are transitional.
Root keys
- Required root keys:
meta. - Known root keys in the generated schema:
$vars,assets,canvas,carousels,customEases,dataBindings,dataTables,dom,domGraph,domSpritesheetTracks,enums,fmtionVersion,imageTrail,inputs,listeners,meta,parameters,pointerFollow,scenes,smoothScroll,videoTracks. - Current version constant:
8. - Use
scenes[]for modern 2D/3D scene authoring. Legacy DOM, Canvas, and older 3D blocks remain present during migration and are still read by loader paths where needed.
Metadata and parameters
meta.nameis the required human-facing name. Optional metadata includesauthor,description,duration,fps,contracts,createdAt,modifiedAt, andruntime.- Parameter types:
float,int,bool,trigger,string,enum,color. - A parameter definition accepts
type,default,name,min,max,step,readOnly,enumId, andenumValues. - Enums can be declared in
enums[]withid,name, andvalues.
Modern scene shape
- Each
Sceneuseskind: "2d"orkind: "3d". - Common scene fields include
id,name,activeWhen,duration,mountSelector,output,renderer,width,height, andbackgroundColor. mountSelectorandoutputare mutually exclusive. A scene is either mounted in the DOM or rendered headlessly for another consumer.tex://scene/<id>references a headless scene output from a material texture slot.
Assets
- The
assetslibrary can containmedia,fonts,paths,spritesheets, andtextures. - A media asset uses
assetId,kind(video,audio, orimage),url, and optional metadata such as dimensions, duration, poster, provider, credit, and hash. - Font assets use
id,family,src, and optionalweightandstyle.
Verified runnable examples
This guide points to proof-backed sample coverage. The full ledger lives in Generated examples and proof log.
DOM: Scroll fade reveal
- Source:
faster-motion/demo/tests/dom/catalog/scroll-animations/fade-reveal/fade-reveal.domgraph.fmtion - Expected output: Sections fade and translate into place as their trigger elements enter the configured viewport range.
- Validation: Schema validation passed. Runtime proof reports zero structural/runtime issues and 17 loaded nodes.
- Desktop proof:
generated-assets/faster-motion-docs/proofs/screenshots/dom-fade-reveal-desktop.png - Mobile proof:
generated-assets/faster-motion-docs/proofs/screenshots/dom-fade-reveal-mobile.png
Canvas: Fill rule diagnostic
- Source:
faster-motion/demo/tests/canvas/fillrule-diagnostic/fillrule-diagnostic.fmtion - Expected output: A contained Canvas scene renders paired path cases so nonzero and evenodd fill handling can be compared visually.
- Validation: Schema validation passed. Runtime proof reports zero blocking runtime issues and 10 rendered objects; the accepted metadata note is preserved in the proof ledger.
- Desktop proof:
generated-assets/faster-motion-docs/proofs/screenshots/canvas-fillrule-diagnostic-desktop.png - Mobile proof:
generated-assets/faster-motion-docs/proofs/screenshots/canvas-fillrule-diagnostic-mobile.png
Guide-specific sample target: Schema fixture sample that validates one minimal file, one DOM graph file, one 2D scene file, and one 3D scene file.
Faster Motion docs
Use this local map together with the left navigation. The source-backed content tree controls the main article order; this section keeps related pages one click away.
Start
- Faster Motion docs map
- Faster Motion documentation overview
- Get started with Faster Motion
- Faster Motion concepts
- .fmtion file format
DOM animation
- DOM animation guide
- DOM selectors and targets
- Scroll animation
- Pointer, hover, and drag inputs
- Text, SVG, and path animation
- Responsive gates and parameter overrides
Canvas animation
- Canvas animation guide
- Canvas area lifecycle
- Canvas objects, assets, and rendering
- Canvas inputs and state machines
3D and procedural
- Canvas 3D and procedural guide
- 3D scenes, cameras, and lights
- Procedural geometry and fields
- Particles and physics