---
title: "Pyro docs: bake fire, smoke, explosion and dust flipbooks from a spec"
description: "Pyro module docs: commands, the .pyro.toml spec, emitters, values over time, forces, obstacles, the sheets a bake writes, the JSON report and the examples."
canonical: https://appliedmanifold.com/docs/pyro/
site: "Applied Manifold: The spatial compute cloud for 3D reality"
---

1.  [Home](https://appliedmanifold.com/)
2.  [Docs](https://appliedmanifold.com/docs/)
3.  Pyro

DOCS // PYRO 0.4.1

# Pyro docs

Pyro turns a `.pyro.toml` spec 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.

## Pyro pages

-   [PyroPyro turns a `.pyro.toml` spec 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.](https://appliedmanifold.com/docs/pyro/)
-   [Bake and wireRun `spatial-compiler bake <name>.pyro.toml --out <dir>` to bake, then `spatial-compiler wire <dir> --scene <path>.tscn` to write a Godot 4 scene with the six-way shader. `check`, `schema` and `sweep` support the loop.](https://appliedmanifold.com/docs/pyro/bake-and-wire/)
-   [The spec fileA spec is a TOML file ending in `.pyro.toml` with the sections `[meta]`, `[domain]`, `[[emitters]]`, `[[forces]]`, `[[obstacles]]`, `[solver]`, `[look]`, `[[views]]` and `[export]`. Units are meters, seconds and kelvin.](https://appliedmanifold.com/docs/pyro/spec/)
-   [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 on `position_m` and `rotation_deg` move and turn an emitter during the clip.](https://appliedmanifold.com/docs/pyro/emitters/)
-   [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.](https://appliedmanifold.com/docs/pyro/values-over-time/)
-   [Forces`[[forces]]` push on the gas inside a sphere, a box or everywhere while they are on: `push`, `point`, `vortex`, `turbulence`, `drag` and `expand`, the last a blast that shoves everything outward. A spec may have any number.](https://appliedmanifold.com/docs/pyro/forces/)
-   [Obstacles`[[obstacles]]` are solids the gas flows around: spheres, boxes, cylinders and capsules, with `carve = true` cutting holes such as a window in a wall. Keys move and turn them, and `holdout` and `shadow` hide and shade the gas in the sheets.](https://appliedmanifold.com/docs/pyro/obstacles/)
-   [What a bake writesEach view writes four sheets, `<view>_pos.png`, `_neg.png`, `_colour.png` and `_aux.png`, plus `layout.json`, two still previews, the animated `preview_anim.png` and `bake_report.json`. Sheets are 8 x 8 tiles of 256 px by default.](https://appliedmanifold.com/docs/pyro/outputs/)
-   [The reportEvery command prints the same JSON report to stdout and writes it to `bake_report.json`: `ok`, `errors`, `warnings` with a fix key and hint, `artifacts` and `metrics`. A shipped effect ends with `"ok": true` and no warnings.](https://appliedmanifold.com/docs/pyro/report/)
-   [ExamplesThe pyro examples bake at final quality with no warnings: `fireball`, `impact`, `smoke_column`, `fire`, `fire_whirl`, `window_fire`, `smoke_plume` and `dust_ring`. Copy the nearest one to start a new effect.](https://appliedmanifold.com/docs/pyro/examples/)

## 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](https://appliedmanifold.com/modules/pyro/) walks through the inputs and outputs with excerpts of the shipped examples.
