Modding:Fish data - Revision history

imported>BarleyZP: /* Aquarium fish */

2025-06-16T03:09:43Z

Aquarium fish

← Older revision		Revision as of 03:09, 16 June 2025
Line 140:		Line 140:

	This consists of a string → string lookup, where...		This consists of a string → string lookup, where...
	* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the aquarium fish, which must match the non-qualified item ID of the item.		* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the aquarium fish, which must match the non-qualified item ID of the item being deposited into the tank.
	* The value is a slash-deliminated string with the fields listed below:		* The value is a slash-deliminated string with the fields listed below:

imported>BarleyZP: /* Aquarium fish */ Update incorrect information about the unique string ID

2025-06-16T03:09:25Z

Aquarium fish: Update incorrect information about the unique string ID

← Older revision		Revision as of 03:09, 16 June 2025
Line 140:		Line 140:

	This consists of a string → string lookup, where...		This consists of a string → string lookup, where...
	* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the aquarium fish, ~~matching~~ the ~~corresponding~~ ID ~~for~~ the ~~fish in the <samp>Data/Fish<samp> asset~~.		* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the aquarium fish, which must match the non-qualified item ID of the item.
	* The value is a slash-deliminated string with the fields listed below:		* The value is a slash-deliminated string with the fields listed below:

imported>BarleyZP: /* Fish */ Fix typo in reference

2025-06-15T01:39:53Z

Fish: Fix typo in reference

← Older revision		Revision as of 01:39, 15 June 2025
Line 113:		Line 113:
	\| {{t\|max depth}}		\| {{t\|max depth}}
	\| <code>4</code>		\| <code>4</code>
	\| The minimum number of tiles from land that the player must cast their rod such that the chance for catching this fish is not decreased. If the player casts closer to land than this minimum, they will accrue a penalty of <samp>(depth multiplier * chance)</samp> percentage points for each tile below this minimum.<ref name="checkreqs">See <samp>GameLocation::~~CheckGenericFishRequirement~~</samp> in the game code</ref>		\| The minimum number of tiles from land that the player must cast their rod such that the chance for catching this fish is not decreased. If the player casts closer to land than this minimum, they will accrue a penalty of <samp>(depth multiplier * chance)</samp> percentage points for each tile below this minimum.<ref name="checkreqs">See <samp>GameLocation::CheckGenericFishRequirements</samp> in the game code</ref>
	\|-		\|-
	\| 10		\| 10

imported>BarleyZP: Add information about fish spawning to remove stub notice

2025-06-15T01:39:26Z

Add information about fish spawning to remove stub notice

← Older revision		Revision as of 01:39, 15 June 2025
Line 1:		Line 1:
	← [[Modding:Index]]		← [[Modding:Index]]
	~~{{Stub\|Page references nonexistent "spawn rate calculations" section that was removed due to being outdated.}}~~
	This page explains how the game stores and parses [[fish]] data. This is an advanced guide for mod developers.		This page explains how the game stores and parses [[fish]] data. This is an advanced guide for mod developers.

Line 93:		Line 93:
	\| [{{t\|min time}} {{t\|max time}}]+		\| [{{t\|min time}} {{t\|max time}}]+
	\| <code>1200 1600</code>		\| <code>1200 1600</code>
	\| The time of day when ~~they~~ spawn. The min time is inclusive, max time is exclusive. May specify multiple ranges.		\| The time of day when the fish can spawn. The min time is inclusive, max time is exclusive. May specify multiple ranges.
	\|-		\|-
	\| 6		\| 6
Line 103:		Line 103:
	\| {{t\|weather}}		\| {{t\|weather}}
	\| <code>sunny</code>		\| <code>sunny</code>
	\| The weather when ~~they~~ spawn; one of <code>sunny</code>, <code>rainy</code>, or <code>both</code>.		\| The weather when the fish can spawn; one of <code>sunny</code>, <code>rainy</code>, or <code>both</code>.
	\|-		\|-
	\| 8		\| 8
