Pyro pages
- PyroPyro turns a
.pyro.tomlspec into fire, smoke, explosion and dust flipbook sheets lit from six directions, previews and a JSON report. These pages cover the commands, the spec and its parts, the outputs and the examples. - Bake and wireRun
spatial-compiler bake <name>.pyro.toml --out <dir>to bake, thenspatial-compiler wire <dir> --scene <path>.tscnto write a Godot 4 scene with the six-way shader.check,schemaandsweepsupport the loop. - The spec fileA spec is a TOML file ending in
.pyro.tomlwith the sections[meta],[domain],[[emitters]],[[forces]],[[obstacles]],[solver],[look],[[views]]and[export]. Units are meters, seconds and kelvin. - EmittersA spec has one or more
[[emitters]]with no upper limit, each a sphere, box, disc, ring or points that adds fuel, heat, smoke or dust. Keys onposition_mandrotation_degmove and turn an emitter during the clip. - Values over timeAny field marked animatable takes either a constant or keys over simulated seconds, such as
fuel = [[0.0, 4.0], [0.5, 0.0]]. The value blends between keys with linear, smooth or step easing and holds outside them. - Forces
[[forces]]push on the gas inside a sphere, a box or everywhere while they are on:push,point,vortex,turbulence,dragandexpand, the last a blast that shoves everything outward. A spec may have any number. - Obstacles
[[obstacles]]are solids the gas flows around: spheres, boxes, cylinders and capsules, withcarve = truecutting holes such as a window in a wall. Keys move and turn them, andholdoutandshadowhide and shade the gas in the sheets. - What a bake writesEach view writes four sheets,
<view>_pos.png,_neg.png,_colour.pngand_aux.png, pluslayout.json, two still previews, the animatedpreview_anim.pngandbake_report.json. Sheets are 8 x 8 tiles of 256 px by default. - The reportEvery command prints the same JSON report to stdout and writes it to
bake_report.json:ok,errors,warningswith a fix key and hint,artifactsandmetrics. A shipped effect ends with"ok": trueand no warnings. - ExamplesThe pyro examples bake at final quality with no warnings:
fireball,impact,smoke_column,fire,fire_whirl,window_fire,smoke_plumeanddust_ring. Copy the nearest one to start a new effect.
The module
Pyro turns a spec into flipbook sheets for games, film previs, real-time apps, simulation and synthetic data, and spatial-compiler wire sets the sheets up in Godot 4. The pyro module page walks through the inputs and outputs with excerpts of the shipped examples.