DOCS // pyrofx

pyrofx docs

Add animated fire, smoke and dust to your game as ready to use image sequences.

Contents5 sections
  1. Output files
  2. Estimate and bake
  3. Engine import
  4. Reference and examples
  5. Questions

Output files

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

Fire
Fire

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.

fire.pyro.toml
[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 = 32
MCP request
JSON
{
  "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

EngineImport
GodotRun the Godot wire step to build a scene that plays the directional texture sheets.
UnityLoad 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 EngineSample the matching PNG cells in an Unreal material and combine the lighting channels.
three.jsPlay the texture sheets on a quad using layout.json for frame timing and directional lighting.

Reference and examples

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.