NPC Helper 2/Docs
You are reading the documentation for v2.2.0. Switch to v2.4.0

Authoring

Sprites & Portraits

Prepare NPC Helper 2 sprite sheets and portraits, and configure location or seasonal image variants.

Put character art in the NPC's sprites/ and portraits/ folders. Image paths are selected by file name; they are not set in TOML.

text
NPCs/Rei/
├── sprites/
│   ├── Default.png
│   ├── Hospital.png
│   └── summer.png
└── portraits/
    ├── Default.png
    ├── Hospital.png
    └── Marriage.png

Image sheets#

  • sprites/Default.png is the default character sprite sheet. It uses four columns of 16 × 32 pixel frames, with walking poses arranged by direction.
  • portraits/Default.png is the default portrait sheet. It uses two columns of 64 × 64 pixel faces.
  • The game uses the sheets as sprite and portrait assets. Keep the frame grid and image dimensions consistent with Stardew Valley's expected character sheets.

To select standard or custom portrait expressions in dialogue, see Portrait expressions.

Variants and fallback#

Any image other than Default.png is treated as a variant named after the file:

  • sprites/Hospital.png or portraits/Hospital.png is used when the NPC is in the Hospital location.
  • sprites/summer.png or portraits/summer.png is used during summer.

For each image type, the selected file follows this priority:

  1. A variant matching the NPC's current location.
  2. A variant matching the current season.
  3. Default.png.

Use the location's exact game name and a season name (spring, summer, fall, or winter). Location variants take priority if both location and season variants exist. If the matching variant is absent, the next fallback is used.

Wedding artwork#

For a marriageable NPC, draw the wedding outfit in frames 36, 37, and 38 of sprites/Default.png. Those are the three wedding ceremony poses. A blank frame can make the NPC invisible during that pose.

An optional portraits/Marriage.png is shown while the NPC speaks wedding vows. Without it, the normal portrait is used. See Marriage.

Images are not localized. TOML text and data can be translated separately; see Localization.