Modding:Shops - Revision history

imported>Tlitookilakin: /* Format */ removed PerItemCondition, as it is included in common fields

2026-10-13T17:44:19Z

Format: removed PerItemCondition, as it is included in common fields

← Older revision		Revision as of 17:44, 13 October 2026
Line 79:		Line 79:

	Default <samp>Global</samp>.		Default <samp>Global</samp>.
	\|-
	~~\| <samp>PerItemCondition</samp>~~
	\| ''(Optional)'' A [[Modding:Game state queries\|game state query]] which indicates whether an item produced from the other fields should be added (e.g. to filter results from item queries like <samp>ALL_ITEMS</samp>). Defaults to always added.
	\|-		\|-
	\| <samp>ActionsOnPurchase</samp>		\| <samp>ActionsOnPurchase</samp>

imported>JigJag: Reverted Last Update

2026-04-13T15:26:35Z

Reverted Last Update

@@ Line 367: / Line 367: @@
                  { "Id": "Example.ModId_Pufferfish", "BeforeId": "(O)685" }
+             ]
+         }
+     ]

imported>JigJag: Added an example of how to code it to where the shop items change every day.

2026-04-13T15:19:13Z

Added an example of how to code it to where the shop items change every day.

@@ Line 367: / Line 367: @@
                  { "Id": "Example.ModId_Pufferfish", "BeforeId": "(O)685" }
+             ]
+         }
+     ]

imported>Sunbeam135: added ru link

2026-03-08T21:30:44Z

added ru link

← Older revision		Revision as of 21:30, 8 March 2026
Line 531:		Line 531:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Магазины]]
	[[zh:模组:商店]]		[[zh:模组:商店]]

imported>Pathoschild: /* Format */ expand 'owner' field docs so it's clearer how it actually works; add valign=top to tall fields

2025-08-09T01:17:47Z

Format: expand 'owner' field docs so it's clearer how it actually works; add valign=top to tall fields