Line 113:		Line 113:
	\| {{t\|max depth}}		\| {{t\|max depth}}
	\| <code>4</code>		\| <code>4</code>
	\| The minimum ~~water depth to~~ cast ~~to for maximizing~~ the chance of catching a ~~type~~ of ~~fish; used in the spawn rate calculation~~ (~~see~~ below).		\| The minimum number of tiles from land that the player must cast their rod such that the chance for catching this fish is not decreased. If the player casts closer to land than this minimum, they will accrue a penalty of <samp>(depth multiplier * chance)</samp> percentage points for each tile below this minimum.<ref name="checkreqs">See <samp>GameLocation::CheckGenericFishRequirement</samp> in the game code</ref>
	\|-		\|-
	\| 10		\| 10
	\| {{t\|~~spawn multiplier~~}}		\| {{t\|chance}}
	\| <code>.3</code>		\| <code>.3</code>
	\| The ~~spawn multiplier used in~~ the ~~spawn rate calculation (see below)~~.		\| The base chance for catching this fish once it has already been determined as one of the possible fish to catch at a tile. After applying buffs from [[Skills\|fishing level]] and the [[Training Rod]], this value is clamped to <samp>0.9</samp> before applying other buffs such as from the [[Curiosity Lure]] and [[Targeted Bait]].<ref name="checkreqs" />
	\|-		\|-
	\| 11		\| 11
	\| {{t\|depth multiplier}}		\| {{t\|depth multiplier}}
	\| <code>.5</code>		\| <code>.5</code>
	\| ~~The depth~~ multiplier used in the ~~spawn rate calculation (see below)~~.		\| A multiplier used when penalizing the player for not casting their rod at least <samp>max depth</samp> tiles from land.<ref name="checkreqs" />
	\|-		\|-
	\| 12		\| 12
Line 205:		Line 205:
	Fish spawn data is stored in <samp>Data/Locations</samp>. Fish can be added to a location by editing the <samp>Fish</samp> field in the location's data entry. Distinct fishing areas can be defined within the same location (for example, a pond and a river within the same location that have different fish spawn chances) by editing the <samp>FishAreas</samp> field. These fishing areas can then be referenced by ID in the <samp>Fish</samp> field. See [[Modding:Location data]] for more information.		Fish spawn data is stored in <samp>Data/Locations</samp>. Fish can be added to a location by editing the <samp>Fish</samp> field in the location's data entry. Distinct fishing areas can be defined within the same location (for example, a pond and a river within the same location that have different fish spawn chances) by editing the <samp>FishAreas</samp> field. These fishing areas can then be referenced by ID in the <samp>Fish</samp> field. See [[Modding:Location data]] for more information.

			==References==
			<references />

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

imported>BarleyZP: mark as an article stub due to mention of "spawn rate calculations" that were removed for being out of date

2025-06-13T23:35:47Z

mark as an article stub due to mention of "spawn rate calculations" that were removed for being out of date

← Older revision		Revision as of 23:35, 13 June 2025
Line 1:		Line 1:
	← [[Modding:Index]]		← [[Modding:Index]]
			{{Stub\|Page references nonexistent "spawn rate calculations" section that was removed due to being outdated.}}
	This page explains how the game stores and parses [[fish]] data. This is an advanced guide for mod developers.		This page explains how the game stores and parses [[fish]] data. This is an advanced guide for mod developers.

imported>BarleyZP: /* Aquarium fish */ Add additional information about the possible types of aquarium fish

2025-06-13T04:38:27Z

Aquarium fish: Add additional information about the possible types of aquarium fish

