Modding:Festival data - Revision history

imported>Nbeymer99: /* Shop format */ Added note about alternate festival shop format.

2025-10-11T00:22:59Z

Shop format: Added note about alternate festival shop format.

← Older revision		Revision as of 00:22, 11 October 2025
Line 176:		Line 176:
	\| How many of that item can be purchased from the shop, or <samp>-1</samp> for unlimited.		\| How many of that item can be purchased from the shop, or <samp>-1</samp> for unlimited.
	\|}		\|}

			Shop data may also be stored in <samp>Data/Shops</samp> and accessed via a map tile action, as non-festival shops are.

	==Map==		==Map==

imported>Abagaianye: Updating raw data from 1.5.4 to 1.6.15 on nic's behalf

2025-10-09T05:29:32Z

Updating raw data from 1.5.4 to 1.6.15 on nic's behalf

@@ Line 7: / Line 7: @@
 ===Raw data===
-The festival data file can be [[Modding:Editing XNB files#unpacking|unpacked for editing]]. For example, here's the raw data from <samp>Data/Festivals/fall27</samp> as of {{version|1.5.4}} for reference:
+The festival data file can be [[Modding:Editing XNB files#unpacking|unpacked for editing]]. For example, here's the raw data from <samp>Data/Festivals/fall27</samp> as of {{version|1.6.15}} for reference:
 {{collapse|Data|content=<syntaxhighlight lang="json">
+{
    "name": "Spirit's Eve",
    "conditions": "Town/2200 2350",
-  "shop": "BO 113 5000 1 O 746 750 5 BL 746 2000 1 BO 47 350 -1 F 2870 4000 -1",
+   "set-up": "spirits_eve/-1000 -1000/farmer 12 54 1/changeToTemporaryMap Town-Halloween/viewport -1000 -1000/loadActors Set-Up/advancedMove Maru true 0 2 2 0 0 3 -11 0 0 -7 5 0 0 2 4 0/advancedMove Alex true -4 0 4 4000 4 0 4 5000/advancedMove Jas true 1 1500 4 1000/advancedMove Pam true 0 1 1 5000 0 -1 1 5000/advancedMove Shane true -7 0 0 2 2 9000 0 -2 7 0 4 9000/advancedMove Demetrius true 3 18000 4 3000/addTemporaryActor Skeleton 16 32 30 59 2 false Monster/advancedMove Skeleton true 0 1 3 4000 2 0 0 -1 4 2000 -1 0 3 1000 2 2000 0 -1 4 4000 -1 0 0 1 2 5000/addTemporaryActor Skeleton 16 32 35 58 2 false Monster/playerControl halloween/viewport player clamp true unfreeze/globalFadeToClear",
    "Abigail_spouse": "You'll have to tell me what's beyond, I can't go on... spiders...$s",
    "Leah_spouse": "I may have had a little too much pumpkin ale...",
@@ Line 55: / Line 54: @@
    "Vincent": "Mother won't let me go in the maze. *sob*$s",
    "Marlon": "Don't get too close to the cage.",
-   "Leo": "%Leo's unblinking eyes are glued to the screen. You're unable to get his attention."
+   "Leo": "%Leo's unblinking eyes are glued to the screen. You're unable to get his attention.",
+}
 </syntaxhighlight>}}

imported>Nbeymer99: Added a note about FestivalDates. Removed Content/ from filepaths.

2025-10-09T05:03:40Z

Added a note about FestivalDates. Removed Content/ from filepaths.

← Older revision		Revision as of 05:03, 9 October 2025
Line 4:		Line 4:

	==Data file==		==Data file==
	Each festival has a data file located at <samp>~~Content/~~Data/Festivals/<season><day of month></samp>. The game uses this asset to determine whether there's a festival today (if the asset exists), where and when it happens, and NPC placement/dialogue/behavior.		Each festival has a data file located at <samp>Data/Festivals/<season><day of month></samp>. The game uses this asset to determine whether there's a festival today (if the asset exists), where and when it happens, and NPC placement/dialogue/behavior. The game also has a data file located at <samp>Data/Festivals/FestivalDates</samp> which contains the names and dates of festivals. Mod authors who wish to add a custom festival will need to add an entry to it as well.

	===Raw data===		===Raw data===
	The festival data file can be [[Modding:Editing XNB files#unpacking\|unpacked for editing]]. For example, here's the raw data from <samp>~~Content/~~Data/Festivals/fall27</samp> as of {{version\|1.5.4}} for reference:		The festival data file can be [[Modding:Editing XNB files#unpacking\|unpacked for editing]]. For example, here's the raw data from <samp>Data/Festivals/fall27</samp> as of {{version\|1.5.4}} for reference:
	{{collapse\|Data\|content=<syntaxhighlight lang="json">		{{collapse\|Data\|content=<syntaxhighlight lang="json">
	{		{
Line 130:		Line 130:

	==Map==		==Map==
	Many festivals use a separate [[Modding:Maps\|map file]] located in the <samp>~~Content/~~Maps</samp> folder. The map to use is specified in the [[#Data file\|data file]]'s <samp>set-up</samp> field using the <samp>changeToTemporaryMap</samp> command.		Many festivals use a separate [[Modding:Maps\|map file]] located in the <samp>Maps</samp> folder. The map to use is specified in the [[#Data file\|data file]]'s <samp>set-up</samp> field using the <samp>changeToTemporaryMap</samp> command.

	===Spawned NPCs===		===Spawned NPCs===

imported>Margotbean: rm underscores

2025-05-15T08:30:19Z

rm underscores

← Older revision		Revision as of 08:30, 15 May 2025
Line 84:		Line 84:
	\|-		\|-
	\| <samp>startedMessage</samp>		\| <samp>startedMessage</samp>
	\| A [[Modding:~~Tokenizable_strings~~\|tokenizable string]] for a custom festival-started notification message.		\| A [[Modding:Tokenizable strings\|tokenizable string]] for a custom festival-started notification message.
	\|-		\|-
	\| <samp>MainEvent_additionalCharacters</samp>, or<br><samp>Main-Event_additionalCharacters</samp> for the [[Festival of Ice\|Festival of Ice]]		\| <samp>MainEvent_additionalCharacters</samp>, or<br><samp>Main-Event_additionalCharacters</samp> for the [[Festival of Ice\|Festival of Ice]]
Line 151:		Line 151:

	[[ru:Модификации:Фестивали]]		[[ru:Модификации:Фестивали]]

	[[zh:模组:节日数据]]		[[zh:模组:节日数据]]

imported>BarleyZP: Add startedMessage and year variants info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild).

2025-05-14T18:44:45Z

Add startedMessage and year variants info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild).

imported>BarleyZP: Add "See also" section with link to passive festival data page

2025-05-12T21:58:41Z

Add "See also" section with link to passive festival data page

← Older revision		Revision as of 21:58, 12 May 2025
Line 140:		Line 140:

	The [[Night Market]] is also handled differently from other festivals. While there are separate Night Market maps, the NPC data doesn't exist on these. Instead, NPCs dynamically enter and leave the festival via schedule data.		The [[Night Market]] is also handled differently from other festivals. While there are separate Night Market maps, the NPC data doesn't exist on these. Instead, NPCs dynamically enter and leave the festival via schedule data.

			==See also==

			[[Modding:Passive Festival data]] for information about passive festivals.

	[[Category:Modding]]		[[Category:Modding]]

imported>Pathoschild: /* Spawned NPCs */ update for 1.6+

2025-04-03T23:19:38Z

Spawned NPCs: update for 1.6+

← Older revision		Revision as of 23:19, 3 April 2025
Line 132:		Line 132:
	{{note box\|'''This is fragile and not recommended for custom NPCs or festivals.'''<br />Consider using the [[#Data file\|data file]]'s <samp>Set-Up_additionalCharacters</samp> field instead.}}		{{note box\|'''This is fragile and not recommended for custom NPCs or festivals.'''<br />Consider using the [[#Data file\|data file]]'s <samp>Set-Up_additionalCharacters</samp> field instead.}}

	NPCs can be added to festivals using map tile indexes on a specific layer. This is enabled in the [[#Data file\|data file]]'s <samp>set-up</samp> field using the <samp>loadActors {{t\|layer name}}</samp> command. For each tile which exists on the layer, the tile index is mapped to the NPC's ~~index~~ in the <samp>Data\~~NPCDispositions~~</samp> asset ~~multiplied by four~~, with an offset which determines the facing direction (0 = up, 1 = right, 2 = down, or 3 = left).		NPCs can be added to festivals using map tile indexes on a specific layer. This is enabled in the [[#Data file\|data file]]'s <samp>set-up</samp> field using the <samp>loadActors {{t\|layer name}}</samp> command. For each tile which exists on the layer, the tile index is mapped to the NPC's <samp>FestivalVanillaActorIndex</samp> field in the [[Modding:NPC data\|<samp>Data\Characters</samp> asset]], with an offset which determines the facing direction (0 = up, 1 = right, 2 = down, or 3 = left).

	For example, let's say the layer has a tile with tilesheet index 61. That's ~~the NPC at index <samp>61 / 4 = 15</samp> in~~ <~~samp~~>~~Data\NPCDispositions~~</~~samp~~>, ~~''i.e.,'' the 16th NPC, ''i.e.,'' Leah. The~~ offset ~~is <samp>61 % 4 =~~ 1~~</samp>,~~ so she's facing right. When the festival is loaded, ~~Leah~~ will be added to that tile position facing right.		For example, let's say the layer has a tile with tilesheet index 1. That matches Abigail's entry (<code>"FestivalVanillaActorIndex": 0</code>), with an offset of 1 so she's facing right. When the festival is loaded, Abigail will be added to that tile position facing right.

	==Hardcoded logic==		==Hardcoded logic==

imported>BarleyZP: /* Format */ further grammar fixes

2025-03-27T16:39:09Z

Format: further grammar fixes

← Older revision		Revision as of 16:39, 27 March 2025
Line 96:		Line 96:
	\|-		\|-
	\| <samp>locationDisplayName</samp>		\| <samp>locationDisplayName</samp>
	\| The location name in the festival-started message (''e.g.,'' "''The Luau has begun on the beach''") by default shows the internal name for non-vanilla festival locations. You can add ~~a <samp>locationDisplayName</samp>~~ field ~~in the <samp>Data/Festivals/*</samp> file~~ to set the display name.		\| The location name in the festival-started message (''e.g.,'' "''The Luau has begun on the beach''") by default shows the internal name for non-vanilla festival locations. You can add this field to set the display name.
	\|}		\|}

imported>BarleyZP: /* Format */ Formatting fixes from migration page pasting

2025-03-27T16:38:27Z

Format: Formatting fixes from migration page pasting

← Older revision		Revision as of 16:38, 27 March 2025
Line 96:		Line 96:
	\|-		\|-
	\| <samp>locationDisplayName</samp>		\| <samp>locationDisplayName</samp>
	\| ~~Copied from [[Modding:Migrate to Stardew Valley 1.5.5]]:~~ The location name in the festival-started message (''e.g.,'' "''The Luau has begun on the beach''") ~~was previously hardcoded, so it would always show~~ the internal name for non-vanilla festival locations. You can ~~now~~ add a <samp>locationDisplayName</samp> field in the <samp>Data/Festivals/*</samp> file to set the display name.		\| The location name in the festival-started message (''e.g.,'' "''The Luau has begun on the beach''") by default shows the internal name for non-vanilla festival locations. You can add a <samp>locationDisplayName</samp> field in the <samp>Data/Festivals/*</samp> file to set the display name.
	\|}		\|}

imported>BarleyZP: /* Format */ add info from Modding:Migrate to Stardew Valley 1.5.5 (main author Pathoschild, with formatting fixes by Margotbean)

2025-03-27T16:37:38Z

Format: add info from Modding:Migrate to Stardew Valley 1.5.5 (main author Pathoschild, with formatting fixes by Margotbean)

← Older revision		Revision as of 16:37, 27 March 2025
Line 94:		Line 94:
	\| <samp>{{t\|NPC name}}</samp>		\| <samp>{{t\|NPC name}}</samp>
	\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if <samp>{{t\|NPC name}}_spouse</code></samp> doesn't exist or apply. This field supports [[#Year variants\|year variants]].		\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if <samp>{{t\|NPC name}}_spouse</code></samp> doesn't exist or apply. This field supports [[#Year variants\|year variants]].
			\|-
			\| <samp>locationDisplayName</samp>
			\| Copied from [[Modding:Migrate to Stardew Valley 1.5.5]]: The location name in the festival-started message (''e.g.,'' "''The Luau has begun on the beach''") was previously hardcoded, so it would always show the internal name for non-vanilla festival locations. You can now add a <samp>locationDisplayName</samp> field in the <samp>Data/Festivals/*</samp> file to set the display name.
	\|}		\|}

← Older revision		Revision as of 18:44, 14 May 2025
Line 78:		Line 78:
	\|-		\|-
	\| <samp>set-up</samp>		\| <samp>set-up</samp>
	\| The [[Modding:Event data\|event script]] that's run when the player first enters the festival. This includes moving the player to the festival map~~. This field supports [[#Year variants\|year variants]]~~.		\| The [[Modding:Event data\|event script]] that's run when the player first enters the festival. This includes moving the player to the festival map.
	\|-		\|-
	\| <samp>Set-Up_additionalCharacters</samp>		\| <samp>Set-Up_additionalCharacters</samp>
	\| NPCs to spawn when the festival loads. This is specified as four space-delimited fields in the form <samp>{{t\|NPC name}} {{t\|tile X}} {{t\|tile Y}} {{t\|facing direction}}</samp>, repeated for each NPC to add with a <code>/</code> between each NPC. The {{t\|facing direction}}</samp> can be one of <samp>up</samp> or <samp>0</samp>, <samp>down</samp> or <samp>2</samp>, <samp>left</samp> or <samp>3</samp>, and <samp>right</samp> or <samp>1</samp>. These are additional to the NPCs spawned via the [[#Map\|map file]]. For example, this adds Abigail and Leah side-by-side facing down: <syntaxhighlight lang="javascript">"Set-Up_additionalCharacters": "Abigail 15 6 down/Leah 16 6 down"</syntaxhighlight>~~This field supports~~ [[~~#Year variants~~\|~~year variants~~]].		\| NPCs to spawn when the festival loads. This is specified as four space-delimited fields in the form <samp>{{t\|NPC name}} {{t\|tile X}} {{t\|tile Y}} {{t\|facing direction}}</samp>, repeated for each NPC to add with a <code>/</code> between each NPC. The {{t\|facing direction}}</samp> can be one of <samp>up</samp> or <samp>0</samp>, <samp>down</samp> or <samp>2</samp>, <samp>left</samp> or <samp>3</samp>, and <samp>right</samp> or <samp>1</samp>. These are additional to the NPCs spawned via the [[#Map\|map file]]. For example, this adds Abigail and Leah side-by-side facing down: <syntaxhighlight lang="javascript">"Set-Up_additionalCharacters": "Abigail 15 6 down/Leah 16 6 down"</syntaxhighlight>
			\|-
			\| <samp>startedMessage</samp>
			\| A [[Modding:Tokenizable_strings\|tokenizable string]] for a custom festival-started notification message.
	\|-		\|-
	\| <samp>MainEvent_additionalCharacters</samp>, or<br><samp>Main-Event_additionalCharacters</samp> for the [[Festival of Ice\|Festival of Ice]]		\| <samp>MainEvent_additionalCharacters</samp>, or<br><samp>Main-Event_additionalCharacters</samp> for the [[Festival of Ice\|Festival of Ice]]
	\| NPCs to spawn when the festival's <code>mainEvent</code> script is run. Just like <code>mainEvent</code>, this is absent for events that do not have a prompt to start a new scene. The format is identical to <code>Set-Up_additionalCharacters</code>, above~~.<br>This field supports [[#Year variants\|year variants]]~~.		\| NPCs to spawn when the festival's <code>mainEvent</code> script is run. Just like <code>mainEvent</code>, this is absent for events that do not have a prompt to start a new scene. The format is identical to <code>Set-Up_additionalCharacters</code>, above.
	\|-		\|-
	\| <samp>{{t\|NPC name}}_roommate</samp>		\| <samp>{{t\|NPC name}}_roommate</samp>
	\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if they're roommates with the player. This field ~~supports [[#Year variants\|year variants]],~~ doesn't work on the Flower Dance festival, and doesn't support <samp>#$e#</samp> breaks. If not specified, the <samp>{{t\|NPC name}}_spouse</samp> will be used next.		\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if they're roommates with the player. This field doesn't work on the Flower Dance festival and doesn't support <samp>#$e#</samp> breaks. If not specified, the <samp>{{t\|NPC name}}_spouse</samp> will be used next.
	\|-		\|-
	\| <samp>{{t\|NPC name}}_spouse</samp>		\| <samp>{{t\|NPC name}}_spouse</samp>
	\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if they're married to the player. This field ~~supports [[#Year variants\|year variants]],~~ doesn't work on the Flower Dance festival, and doesn't support <samp>#$e#</samp> breaks.		\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if they're married to the player. This field doesn't work on the Flower Dance festival and doesn't support <samp>#$e#</samp> breaks.
	\|-		\|-
	\| <samp>{{t\|NPC name}}</samp>		\| <samp>{{t\|NPC name}}</samp>
	\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if <samp>{{t\|NPC name}}_spouse</code></samp> doesn't exist or apply~~. This field supports [[#Year variants\|year variants]]~~.		\| The [[Modding:Dialogue#Format\|dialog line]] the named NPC will say when the player talks to them, if <samp>{{t\|NPC name}}_spouse</code></samp> doesn't exist or apply.
	\|-		\|-
	\| <samp>locationDisplayName</samp>		\| <samp>locationDisplayName</samp>
Line 102:		Line 105:

	===Year variants===		===Year variants===
	~~Several~~ fields allow annual variants ~~(documented in the table above)~~. These work by adding <samp>_y{{t\|year variant}}</samp> to the end of key, where the {{t\|year variant}} is an incrementing number starting at 1 with no upper limit. For example, two entries <samp>set-up_y1</samp> and <samp>set-up_y2</samp> will alternate (<samp>set-up_y1</samp> in year 1, <samp>set-up_y2</samp> in year 2, <samp>set-up_y1</samp> in year 3, etc). If year variants are defined for a key, the original key is ignored (''e.g.,'' <samp>set-up</samp> will never be used if <samp>set-up_y*</samp> entries are defined).		All fields in the festival data allow annual variants. These work by adding <samp>_y{{t\|year variant}}</samp> to the end of key, where the {{t\|year variant}} is an incrementing number starting at 1 with no upper limit. For example, two entries <samp>set-up_y1</samp> and <samp>set-up_y2</samp> will alternate (<samp>set-up_y1</samp> in year 1, <samp>set-up_y2</samp> in year 2, <samp>set-up_y1</samp> in year 3, etc). If year variants are defined for a key, the original key is ignored (''e.g.,'' <samp>set-up</samp> will never be used if <samp>set-up_y*</samp> entries are defined).
	{{note box\|'''It is recommended to use the year variants for the <samp>Set-Up_additionalCharacters</samp> and <samp>MainEvent_additionalCharacters</samp> fields, even if you don't wish to spawn your custom NPC in different locations on odd and even years.'''<br>These keys are global to the festival data, and if <strong>any</strong> mod appends to them, the game will use those keys instead of the non-variant keys. This will cause any NPCs not using the year variant keys to fail to spawn.}}		{{note box\|'''It is recommended to use the year variants for the <samp>Set-Up_additionalCharacters</samp> and <samp>MainEvent_additionalCharacters</samp> fields, even if you don't wish to spawn your custom NPC in different locations on odd and even years.'''<br>These keys are global to the festival data, and if <strong>any</strong> mod appends to them, the game will use those keys instead of the non-variant keys. This will cause any NPCs not using the year variant keys to fail to spawn.}}