Contents5 sections
Output files
You get directional PNG or EXR texture sheets, layout.json with frame order, timing and channels, plus an optional Godot scene.

Estimate and bake
First call MCP estimate with the request payload and check the quoted price. If approval is required and the user agrees, include the returned quote.id as accept_quote in submit, or use POST /v1/estimate then POST /v1/jobs over REST with the same approval flow.
[domain]
size_m = [2, 2, 2]
voxel_m = 0.06
duration_s = 0.5
[[emitters]]
shape = "sphere"
position_m = [0, 0.4, 0]
size_m = 0.3
fuel = 2
temperature_k = 1500
smoke = 1
[export]
grid = [2, 2]
tile_px = 32MCP request
{
"module": "pyro",
"operation": "bake",
"quality": "draft",
"spec": "[domain]\nsize_m = [2, 2, 2]\nvoxel_m = 0.06\nduration_s = 0.5\n\n[[emitters]]\nshape = \"sphere\"\nposition_m = [0, 0.4, 0]\nsize_m = 0.3\nfuel = 2\ntemperature_k = 1500\nsmoke = 1\n\n[export]\ngrid = [2, 2]\ntile_px = 32\n"
}Engine import
| Engine | Import |
|---|---|
| Godot | Run the Godot wire step to build a scene that plays the directional texture sheets. |
| Unity | Load the PNG or EXR sheets and read layout.json to set grid dimensions, timing and ground anchor in a custom shader. Sample the directional channels to light the effect. |
| Unreal Engine | Sample the matching PNG cells in an Unreal material and combine the lighting channels. |
| three.js | Play the texture sheets on a quad using layout.json for frame timing and directional lighting. |
Reference and examples
- ExamplesThe hosted pyrofx recipes are fire, fireball, fire_whirl, window_fire, smoke_column, smoke_plume, dust_ring, impact, kickup_soil and kickup_masonry. The rendered starter library retains its recorded compile version; each example links its report.
- 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 takes any number of
[[emitters]]: spheres, boxes, discs, rings or points that add fuel, heat, smoke or dust. Keyposition_mandrotation_degto move and turn them. - 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. - ForcesA spec takes any number of
[[forces]], which act on the gas in a sphere, a box or everywhere:push,point,vortex,turbulence,dragandexpand(a blast). - Obstacles
[[obstacles]]are solids the gas flows around: spheres, boxes, cylinders and capsules.carve = truecuts holes. Keys move them;holdoutandshadowhide and shade the gas. - Model-shaped emitters and obstaclesUse a model as an emitter surface or volume, or as an obstacle that gas flows around. OBJ, GLB and glTF shapes are supported.
- Soil and masonry presetsSet
look.materialtosoilormasonryfor dust colours and motion defaults. Any key you set overrides the preset. - OutputsWith the default export, each 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. - 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 failed run still returns a report withokset tofalse. Exit codes and error codes are listed under Errors. - Bake and wireCall
bakewith a.pyro.tomlspec and an output folder, thenwireto write a Godot 4 scene with the six-way shader.check,schemaandsweepsupport the loop. - Godot effect poolDraw many copies of one compiled effect in one draw call. Each copy has its own start time, size, colour, lean and mirror.
- Same resultBake the same spec twice and you get the same sheets back. We ran the official fire example twice at draft quality, and every sheet had the same SHA-256 hash.
Questions
How do I estimate and submit a pyrofx bake?
Call MCP estimate with your payload to check the price, then pass the returned quote ID as accept_quote in submit.
What files does a pyrofx bake output?
Each view outputs directional PNG or EXR texture sheets, layout.json for timing and channels, preview images and bake_report.json.
How do Unity, Unreal Engine and three.js import pyrofx sheets?
They load the PNG or EXR sheets and read layout.json to set grid dimensions, frame timing and directional lighting channels.