Particle Texture Configuration

Register the sprite image for a particle effect (smoke, sparks, leaves).

Particle textures give a particle (registered in Particle Configuration) its sprite image. Unlike mob/item/mount textures, particles are rendered as a single static image — there is no sprite-sheet slicing or in-place animation at render time.


File Location

Config file:

mods/<your-mod>/assets/textures/particles/particles.yaml

Texture images go in the same folder:

mods/<your-mod>/assets/textures/particles/<name>.png

The file name must match the name field exactly (case-sensitive), with spaces kept as spaces in the file name.


Minimal Example

textures:
  - name: my_spark
    frame-width: 8
    frame-height: 8
    sprites:
      - frame-count: 1

This registers the sprite for my_spark (a particle that must already exist in particle-config.yaml) from my_spark.png.


Full Field Reference

textures:
  - name: my_spark        # Required. Must match a name already registered in particle-config.yaml
FieldRequiredDescription
nameYesMust match a name already registered in particle-config.yaml.
frame-widthNoIgnored. Accepted (as a number) for forward compatibility; omitting it is fine.
frame-heightNoIgnored. Accepted (as a number) for forward compatibility; omitting it is fine.
spritesNoIgnored. Accepted for forward compatibility; omitting it is fine.
sprites[].frame-countNoIgnored. Accepted (as a number) for forward compatibility; omitting it is fine.

Note: frame-width, frame-height, and sprites (with frame-count) have no effect — particles currently always render their full source image as one static, non-animated sprite. They are now optional: a missing value simply defaults and does not stop the particle’s texture from loading. A present value must still be the right type (a number where a number is expected), so a leftover block from an older config won’t error, but a garbled one will. Only name matters.


Complete Example

Based on the real shipped particle textures:

textures:
  - name: cherry_leaf
    sprites:
      - name: cherry_leaf
        frame-count: 1
    frame-width: 8
    frame-height: 8
  - name: torch_smoke
    sprites:
      - name: torch_smoke
        frame-count: 1
    frame-width: 6
    frame-height: 6
  - name: torch_spark
    sprites:
      - name: torch_spark
        frame-count: 1
    frame-width: 2
    frame-height: 2