Documentation
Docs/en/reference/particle-format/index.md
Generated Particle Format Reference
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 |
This reference describes the optional SPARK and Effekseer authoring, baking, runtime, Mapper, integration, and validation contract.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | SPARK and Effekseer are independent optional backends. Embedding projects must pin an Engine revision and explicitly enable, test, and support the formats they ship. |
| Source manifest | BuildTools/ParticleFormatInterface.json |
| Contract digest | 79904fb9d0de9219cd484d56cf8d55888aba00a61172f1cb62ab44b1990bf44f |
| Authored extensions | spark, efkproj |
| Runtime extensions | spk, efk |
| Runtime side | client |
| Reference | Entries | Purpose |
|---|---|---|
| Source rules | 12 | Authored XML and dependency boundaries. |
| Formats and backends | 4 | Optional backends and source-to-runtime forms. |
| Rendering | 19 | Backend rendering routes and fields. |
| Tooling | 5 | Mapper and standalone authoring workflows. |
| Runtime | 14 | Composition, routing, seed, scale, and prewarm. |
| Integration | 6 | Sprite, model, script, and project boundaries. |
| Validation | 7 | Documentation, native, bake, and visible gates. |
Boundary
Included:
- SPARK .spark authoring and baked .spk delivery
- Effekseer .efkproj authoring and baked .efk delivery
- backend-neutral particle runtime and sprite integration
- Mapper preview and SPARK authoring tools
- resource, model, and client-script integration
- source-backed validation and production gates
Excluded:
- embedding-project particle catalogs, filenames, visual policy, and budgets
- project-selected effects, textures, models, and acceptance scenes
- unsupported Effekseer renderer families and advanced capabilities
- upstream editor behavior that is not present in the bundled tools
- generated .spk and .efk files as authored source