Modding:Museum - Revision history

imported>Sunbeam135 at 18:46, 6 March 2026

2026-03-06T18:46:25Z

← Older revision		Revision as of 18:46, 6 March 2026
Line 102:		Line 102:
	The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).		The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).

			[[ru:Модификации:Музей]]
	[[zh:模组:博物馆]]		[[zh:模组:博物馆]]

imported>Sunbeam135: Added a link to Index and RU

2026-03-06T18:45:38Z

Added a link to Index and RU

← Older revision		Revision as of 18:45, 6 March 2026
Line 1:		Line 1:
			← [[Modding:Index\|Index]]

	This page details adding custom museum donations and rewards. This is an advanced guide for mod developers		This page details adding custom museum donations and rewards. This is an advanced guide for mod developers

imported>Selph: fix wrong id tag format

2026-02-15T05:51:58Z

fix wrong id tag format

← Older revision		Revision as of 05:51, 15 February 2026
Line 70:		Line 70:
	"TargetContextTags": [		"TargetContextTags": [
	{		{
	"Tag": "~~id_~~{{ModId}}_ShinyArtifact", // unique context tag identifying the item by ID		"Tag": "id_o_{{ModId}}_ShinyArtifact", // unique context tag identifying the item by ID
	"Count": 1		"Count": 1
	},		},

imported>Pathoschild: use {{Content Patcher example}}, make example formatting consistent

2025-02-01T20:02:24Z

use {{Content Patcher example}}, make example formatting consistent

← Older revision		Revision as of 20:02, 1 February 2025
Line 37:		Line 37:
	\| <samp>RewardActions</samp>		\| <samp>RewardActions</samp>
	\| Run one or more [[Modding:Trigger actions\|trigger action strings]]. For example, this adds {{price\|500}} to the current player:		\| Run one or more [[Modding:Trigger actions\|trigger action strings]]. For example, this adds {{price\|500}} to the current player:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"RewardActions": [		"RewardActions": [
	"AddMoney 500"		"AddMoney 500"
Line 60:		Line 60:

	For example, this content pack adds two rewards (one mail and one item):		For example, this content pack adds two rewards (one mail and one item):
	~~{{#tag:syntaxhighlight\|<nowiki>~~		{{Content Patcher example\|<nowiki>
	{
	~~"Format": "</nowiki>~~{{Content Patcher ~~version}}~~<nowiki>",
	"Changes": [		"Changes": [
	{		{
Line 95:		Line 93:
	}		}
	]		]
	}</nowiki>~~\|lang=javascript~~}}		</nowiki>}}

	See also [[Modding:Mail data\|mail data]], [[Modding:Items\|custom items]], and [[Modding:Machines\|custom machines]] to add the custom mail and items.		See also [[Modding:Mail data\|mail data]], [[Modding:Items\|custom items]], and [[Modding:Machines\|custom machines]] to add the custom mail and items.

imported>VulpesLucida: +zh link

2025-01-10T23:45:09Z

+zh link

← Older revision		Revision as of 23:45, 10 January 2025
Line 101:		Line 101:
	==Achievements==		==Achievements==
	The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).		The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).

			[[zh:模组:博物馆]]

imported>Pathoschild: update link

2024-12-15T19:45:47Z

update link

← Older revision		Revision as of 19:45, 15 December 2024
Line 20:		Line 20:
	\|-		\|-
	\| <samp>Tag</samp>		\| <samp>Tag</samp>
	\| The [[Modding:~~Items#Context_tags~~\|context tag]] for the items to require.		\| The [[Modding:Context tags\|context tag]] for the items to require.
	\|-		\|-
	\| <samp>Count</samp>		\| <samp>Count</samp>

imported>Pathoschild: /* Data format */ clarify that donated max items includes custom ones

2024-06-15T19:30:29Z

Data format: clarify that donated max items includes custom ones

← Older revision		Revision as of 19:30, 15 June 2024
Line 28:		Line 28:
	For example, an entry with the tag <samp>forage_item</samp> and count 2 will require donating any two forage items.		For example, an entry with the tag <samp>forage_item</samp> and count 2 will require donating any two forage items.

	Special case: an entry with the exact values <code>Tag: "", Count: -1</code> passes if the museum is complete (i.e. the player has donated the max number of items).		Special case: an entry with the exact values <code>Tag: "", Count: -1</code> passes if the museum is complete (i.e. the player has donated the max number of items, including any custom items that can be donated).
	\|-		\|-
	\| <samp>FlagOnCompletion</samp>		\| <samp>FlagOnCompletion</samp>

imported>BarleyZP: /* Achievements */ Change heading size

2024-06-03T00:50:16Z

Achievements: Change heading size

← Older revision		Revision as of 00:50, 3 June 2024
Line 99:		Line 99:
	See also [[Modding:Mail data\|mail data]], [[Modding:Items\|custom items]], and [[Modding:Machines\|custom machines]] to add the custom mail and items.		See also [[Modding:Mail data\|mail data]], [[Modding:Items\|custom items]], and [[Modding:Machines\|custom machines]] to add the custom mail and items.

	====Achievements====		==Achievements==
	The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).		The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).

