Documentation
Docs/en/reference/particle-format/tooling.md
Particle Tooling Contract
Generated reference. Do not edit this page directly. Update
BuildTools/ParticleFormatInterface.json, then runpython BuildTools/docs_particle_format.py --write.
| Reference index | Source rules | Formats and backends | Rendering | Tooling | Runtime | Integration | Validation | Canonical JSON model | Guide | Authoring tools |
| Stable ID | Rule | Requirement | Why | Source |
|---|---|---|---|---|
particle-format.tooling.mapper-preview |
Backend-neutral Mapper preview | Preview baked .spk and .efk resources through the Mapper particle window using explicit placement, seed, scale, offset, and optional prewarm. | The preview uses the same ParticleSystem facade and runtime extensions as the game. | Source/Tools/ParticleEditor.cpp |
particle-format.tooling.spark-editor |
Mapper SPARK editor | Edit raw .spark assets in Mapper, save through the SPARK XML saver, then rebake and recreate the .spk preview. | The editor reads source assets while previewing the baked runtime form. | Source/Tools/SparkParticleEditor.cpp |
particle-format.tooling.effekseer-editor |
Standalone Effekseer Editor | Build and stage the Windows Effekseer authoring tool through buildtools.py build-auxiliary; do not ship it as a game runtime dependency. | The editor has an isolated auxiliary build and staged payload. | BuildTools/buildtools.py BuildTools/EffekseerEditor/build.ps1 |
particle-format.tooling.incremental-effekseer |
Effekseer dependency cache | Let ParticleBaker track compiler-reported dependency snapshots; force a full rebake after changing compiler behavior. | The cache invalidates an effect when its project or dependencies change. | Source/Tools/ParticleBaker.cpp |
particle-format.tooling.normalized-round-trip |
Serializer-normalized round trip | Expect Save to rewrite object ordering, optional/default fields, nesting, references, and formatting according to the SPARK graph serializer; review the semantic diff. | The editor saves an object graph, not a token-preserving XML syntax tree. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLSaver.cpp |