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

Authoring

Marriage

Configure engagement lines, spouse dialogue and schedules, wedding vows, and wedding artwork.

Marriage content is available when [Romance] Marriageable = true. Marriageable NPCs are also dateable.

Use Marriage.toml for engagement text, spouse dialogue, and vows. Put the spouse routine in the [Marriage] table of Schedule.toml.

text
NPCs/Rei/
├── Rei.toml
├── Marriage.toml
├── Schedule.toml
└── portraits/
    └── Marriage.png

Engagement, spouse dialogue, and vows#

toml
[Engagement]
AcceptMermaidPendant = "This... is a Mermaid Pendant, right? I will."
Engagement_Generic = "We are really doing this, huh?"

[Dialogue]
Good_0 = "Good morning, @."
Rainy_Day_0 = "Rain again..."

[Wedding]
Vows = [
  "I waited a long time for this day.$h",
  "I'll stay right next to you, @.$l",
]
  • [Engagement] accepts AcceptMermaidPendant and Engagement_Generic; the vanilla-style keys <Name>0, <Name>1, and roommate equivalents are also supported.
  • [Dialogue] contains Stardew spouse dialogue keys, such as Good_0 or Rainy_Day_0.
  • [Wedding] Vows is a list of lines spoken during the game's wedding ceremony. If omitted, the game uses its standard wedding dialogue.
  • Vow text uses Stardew dialogue syntax. Avoid quotation marks, /, square brackets, and line breaks inside a vow.

Spouse schedule#

Add spouse routines to the [Marriage] table in Schedule.toml:

toml
[Schedule]
Weekday = ["600 Town 10 12 2"]

[Marriage]
Weekday = ["6:00 FarmHouse x=20 y=4 face=down"]
summer_12 = ["900 Farm 20 20 2"]

Spouse schedules use the same stop format as ordinary schedules but have fewer supported key types:

  • Weekday keys such as Mon–Sun (or Weekday) are used when it is not raining.
  • A date such as summer_12 can override the weekday schedule.
  • Festival keys can be used when the game requests the matching festival schedule.
  • Rain, season-only, and friendship-level spouse keys are not supported by the game for custom NPC spouses.

fall_Mon is expanded into the matching dates in that season. Use an explicit date key when you want to control one date directly.

If a [Marriage] schedule is supplied while the NPC is not marriageable, it is ignored and a warning is logged.

Wedding images#

The wedding ceremony uses frames 36–38 of sprites/Default.png for the character's wedding outfit. An optional portraits/Marriage.png is displayed while the NPC says their vows; normal portraits are used if the file is absent. See Sprites & Portraits.

Current boundaries#

NPC Helper 2 adds content to the game's existing marriage behavior. It does not provide custom spouse rooms, patios, or a replacement wedding-event system. Design these parts around Stardew Valley's supported character and marriage data.

Translation#

Localized [Engagement], spouse [Dialogue], and Vows belong in locale/<language>/Marriage.toml. A translated spouse schedule belongs in locale/<language>/Schedule.toml; see Localization.