← Older revision		Revision as of 04:38, 13 June 2025
Line 162:		Line 162:
	\|-		\|-
	\| <samp>eel</samp>		\| <samp>eel</samp>
	\|		\| These fish have a clamped minimum velocity greater than 0, regardless of their behavior in <samp>Data/Fish</samp>.
	\|-		\|-
	\| <samp>cephalopod</samp></samp>		\| <samp>cephalopod</samp></samp>
	\|		\| These fish have no minimum velocity. They favor moving downward in the tank rather than upward.
	\|-		\|-
	\| <samp>crawl</samp>		\| <samp>crawl</samp>
	\|		\| These fish always stay at the bottom of the tank. They move horizontally along the tank bottom. These fish have no minimum velocity.
	\|-		\|-
	\| <samp>ground</samp>		\| <samp>ground</samp>
	\|		\| These fish always stay near the bottom of the tank. They are closer to the glass than all other fish types. They move horizontally and vertically, but favor moving downward towards the tank bottom. These fish have no minimum velocity.
	\|-		\|-
	\| <samp>fish</samp>		\| <samp>fish</samp>
Line 177:		Line 177:
	\|-		\|-
	\| <samp>front_crawl</samp>		\| <samp>front_crawl</samp>
	\| Used for crawling fish whose sprites extend past the floor. They are ~~always closest~~ to the glass ~~and sort above~~ other fish to ~~avoid sorting issues~~.		\| Used for crawling fish whose sprites extend past the floor. They are closer to the glass than all other fish (besides <samp>ground</samp> fish). Otherwise, it has identical behavior to <samp>crawl</samp>.
	\|-		\|-
	\| <samp>static</samp>		\| <samp>static</samp>
	\|		\| These fish always stay at the bottom of the tank. They do not move within the tank.
	\|-		\|-
	\| <samp>float</samp>		\| <samp>float</samp>
Line 198:		Line 198:
	\| 7		\| 7
	\| hat position		\| hat position
	\| The pixel position of the hat on the sprite, specified as an object with <samp>X</samp> and <samp>Y</samp> values. Custom ~~[[Modding:Fish data\|~~fish in aquariums]] can wear [[hats]], just like vanilla [[Sea Urchin\|sea urchins]].		\| The pixel position of the hat on the sprite, specified as an object with <samp>X</samp> and <samp>Y</samp> values. Custom fish in aquariums can wear [[hats]], just like vanilla [[Sea Urchin\|sea urchins]].
	\|}		\|}

imported>BarleyZP: /* Aquarium fish */ Add "static" and "float" potential fish types

2025-06-13T04:20:01Z

Aquarium fish: Add "static" and "float" potential fish types

← Older revision		Revision as of 04:20, 13 June 2025
Line 178:		Line 178:
	\| <samp>front_crawl</samp>		\| <samp>front_crawl</samp>
	\| Used for crawling fish whose sprites extend past the floor. They are always closest to the glass and sort above other fish to avoid sorting issues.		\| Used for crawling fish whose sprites extend past the floor. They are always closest to the glass and sort above other fish to avoid sorting issues.
			\|-
			\| <samp>static</samp>
			\|
			\|-
			\| <samp>float</samp>
			\|
	\|}		\|}
	\|-		\|-

imported>BarleyZP: /* Data format */ Add information about the unique string ID keys for both Data/Fish and Data/AquariumFish

2025-06-13T04:15:15Z

Data format: Add information about the unique string ID keys for both Data/Fish and Data/AquariumFish