imported>BarleyZP: remove duplicate line

2024-06-03T00:49:57Z

remove duplicate line

← Older revision		Revision as of 00:49, 3 June 2024
Line 1:		Line 1:

	~~You can now add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.~~

	This page details adding custom museum donations and rewards. This is an advanced guide for mod developers		This page details adding custom museum donations and rewards. This is an advanced guide for mod developers

	==Data format==		==Data format==
	You can ~~now~~ add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.		You can add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.
	The data asset consists of a string → model lookup, where...		The data asset consists of a string → model lookup, where...
	* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the reward group.		* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the reward group.

imported>BarleyZP: /* Format */ Fix broken links

2024-06-03T00:49:37Z

Format: Fix broken links

← Older revision		Revision as of 00:49, 3 June 2024
Line 2:		Line 2:
	You can now add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.		You can now add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.

	====~~Format====~~		This page details adding custom museum donations and rewards. This is an advanced guide for mod developers

			==Data format==
			You can now add/edit the items which the [[museum]] gives back in rewards through the new <samp>Data/MuseumRewards</samp> data asset.
	The data asset consists of a string → model lookup, where...		The data asset consists of a string → model lookup, where...
	* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the reward group.		* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the reward group.
Line 20:		Line 23:
	\|-		\|-
	\| <samp>Tag</samp>		\| <samp>Tag</samp>
	\| The [[Modding:~~Context tags~~\|context tag]] for the items to require.		\| The [[Modding:Items#Context_tags\|context tag]] for the items to require.
	\|-		\|-
	\| <samp>Count</samp>		\| <samp>Count</samp>
Line 44:		Line 47:
	\|-		\|-
	\| <samp>RewardItemId</samp>		\| <samp>RewardItemId</samp>
	\| ''(Optional)'' The [[#~~Custom items~~\|qualified item ID]] for the item given to the player when they donate all required items for this group. There's no reward item if omitted.		\| ''(Optional)'' The [[Modding:Common_data_field_types#Item_ID\|qualified item ID]] for the item given to the player when they donate all required items for this group. There's no reward item if omitted.
	\|-		\|-
	\| <samp>RewardItemCount</samp>		\| <samp>RewardItemCount</samp>
Line 56:		Line 59:
	\|-		\|-
	\| <samp>CustomFields</samp>		\| <samp>CustomFields</samp>
	\| The [[#~~Custom data fields~~\|custom fields]] for this entry.		\| The [[Modding:Common_data_field_types#Custom_fields\|custom fields]] for this entry.
	\|}		\|}

Line 97:		Line 100:
	}</nowiki>\|lang=javascript}}		}</nowiki>\|lang=javascript}}

	See also [[Modding:Mail data\|mail data]], [[~~#Custom items~~\|custom items]], and [[~~#custom machines~~\|custom machines]] to add the custom mail and items.		See also [[Modding:Mail data\|mail data]], [[Modding:Items\|custom items]], and [[Modding:Machines\|custom machines]] to add the custom mail and items.

	====Achievements====		====Achievements====
	The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).		The ''A Complete Collection'' [[Achievements\|achievement]] is automatically adjusted to require any custom donations added too. This is based on the number of donated items though, so removing custom donations later may incorrectly mark the museum complete (since you may have donated enough items to meet the total required).