← Older revision		Revision as of 01:17, 9 August 2025
Line 12:		Line 12:
	! effect		! effect
	\|-		\|-
	\| <samp>Items</samp>		\|valign="top"\| <samp>Items</samp>
	\| The items to add to the shop inventory. This consists of a list of values with these fields:		\| The items to add to the shop inventory. This consists of a list of values with these fields:
	{\| class="wikitable"		{\| class="wikitable"
Line 59:		Line 59:
	\| ''(Optional)'' The maximum number of the item which can be purchased in one day. Default unlimited.		\| ''(Optional)'' The maximum number of the item which can be purchased in one day. Default unlimited.
	\|-		\|-
	\| <samp>AvailableStockLimit</samp>		\|valign="top"\| <samp>AvailableStockLimit</samp>
	\| ''(Optional)'' If <samp>Stock</samp> is set, how the limit is applied in multiplayer. This has no effect on recipes.		\| ''(Optional)'' If <samp>Stock</samp> is set, how the limit is applied in multiplayer. This has no effect on recipes.

Line 97:		Line 97:
	\| ''(Optional)'' A list of [[Modding:Context tags\|context tags]] for items which the player can sell to to this shop. Default none.		\| ''(Optional)'' A list of [[Modding:Context tags\|context tags]] for items which the player can sell to to this shop. Default none.
	\|-		\|-
	\| <samp>Owners</samp>		\|valign="top"\| <samp>Owners</samp>
	\| ''(Optional)'' The portrait and dialogue ~~to show in~~ the shop ~~menu UI,~~ ''or'' the ~~message to show indicating that the shop is closed if~~ <samp>~~ClosedMessage~~</samp> ~~is set~~.		\| ''(Optional)'' The 'owner' data to apply when the shop is opened. This affects the portrait and dialogue shown, and whether the shop is closed. This field is checked ''after'' conditions specified in the [[Modding:Maps#Action\|<samp>Action OpenShop</samp> tile property]].

	When the [[Modding:Maps#Action\|<samp>Action OpenShop</samp> tile property]] ~~specifies {{o\|owner tile area}}~~, the ~~first NPC within the tile area which matches an owner entry is used; if~~ no ~~NPCs match~~, the shop isn't opened~~. If <samp>Owners</samp> is omitted, the shop is opened regardless of whether an NPC is present, and no portrait or dialogue is shown~~.		The behavior depends on whether <samp>Owners</samp> is set:
			* If omitted, the shop is opened regardless of whether an NPC is present, and no portrait or dialogue is shown.
			* If it's specified, this consists of an ''ordered'' list. When the player opens the shop, the first matching entry is applied. When searching for an NPC, each entry checks either the {{o\|owner tile area}} from the [[Modding:Maps#Action\|<samp>Action OpenShop</samp> tile property]] (if set), else the whole location. If no entries are matched, the shop isn't opened.

	This ~~consists of~~ a list ~~of models with~~ these fields:		For example, let's say a shop has these owners:
			<syntaxhighlight lang="js">
			"Owners": [
			{
			"Name": "AnyOrNone",
			"ClosedMessage": "The shop opens from 1pm to 2pm.",
			"Condition": "!TIME 1300 1400"
			},
			{
			"Name": "Any",
			"Dialogues": [ "Hi there!" ]
			},
			{
			"Name": "Abigail",
			"Dialogues": [ "This entry is never selected." ]
			},
			]
			</syntaxhighlight>

			Here's what happens when the player clicks the shop:

			# If it's not 1pm to 2pm, the first entry matches. The <samp>ClosedMessage</samp> shows a matching dialogue box and the shop isn't opened.
			# Else if any NPC is present, the second entry applies. The third entry is always ignored, since Abigail would match the <code>"Name": "Any"</code> check.
			# Else the shop isn't opened.

			Each model in the list can specify these fields:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 216:		Line 243:
	\| ''(Optional)'' A [[Modding:Migrate to Stardew Valley 1.6#Quantity modifiers\|quantity modifier mode]] which indicates what to do if multiple modifiers in the <samp>PriceModifiers</samp> field apply at the same time. This only affects that specific field, it won't affect price modifiers under <samp>Items</samp>. Default <samp>Stack</samp>.		\| ''(Optional)'' A [[Modding:Migrate to Stardew Valley 1.6#Quantity modifiers\|quantity modifier mode]] which indicates what to do if multiple modifiers in the <samp>PriceModifiers</samp> field apply at the same time. This only affects that specific field, it won't affect price modifiers under <samp>Items</samp>. Default <samp>Stack</samp>.
	\|-		\|-
	\| <samp>VisualTheme</samp>		\|valign="top"\| <samp>VisualTheme</samp>
	\| ''(Optional)'' The visual theme to apply to the shop UI, or omit to use the default theme. The first matching theme is applied. All fields are optional and will fallback to the default theme.		\| ''(Optional)'' The visual theme to apply to the shop UI, or omit to use the default theme. The first matching theme is applied. All fields are optional and will fallback to the default theme.

imported>Pathoschild: /* Format */ clarify how ClosedMessage works

2025-08-06T01:58:51Z

Format: clarify how ClosedMessage works

← Older revision		Revision as of 01:58, 6 August 2025
Line 167:		Line 167:
	\|-		\|-
	\| <samp>ClosedMessage</samp>		\| <samp>ClosedMessage</samp>
	\| ''(Optional)'' If set, a [[Modding:Tokenizable strings\|tokenizable string]] for a 'shop is closed'-style message to display ~~during the shop's open hours~~ when ~~a valid <samp>Owner</samp>~~ is ~~not present. The player must be positioned in the direction specified in the shop's {{o\|from direction}} for the message to display~~.		\| ''(Optional)'' If set, a [[Modding:Tokenizable strings\|tokenizable string]] for a 'shop is closed'-style message to display when this entry is selected.

	'''This ~~can~~ only ~~be set in an~~ <samp>Owners</samp> ~~entry with~~ the <samp>~~Name~~</samp> <samp>~~"None"~~</samp> or ~~<samp>"AnyOrNone"</samp> or your~~ shop ~~will break!''' If~~ you set a <samp>~~ClosedMessage~~</samp> field ~~set inside an <samp>Owners</samp>~~ entry ~~using <samp>"Any"</samp> or an NPC's name, the <samp>ClosedMessage</samp> will display instead of opening~~ the shop ~~when the NPC~~ is ~~present~~.		'''Notes:'''
			* This only applies if the <samp>Owners</samp> list is checked (i.e. the [[#Open a custom shop\|<samp>Action OpenShop</samp> conditions]] match). If you want to customize the message shown for the shop opening hours, remove the conditions from <samp>Action OpenShop</samp> and set them on this entry instead.
			* If the selected entry sets this field, the shop is closed regardless of any other fields or whether the shop owner is present. When you set the <samp>Name</samp> field, that affects whether this entry is selected (i.e. whether the shop is closed).
	\|}		\|}
	\|-		\|-

imported>Margotbean: remove underscores from links

2025-07-26T20:08:35Z

remove underscores from links

← Older revision		Revision as of 20:08, 26 July 2025
Line 415:		Line 415:
	\| <samp>Traveler</samp>		\| <samp>Traveler</samp>
	\|-		\|-
	\| [[~~Volcano_Dungeon~~#Shop\|Volcano dwarf shop]]		\| [[Volcano Dungeon#Shop\|Volcano dwarf shop]]
	\| <samp>VolcanoShop</samp>		\| <samp>VolcanoShop</samp>
	\|-		\|-
Line 432:		Line 432:
	\|-		\|-
	\|-		\|-
	\| [[~~Desert_Festival~~#~~Calico_Egg_Merchant~~\|Desert Festival (egg merchant)]]		\| [[Desert Festival#Calico Egg Merchant\|Desert Festival (egg merchant)]]
	\| <samp>DesertFestival_EggShop</samp>		\| <samp>DesertFestival_EggShop</samp>
	\|-		\|-
	\|-		\|-
	\| [[~~Desert_Festival~~#~~Villager_Shops~~\|Desert Festival (villager shops)]]		\| [[Desert Festival#Villager Shops\|Desert Festival (villager shops)]]
	\| <samp>DesertFestival_{{t\|name}}</samp><br />(e.g. <samp>DesertFestival_Abigail)</samp>		\| <samp>DesertFestival_{{t\|name}}</samp><br />(e.g. <samp>DesertFestival_Abigail)</samp>
	\|-		\|-
Line 454:		Line 454:
	\| <samp>Festival_Luau_Pierre</samp>		\| <samp>Festival_Luau_Pierre</samp>
	\|-		\|-
	\| [[~~Night_Market~~#~~Decoration_Boat~~\|Night Market (decoration boat)]]		\| [[Night Market#Decoration Boat\|Night Market (decoration boat)]]
	\| <samp>Festival_NightMarket_DecorationBoat</samp>		\| <samp>Festival_NightMarket_DecorationBoat</samp>
	\|-		\|-
	\| [[~~Night_Market~~#~~Magic_Shop_Boat~~\|Night Market (magic boat)]]		\| [[Night Market#Magic Shop Boat\|Night Market (magic boat)]]
	\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>		\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>
	\|-		\|-

imported>Doragoun: Fixed mismatched links for the Night Market boats

2025-07-26T10:46:28Z

Fixed mismatched links for the Night Market boats

← Older revision		Revision as of 10:46, 26 July 2025
Line 454:		Line 454:
	\| <samp>Festival_Luau_Pierre</samp>		\| <samp>Festival_Luau_Pierre</samp>
	\|-		\|-
	\| [[Night_Market#~~Magic_Shop_Boat~~\|Night Market (decoration boat)]]		\| [[Night_Market#Decoration_Boat\|Night Market (decoration boat)]]
	\| <samp>Festival_NightMarket_DecorationBoat</samp>		\| <samp>Festival_NightMarket_DecorationBoat</samp>
	\|-		\|-
	\| [[Night_Market#~~Decoration_Boat~~\|Night Market (magic boat)]]		\| [[Night_Market#Magic_Shop_Boat\|Night Market (magic boat)]]
	\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>		\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>
	\|-		\|-

imported>Doragoun: Added IDs for volcano dwarf shop and Desert Festival shops and updated Night Market links to lead to their respective sections on the Night Market page

2025-07-26T10:44:43Z

Added IDs for volcano dwarf shop and Desert Festival shops and updated Night Market links to lead to their respective sections on the Night Market page

← Older revision		Revision as of 10:44, 26 July 2025
Line 414:		Line 414:
	\| [[Traveling Cart\|Traveling cart]]		\| [[Traveling Cart\|Traveling cart]]
	\| <samp>Traveler</samp>		\| <samp>Traveler</samp>
			\|-
			\| [[Volcano_Dungeon#Shop\|Volcano dwarf shop]]
			\| <samp>VolcanoShop</samp>
	\|-		\|-
	\| [[Fish Shop\|Willy's fish shop]]		\| [[Fish Shop\|Willy's fish shop]]
Line 427:		Line 430:
	\| [[Dance of the Moonlight Jellies]]		\| [[Dance of the Moonlight Jellies]]
	\| <samp>Festival_DanceOfTheMoonlightJellies_Pierre</samp>		\| <samp>Festival_DanceOfTheMoonlightJellies_Pierre</samp>
			\|-
			\|-
			\| [[Desert_Festival#Calico_Egg_Merchant\|Desert Festival (egg merchant)]]
			\| <samp>DesertFestival_EggShop</samp>
			\|-
			\|-
			\| [[Desert_Festival#Villager_Shops\|Desert Festival (villager shops)]]
			\| <samp>DesertFestival_{{t\|name}}</samp><br />(e.g. <samp>DesertFestival_Abigail)</samp>
	\|-		\|-
	\| [[Egg Festival]]		\| [[Egg Festival]]
Line 443:		Line 454:
	\| <samp>Festival_Luau_Pierre</samp>		\| <samp>Festival_Luau_Pierre</samp>
	\|-		\|-
	\| [[Night Market]] (decoration boat)		\| [[Night_Market#Magic_Shop_Boat\|Night Market (decoration boat)]]
	\| <samp>Festival_NightMarket_DecorationBoat</samp>		\| <samp>Festival_NightMarket_DecorationBoat</samp>
	\|-		\|-
	\| [[Night Market]] (magic boat)		\| [[Night_Market#Decoration_Boat\|Night Market (magic boat)]]
	\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>		\| <samp>Festival_NightMarket_MagicBoat_Day1</samp><br /><samp>Festival_NightMarket_MagicBoat_Day2</samp><br /><samp>Festival_NightMarket_MagicBoat_Day3</samp>
	\|-		\|-

imported>Mr.Qi: Added shop id for Bookseller

2025-04-07T15:35:29Z

Added shop id for Bookseller

← Older revision		Revision as of 15:35, 7 April 2025
Line 359:		Line 359:
	\|-		\|-
	\| [[Bookseller]]		\| [[Bookseller]]
	\| <samp>BooksellerTrade</samp>		\| <samp>Bookseller</samp> (regular shop)<br /><samp>BooksellerTrade</samp> (book trades)
	\|-		\|-
	\| [[Casino]]		\| [[Casino]]