← Older revision		Revision as of 04:15, 13 June 2025
Line 6:		Line 6:

	===Fish===		===Fish===
	~~The~~ fish data ~~and spawn criteria is stored as fields in~~ <~~code~~>Data\Fish~~.xnb~~</~~code~~>~~. This consists of two different formats: one for [[Crab pot\|crab pot]] fish and one for fish that can be caught with the [[Tools#Fishing Poles\|fishing rod]]~~.		You can edit fish data by editing the <samp>Data/Fish</samp> data asset.

	If the ~~second~~ field is <code>trap</code>, the fish can only be caught using a [[Crab Pot\|crab pot]] and it uses this format:		This consists of a string → string lookup, where...
			* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the fish.
			* The value is a slash-deliminated string with the fields listed below:

			The value consists of two different formats: one for [[Crab pot\|crab pot]] fish and one for fish that can be caught with the [[Tools#Fishing Poles\|fishing rod]].

			If the value of the field at index 1 is <code>trap</code>, the fish can only be caught using a [[Crab Pot\|crab pot]], and it uses this format:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 131:		Line 137:

	===Aquarium fish===		===Aquarium fish===
	Fish in [[Fish Tank\|fish tank]]s can be edited via the <samp>Data/AquariumFish</samp> asset:		Fish in [[Fish Tank\|fish tank]]s can be edited via the <samp>Data/AquariumFish</samp> asset.

			This consists of a string → string lookup, where...
			* The key is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the aquarium fish, matching the corresponding ID for the fish in the <samp>Data/Fish<samp> asset.
			* The value is a slash-deliminated string with the fields listed below:

	{\| class="wikitable"		{\| class="wikitable"

imported>BarleyZP: Restructure page and remove outdated information. Add up-to-date information about spawning fish (most of which is specified in Modding:Location data).

2025-06-13T04:07:47Z

Restructure page and remove outdated information. Add up-to-date information about spawning fish (most of which is specified in Modding:Location data).

@@ Line 1: / Line 1: @@
 ← [[Modding:Index]]
-This page explains how the game stores and parses fish data, including spawning mechanics. This is an advanced guide for mod developers.
+This page explains how the game stores and parses [[fish]] data. This is an advanced guide for mod developers.
-==Parsing fish spawn conditions==
+==Data format==
-===Spawn locations===
+===Fish===
-Each fish is assigned to an area within the location, and will only spawn if the player is within that area. The tile coordinates for each area is defined by the <samp>FishAreas</samp> field in the [[Modding:Location data#Contents|Location data]], which can be accessed in C# mods via <code>GameLocation::GetData</code>. The following areas are defined:
+The fish data and spawn criteria is stored as fields in <code>Data\Fish.xnb</code>. This consists of two different formats: one for [[Crab pot|crab pot]] fish and one for fish that can be caught with the [[Tools#Fishing Poles|fishing rod]].
 If the second field is <code>trap</code>, the fish can only be caught using a [[Crab Pot|crab pot]] and it uses this format:
@@ Line 181: / Line 130: @@
 |}
-===Spawn rate===
+===Aquarium fish===
 Fish in [[Fish Tank|fish tank]]s can be edited via the <samp>Data/AquariumFish</samp> asset:
@@ Line 245: / Line 184: @@
 | The pixel position of the hat on the sprite, specified as an object with <samp>X</samp> and <samp>Y</samp> values. Custom [[Modding:Fish data|fish in aquariums]] can wear [[hats]], just like vanilla [[Sea Urchin|sea urchins]].
 |}
 [[Category:Modding]]

imported>Margotbean: rm underscores

2025-05-15T08:26:48Z

rm underscores

← Older revision		Revision as of 08:26, 15 May 2025
Line 7:		Line 7:

	===Spawn locations===		===Spawn locations===
	Each fish is assigned to an area within the location, and will only spawn if the player is within that area. The tile coordinates for each area is defined by the <samp>FishAreas</samp> field in the [[Modding:~~Location_data~~#Contents\|Location data]], which can be accessed in C# mods via <code>GameLocation::GetData</code>. The following areas are defined:		Each fish is assigned to an area within the location, and will only spawn if the player is within that area. The tile coordinates for each area is defined by the <samp>FishAreas</samp> field in the [[Modding:Location data#Contents\|Location data]], which can be accessed in C# mods via <code>GameLocation::GetData</code>. The following areas are defined:
	* [[Cindersap Forest]]:		* [[Cindersap Forest]]:
	** [[Cindersap Forest#The Pond\|pond]] (area #1 for tiles <code>(0, 0)</code> through <code>(52, 42)</code> inclusively);		** [[Cindersap Forest#The Pond\|pond]] (area #1 for tiles <code>(0, 0)</code> through <code>(52, 42)</code> inclusively);