Jump to content

Modding:Objects: Difference between revisions

From Stardew Valley Wiki
← Older edit
imported>Pathoschild
→Overview: simplify table (most of the info is now in the item sections)
imported>Zeltron0012
m removed a duplicate mention of CombatLevel in custom attributes
 
(166 intermediate revisions by 23 users not shown)
Line 1: Line 1:
← [[Modding:Index|Index]]
← [[Modding:Items|Items]]


This page explains how the game stores and parses item data. This is an advanced guide for mod developers.
This page explains how the game stores and parses object-type item data. For items in general, see [[Modding:Items]].


==Introduction==
==Overview==
===Overview===
Objects are the default type for items in inventories or in the world. Depending on their data, they can be placed, picked up, eaten, sold to shops, etc.
Items are divided into several types:


They have [[Modding:Items#Item types|item type]] <code>(O)</code> (or <code>ItemRegistry.type_object</code> in C# code), their data in <samp>Data/Objects</samp>, their icon sprites in <samp>Maps/springobjects</samp> or <samp>TileSheets/Objects_2</samp> by default, and their code in <samp>StardewValley.Object</samp>. See [[/Object sprites|a table of sprites and their corresponding indexes]].
==Data format==
The object data in <samp>Data/Objects</samp> consists of a string → model lookup, where...
* The key is the unqualified [[Modding:Common data field types#Item ID|item ID]].
* The value is a model with the fields listed below.
===Basic info===
{| class="wikitable"
{| class="wikitable"
|-
|-
! type
! field
! summary
! purpose
|-
|-
| [[#Objects|objects]]
| <samp>Name</samp>
| The default type for items in inventories or placed in the world.
| The internal item name.
|-
|-
| [[#Big craftables|big craftables]]
| <samp>DisplayName</samp><br /><samp>Description</samp>
| Craftable items which can be placed in the world and are two tiles tall.
| A [[Modding:Tokenizable strings|tokenizable string]] for the item's in-game display name and description.
|-
|-
| [[#Boots|boots]]
| <samp>Type</samp>
| Items that can be equipped in the player's [[footwear]] slot.
| The item's general type, like Arch (artifact) or Minerals. The vanilla types are: <samp>Basic</samp>, <samp>Arch</samp> (artifact), <samp>Litter</samp> (e.g. debris), <samp>Minerals</samp>, <samp>Quest</samp>, <samp>Crafting</samp>, <samp>Fish</samp>, <samp>Cooking</samp>, <samp>Seeds</samp>, <samp>Ring</samp>, <samp>interactive</samp>, and some placeholder values like <samp>asdf</samp>.
|-
| [[#Clothing|clothing]]
| Cosmetic items that can be equipped in the player's [[Tailoring|pants and shirt]] slots.
|-
| [[#Furniture|furniture]]
| Decorative items which can be placed in the world, including chairs which the player can sit on.
|-
| [[#Hats|hats]]
| Items that can be equipped in the player's [[hats|hat]] slot.
|-
| [[#Tools|tools]]
| Items that can be swung or used by the player to perform some effect.
|-
| [[#Weapons|weapons]]
| Tools that can be used by the player to damage monsters.
|}
 
For each item type, the game has two files in its <samp>Content</samp> folder (which can be [[Modding:Editing XNB files#unpacking|unpacked for editing]]):
* a ''data asset'' for the text data for its items (names, descriptions, prices, etc);
* and a ''spritesheet'' for the in-game item icons.
 
Each item has a <samp>ParentSheetIndex</samp> field which is its position in the item type's spritesheet, starting at 0 in the top-left and incrementing by one as you move across and then down. For example, hat #0 is the first sprite in <samp>Characters/Farmer/hats</samp>. The <samp>ParentSheetIndex</samp> is also used to identify the item itself; since spritesheet indexes aren't unique (''e.g.'' there's both a hat #10 and object #10), code needs to check the type too like <code>item is Weapon weapon && weapon.ParentSheetIndex == 4</code>.


See the sections below for details on each item type.
'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot|artifact spot]]s becoming broken and not giving any items.


===Get a list of items===
'''Note:''' The "Type" affects whether an item shows up in the collections menu. For example, items with <samp>Type: Cooking</samp> will show up as silhouettes in the cooked items collection menu, items with <samp>Type: Minerals</samp> will show up as silhouettes in the mineral collection menu, etc. However, the [[Modding:Items#Categories|Category]] of the item must also be the correct number or the item will not count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must also be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.  
With [[Modding:Player Guide/Getting Started|SMAPI installed]], you can [[Modding:Console commands#Console commands|run the <samp>list_items</samp> console command]] in-game to view/search items and their IDs.
 
===Define a custom item===
Every item must be assigned a unique <samp>ParentSheetIndex</samp> within its type, and that index must fit within the item type's spritesheet.
 
Adding custom items to the data assets and spritesheets directly is '''not recommended''', since it's very easy to conflict with other mods or cause game errors. Instead you should create a content pack for {{nexus mod|1720|Json Assets}}, which coordinates dynamic item ID assignment so multiple custom item mods can work together.
 
==Common data==
===Categories===
Each item also has a category (represented by a negative integer). In code, you can get an item's category value from <samp>item.Category</samp>, and its translated name from <samp>item.getCategoryName()</samp>. Here are the valid categories:
 
{| class="wikitable sortable"
|-
! value
! internal constant
! English translation
|-
| -2
| <samp>Object.GemCategory</samp>
| Mineral
|-
| -4
| <samp>Object.FishCategory</samp>
| Fish
|-
| -5
| <samp>Object.EggCategory</samp>
| Animal Product
|-
| -6
| <samp>Object.MilkCategory</samp>
| Animal Product
|-
| -7
| <samp>Object.CookingCategory</samp>
| Cooking
|-
| -8
| <samp>Object.CraftingCategory</samp>
| Crafting
|-
| -9
| <samp>Object.BigCraftableCategory</samp>
|
|-
| -12
| <samp>Object.mineralsCategory</samp>
| Mineral
|-
| -14
| <samp>Object.meatCategory</samp>
| Animal Product
|-
| -15
| <samp>Object.metalResources</samp>
| Resource
|-
| -16
| <samp>Object.buildingResources</samp>
| Resource
|-
| -17
| <samp>Object.sellAtPierres</samp>
|
|-
|-
| -18
| <samp>Category</samp>
| <samp>Object.sellAtPierresAndMarnies</samp>
| The [[Modding:Items#Categories|item category]].
| Animal Product
|-
|-
| -19
| <samp>Price</samp>
| <samp>Object.fertilizerCategory</samp>
| ''(Optional)'' The price when sold by the player. This is not the price when bought from a shop. Default 0.
| Fertilizer
|-
| -20
| <samp>Object.junkCategory</samp>
| Trash
|-
| -21
| <samp>Object.baitCategory</samp>
| Bait
|-
| -22
| <samp>Object.tackleCategory</samp>
| Fishing Tackle
|-
| -23
| <samp>sellAtFishShopCategory</samp>
|
|-
| -24
| <samp>Object.furnitureCategory</samp>
| Decor
|-
| -25
| <samp>Object.ingredientsCategory</samp>
| Cooking
|-
| -26
| <samp>Object.artisanGoodsCategory</samp>
| Artisan Goods
|-
| -27
| <samp>Object.syrupCategory</samp>
| Artisan Goods
|-
| -28
| <samp>Object.monsterLootCategory</samp>
| Monster Loot
|-
| -29
| <samp>Object.equipmentCategory</samp>
|
|-
| -74
| <samp>Object.SeedsCategory</samp>
| Seed
|-
| -75
| <samp>Object.VegetableCategory</samp>
| Vegetable
|-
| -79
| <samp>Object.FruitsCategory</samp>
| Fruit
|-
| -80
| <samp>Object.flowersCategory</samp>
| Flower
|-
| -81
| <samp>Object.GreensCategory</samp>
| Forage
|-
| -95
| <samp>Object.hatCategory</samp>
|
|-
| -96
| <samp>Object.ringCategory</samp>
|
|-
| -98
| <samp>Object.weaponCategory</samp>
|
|-
| -99
| <samp>Object.toolCategory</samp>
|
|}
|}


{{collapse|Console commands|content=
===Appearance===
With the {{nexus mod|3101|Console Code}} mod installed, you can run this command in the SMAPI console to see a list of objects by category:
 
<pre>cs return string.Join(`\n`, Game1.objectInformation.Keys.Select(key => new StardewValley.Object(key, 1)).GroupBy(item => item.Category, item => item.Name).OrderByDescending(p => p.Key).Select(p => $`{p.Key}: {string.Join(`, `, p.OrderBy(name => name))}`));</pre>
}}
 
===Context tags===
A ''context tag'' is an arbitrary label attached to items, which can produce various effects in-game.
 
Every item has built-in tags for metadata like the item name, quality, and category. Further context tags are defined in <samp>Data/ObjectContextTags</samp>, which consists of a string→string dictionary (where the key is the item's internal name, and the value is a comma-delimited list of tags to add):
<syntaxhighlight lang="json">
  "Chanterelle": "color_brown, forage_item, forage_item_cave, forage_item_secret, season_fall",
</syntaxhighlight>
 
Context tags have a variety of effects in-game:
{| class="wikitable"
{| class="wikitable"
|-
|-
! feature
! field
! effects
! purpose
|-
|-
| [[Fish Pond|fish ponds]]
| <samp>Texture</samp>
| Context tags determine what the fish will produce and other elements. See [[Modding:Fish Pond data#RequiredTags|Fish pond tags]] for more info.
| The asset name for the texture containing the item's sprite. Defaults to <samp>Maps/springobjects</samp>.
|-
|-
| [[Special Orders|special orders]]
| <samp>SpriteIndex</samp>
| Contexts tags are used in special orders to determine what are the valid items for the quest objective(s).
| The sprite's index within the <samp>Texture</samp>, where 0 is the top-left sprite.
|-
| <samp>ColorOverlayFromNextIndex</samp>
| ''(Optional)'' When drawn as a colored object, whether to apply the color to the next sprite in the spritesheet and draw that over the main sprite. If false, the color is applied to the main sprite instead. Default false.
|}
|}


The <samp>debug listtags</samp> [[Modding:Console commands|console command]] lists all the tags of the item being held.
===Edibility===
 
==Objects==
Objects are the default type for items in inventories or placed in the world.
 
They have their data in <samp>Data/ObjectInformation</samp>, their icon sprites in <samp>Maps/springobjects</samp>, and their code in <samp>StardewValley.Object</samp>. See [[Modding:Items/Object sprites|a table of sprites and their corresponding indexes]].
 
===Data format===
The object data in <samp>Data/ObjectInformation</samp> consists of an integer→string dictionary with entries like this:
<syntaxhighlight lang="json">
  "18": "Daffodil/30/0/Basic -81/Daffodil/A traditional spring flower that makes a nice gift."
</syntaxhighlight>
 
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> and the value is a slash-delimited string with the fields listed below. Fields 0–5 are used by rings and most other objects; fields 6–11 are only used for food buffs. The objects with keys 516–534 (<samp>Ring.ringLowerIndexRange</samp> through <samp>Ring.ringUpperIndexRange</samp>) and 801 (wedding ring) are hardcoded as rings.
 
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! purpose
|-
|-
!style="text-align: left;" colspan="3"| all objects
| <samp>Edibility</samp>
| ''(Optional)'' A numeric value that determines how much energy (edibility × 2.5) and health (edibility × 1.125) is restored when this item is eaten. An item with an edibility of -300 can't be eaten, values from -299 to -1 reduce health and energy, and zero can be eaten but doesn't change health/energy. Default -300.
|-
|-
| 0
| <samp>IsDrink</samp>
| name
| ''(Optional)'' Whether to drink the item instead of eating it. Default false.
| The internal item name (and display name in English).
|-
|-
| 1
| <samp>Buffs</samp>
| price
| ''(Optional)'' The buffs to apply to the player when this item is eaten, if any. Default none.
| The gold price of the item when sold by the player.
|-
| 2
| edibility
| A numeric value that determines how much health (edibility × 2.5) and energy (edibility × 1.125) is restored. An item with an edibility of -300 can't be eaten.


This is ignored for rings.
This consists of a list of models with these fields:
{| class="wikitable"
|-
|-
| 3
! field
| type and category
! purpose
| &#32;
* For a ring: the value <samp>Ring</samp>. Rings have a hardcoded category of -96 (<samp>Object.ringCategory</samp>).
* For other objects: the item's type (string) and category (negative integer), separated by a space like <samp>Fish -4</samp>.
|-
| 4
| display name
| The translated item name.
|-
| 5
| description
| The translated item description.
|-
!style="text-align: left;" colspan="3"| food & drink only
|-
| 6
| miscellaneous
| &#32;
* For a food or drink item, set this to <samp>food</samp> or <samp>drink</samp> respectively. This enables the remaining fields, and changes which animation/sound is played when the player consumes the item. Any other value is ignored.
* For a geode item ([[Geode|535]], [[Frozen Geode|536]], [[Magma Geode|537]], or [[Omni Geode|749]]) is broken, a space-delimited list of object IDs. There's a roughly 50% chance that the geode item will drop one of these items (the other drops are hardcoded).
|-
| 7
| buffs
| The bonuses to apply to the player's attribute when the item is consumed. This consists of a space-delimited list of these numbers:
{|class="wikitable"
|-
! index
! buff
|-
| 0
| [[Skills#Farming|farming]]
|-
| 1
| [[Skills#Fishing|fishing]]
|-
| 2
| [[Skills#Mining|mining]]
|-
| 3
| ''unused''
|-
| 4
| [[Luck|luck]]
|-
| 5
| [[Skills#Foraging|foraging]]
|-
|-
| 6
| <samp>Id</samp>
| ''unused''
| The [[Modding:Common data field types#Unique string ID|unique string ID]] for this entry within the list.
|-
|-
| 7
| <samp>Duration</samp>
| max [[energy]]
| ''(Optional if <samp>BuffId</samp> is set)'' The buff duration measured in in-game minutes. This can be set to <samp>-2</samp> for a buff that should last for the rest of the day.
|-
|-
| 8
| <samp>BuffId</samp>
| [[magnetism]]
| ''(Optional)'' The unique ID of a buff from <samp>Data/Buffs</samp> to apply, or <samp>null</samp> to ignore <samp>Data/Buffs</samp> and set the ID to <samp>food</samp> or <samp>drink</samp> depending on the item's <samp>IsDrink</samp> field.
|-
| 9
| [[speed]]
|-
| 10
| [[defense]]
|-
| 11
| [[attack]]
|}
|-
| 8
| buff duration
| How long the buffs provided by the previous field last. This is converted into in-game minutes using the formula <samp>(''duration'' × 0.7) / 60</samp>. The buff duration number shown in-game will always be one second less than the calculated value.
|}
 
===Notes===
* Items that have a number in the "Crafting" field show buggy information in-game (''e.g.,'' Bean Hotpot prior to version 1.4). Items that have a number in the "Attack" field display the Attack icon and a number, but no description. It's unclear how these buffs work (if at all).
* Named [[buffs]] (like [[Oil of Garlic]], [[Life Elixir]], or [[Tipsy]]) are implemented in code and can't be set in the food buff fields.
* The spritesheet and data have items that can't normally be found in the player inventory (like twigs and lumber), and some sprites have no corresponding item data. There are also multiple entries for ''weeds'' and ''stone'' corresponding to different sprites, but the player can only normally obtain one ''stone'' item (index 390) and no ''weeds'' items.
 
==Big craftables==
Big craftables are objects which can be placed in the world and are two tiles tall (instead of one like objects).
 
They have their data in <samp>Data/BigCraftableInformation</samp>, their in-game sprites in <samp>TileSheets/Craftables</samp>, and their code in <samp>StardewValley.Object</samp> (with the <code>bigCraftable.Value = true</code> flag).
 
===Data format===
The big craftables data in <samp>Data/BigCraftableInformation</samp> consists of an integer→string dictionary with entries like this:
 
<syntaxhighlight lang="json">
  "19": "Oil Maker/50/-300/Crafting -9/Makes gourmet truffle oil./true/true/0/Oil Maker"
</syntaxhighlight>
 
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> and the value is a slash-delimited string with these fields:


If a buff from <samp>Data/Buffs</samp> is applied and you also specify other fields, here's how the buff data is combined:
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! result
|-
|-
| 0
| <samp>Duration</samp><br /><samp>IconTexture</samp><br /><samp>IconSpriteIndex</samp><br /><samp>GlowColor</samp>
| name
| If specified, the value in <samp>Data/Objects</samp> is used instead of the one in <samp>Data/Buffs</samp>. If omitted, defaults to the value from <samp>Data/Buffs</samp>.
| The internal item name (and display name in English).
|-
|-
| 1
| <samp>CustomAttributes</samp>
| price
| The values from both entries are combined (e.g. +1 speed in <samp>Data/Objects</samp> and +1 speed in <samp>Data/Buffs</samp> results in +2 speed).
| The gold price when sold by the player.
|-
|-
| 2
| <samp>IsDebuff</samp>
| edibility
| The value in <samp>Data/Objects</samp> is used.
| See edibility for [[#Objects|object data]]. Always set to <samp>-300</samp> (inedible) for vanilla items.
|}
|-
|-
| 3
| <samp>IsDebuff</samp>
| type and category
| ''(Optional)'' Whether this buff counts as a debuff, so its duration should be halved when wearing a Sturdy Ring. Default false.
| See type and category for [[#Objects|object data]]. Always set to <samp>Crafting -9</samp> for vanilla items.
|-
|-
| 4
| <samp>IconTexture</samp>
| description
| ''(Optional)'' The asset name for the icon texture to load. This must contain one or more 16x16 icons in a grid of any size. If omitted, the game will draw a default icon based on the <samp>BuffId</samp> and <samp>CustomAttributes</samp> fields.
| The translated item description shown in-game.
|-
|-
| 5
| <samp>IconSpriteIndex</samp>
| outdoors
| ''(Optional)'' The buff's icon index within the <samp>IconTexture</samp>, where 0 is the top-left icon. Default 0.
| Whether the item can be placed outdoors (<samp>true</samp> or <samp>false</samp>).
|-
|-
| 6
| <samp>GlowColor</samp>
| indoors
| ''(Optional)'' The glow color to apply to the player. See [[Modding:Common data field types#Color|color format]]. Default none.
| Whether the item can be placed indoors (<samp>true</samp> or <samp>false</samp>).
|-
|-
| 7
| <samp>CustomAttributes</samp>
| fragility
| The custom buff attributes to apply, if any.
| How the item is removed by tools. Possible values:
 
This consists of a model with any combination of these fields:
{| class="wikitable"
{| class="wikitable"
|-
|-
! fragility
! field
! effect
! purpose
|-
|-
| <samp>0</samp>
| <samp>CombatLevel</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel</samp>
| Pick up with any tool.
| ''(Optional)'' An amount applied to the matching [[Skills|skill level]] while the buff is active. This can be negative for a debuff. Default 0.
|-
|-
| <samp>1</samp>
| <samp>Attack</samp><br /><samp>AttackMultiplier</samp><br /><samp>CriticalChanceMultiplier</samp><br /><samp>CriticalPowerMultiplier</samp><br /><samp>Defense</samp><br /><samp>Immunity</samp><br /><samp>KnockbackMultiplier</samp><br /><samp>MagneticRadius</samp><br /><samp>MaxStamina</samp><br /><samp>Speed</samp><br /><samp>WeaponPrecisionMultiplier</samp><br /><samp>WeaponSpeedMultiplier</samp>
| Destroyed if hit with an [[axe]], [[hoe]], or [[pickaxe]]. Any other tool will pick it up.
| ''(Optional)'' An amount applied to the player's [[attack]], [[Crit. Chance|critical chance]] and  [[Crit. Power|critical power]], [[defense]], [[immunity]], knockback (i.e. [[weight]]), [[Magnetism|magnetic radius]], maximum [[Energy|stamina]], [[speed]], or weapon precision/[[speed|speed]] while the buff is active. This can be negative for a debuff. Default 0.
|}
|-
|-
| <samp>2</samp>
| <samp>CustomFields</samp>
| Indestructible. The item can't be removed once placed.
| ''(Optional)'' The [[Modding:Common data field types#Custom fields|custom fields]] for this entry.  
|}
|}
|-
| 8
| is lamp
| Whether the item is a lamp and produces light when it's dark. This can be <samp>true</samp> (mark as lamp) or any other value (ignored).
|-
| 9
| display name
| The translated display name (in non-English assets only).
|}
|}


===Notes===
===Geodes & artifact spots===
* Many of the items in the data asset aren't implemented in-game. They may be completely absent from the game, or they may be unused as craftables and instead appear in [[#Objects|object data]] or [[#Furniture|furniture data]].
 
==Boots==
Boots are items that can be equipped in the player's [[footwear]] slot.
 
They have their data in <samp>Data/Boots</samp>, their in-game sprites in <samp>Maps/springobjects</samp> (item sprite) and <samp>Characters/Farmer/shoeColors</samp> (shoe color), and their code in <samp>StardewValley.Objects.Boots</samp>.
 
===Data format===
<span style="color: red;">'''TODO'''</span>
 
==Clothing==
Clothing consists of cosmetic items that can be equipped in the player's [[Tailoring|pants and shirt]] slots.
 
They have their data in <samp>Data/ClothingInformation</samp>, their in-game sprites in <samp>Characters/Farmer/pants</samp> & <samp>Characters/Farmer/shirts</samp>, and their code in <samp>StardewValley.Objects.Clothing</samp>.
 
===Data format===
The clothing data in <samp>Data/ClothingInformation</samp> consists of an integer→string dictionary with entries like this:
 
<syntaxhighlight lang="json">
  "1282": "Tomato Shirt/Tomato Shirt/A shirt that answers the big question: 'Tomatoes are'... (but the rest is smudged)./282/-1/50/255 0 0/false/Shirt/Sleeveless"
</syntaxhighlight>
 
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> (offset by 1000 for shirts) and the value is a slash-delimited string with these fields:
 
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! purpose
|-
|-
| 0
| <samp>GeodeDrops</samp><br /><samp><samp>GeodeDropsDefaultItems</samp>
| name
| ''(Optional)'' The items that can be dropped when breaking open this item as a [[Minerals#Geodes|geode]]. Specifying either or both fields automatically enables geode behavior for this item.
| The internal item name (and display name in English).
 
You can specify one or both fields:
<ul>
<li><samp>GeodeDrops</samp> can be set to the specific items to drop. Default none. This consists of a list of models with these fields:
{| class="wikitable"
|-
|-
| 1
! field
| display name
! purpose
| The translated item name shown in-game.
|-
|-
| 2
| description
| The translated item description shown in-game.
|-
|-
| 3
| ''common fields''
| male index
| See [[Modding:Item queries#Item spawn fields|item spawn fields]] for the generic item fields supported by geode drops.
| The sprite index in the clothing spritesheet for male characters.
 
|-
If set to an [[Modding:Item queries|item query]] which returns multiple items, one of them will be selected at random.
| 4
| female index
| The sprite index in the clothing spritesheet for female characters, or <samp>-1</samp> to use the male index.
|-
| 5
| price
| The price when purchased from shops.
|-
| 6
| default color
| The default color, specified in space-delimited RGB with each channel being an integer from 0 (no color) to 255 (full color). For example, <samp>255 0 0</samp> for full red.
|-
|-
| 7
| <samp>Chance</samp>
| dyeable
| ''(Optional)'' The probability that the item will be dropped if the other fields match, as a decimal value between 0 (never) and 1 (always). Default 1.
| Whether the clothing can be [[Dyeing|dyed]] (<samp>true</samp> or <samp>false</samp>).
|-
|-
| 8
| <samp>SetFlagOnPickup</samp>
| Type
| ''(Optional)'' The mail flag to set for the current player when this drop is picked up.
| The clothing type. One of <samp>Pants</samp>, <samp>Shirt</samp>, or <s><samp>Accessory</samp></s> (unimplemented).
|-
|-
| 9
| <samp>Precedence</samp>
| extra data
| ''(Optional)'' The order in which this entry should be checked, where lower values are checked first. This can be a negative value. Geode drops with the same precedence are checked in the order listed. Default 0.
| A comma-delimited list of tags attached to the item (unrelated to [[#Context tags|context tags]]). The values recognized by the game are <samp>Prismatic</samp> (adds a shifting rainbow effect) and <samp>Sleeveless</samp> (disables drawing the sleeve color over the player's arms).
|}


==Furniture==
For consistency, vanilla drops mostly use these values:
Furniture are decorative items which can be placed in the world, including chairs which the player can sit on.
* <samp>-1000</samp>: special overrides like the [[Golden Helmet|golden helmet]];
* <samp>0</samp>: normal items.
|}</li>
<li><samp>GeodeDropsDefaultItems</samp> chooses a predefined list of possible geode drops like [[clay]], [[coal]], [[Copper Ore|copper]], [[Iridium Ore|iridium]], etc. Default false.</li>
</ul>


They have their data in <samp>Data/Furniture</samp>, their in-game sprites in <samp>TileSheets/furniture</samp>, and their code in <samp>StardewValley.Objects.Furniture</samp>.
If both fields are specified, each geode will choose between them with an equal 50% chance. If <samp>GeodeDrops</samp> is specified but no entries match, the geode will use the <samp>GeodeDropsDefaultItems</samp> regardless of whether it's true.
|-
| <samp>ArtifactSpotChances</samp>
| ''(Optional)'' If this is an artifact (i.e. the <samp>Type</samp> field is <samp>Arch</samp>), the chance that it can be found by digging [[Artifact Spot|artifact spots]] in each location.


===Data format===
This consists of a string → model lookup, where:
The furniture data in <samp>Data/Furniture</samp> consists of an integer→string dictionary with entries like this:
* the key is the internal location name;
 
* the value is the probability the item will spawn if checked, as a decimal value between 0 (never) and 1 (always).
<syntaxhighlight lang="json">
|}
  "18": "Country Chair/chair/-1/-1/4/750"
</syntaxhighlight>
 
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> and the value is a slash-delimited string with these fields:


===Context tags & exclusions===
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! purpose
|-
|-
| 0
| <samp>ContextTags</samp>
| name
| ''(Optional)'' The custom [[Modding:Context tags|context tags]] to add for this item (in addition to the tags added automatically based on the other object data). This is formatted as a list; for example:
| The internal item name (and display name in English).
<syntaxhighlight lang="json">
"ContextTags": [ "color_yellow", "fish_ocean", "fish_upright", "season_summer" ]
</syntaxhighlight>
|-
|-
| 1
| <samp>CanBeGivenAsGift</samp>
| type
| ''(Optional)'' Whether this item can be gifted to NPCs. Default true.
| The furniture type. Possible values:
{| class="wikitable sortable"
|-
|-
! type
| <samp>CanBeTrashed</samp>
! meaning
| ''(Optional)'' Whether this item can be trashed from the player's inventory. Also affects whether the item can be shipped but not whether it can be sold to shops. Default true.
|-
|-
| 0
| <samp>ExcludeFromRandomSale</samp>
| chair
| ''(Optional)'' Whether to exclude this item from shops when selecting random items to sell. Default false.
|-
|-
| 1
| <samp>ExcludeFromFishingCollection</samp><br /><samp>ExcludeFromShippingCollection</samp>
| bench
| ''(Optional)'' Whether to exclude this item from the fishing/shipping collection and their respective effect on the [[perfection|perfection score]]. Default false, in which case the normal requirements apply (e.g., artifacts are always excluded from the shipping collection).
|-
| 2
| couch
|-
| 3
| armchair
|-
| 4
| dresser
|-
| 5
| long table
|-
| 6
| painting
|-
| 7
| lamp
|-
| 8
| decor
|-
| 9
| other
|-
| 10
| bookcase
|-
| 11
| table
|-
| 12
| rug
|-
| 13
| window
|-
| 14
| fireplace
|-
| 15
| bed
|-
| 16
| torch
|-
| 17
| sconce
|}
|}
|-
| 2
| tilesheet size
| The furniture sprite size on the tilesheet, measured in tiles. This can be <samp>{{t|width}} {{t|height}}</samp> (e.g. <samp>1 2</samp>), or <samp>-1</samp> to use the default size for the type.
|-
| 3
| bounding box size
| The size of the hitbox when the furniture is placed in-game, measured in tiles. The bounding box will be anchored to the bottom-left corner and extend upwards and rightwards. This can be <samp>{{t|width}} {{t|height}}</samp> (e.g. <samp>1 2</samp>), or <samp>-1</samp> to use the default size for the type.
|-
| 4
| rotations
| The number of rotations possible (1, 2, or 4).
|-
| 5
| price
| The price when purchased from a shop.
|-
| 6
| display name
| The translated furniture name (in non-English data assets only).
|}
==Hats==
Hats are items that can be equipped in the player's [[hats|hat]] slot.
They have their data in <samp>Data/Hats</samp>, their in-game sprites in <samp>Characters/Farmer/hats</samp>, and their code in <samp>StardewValley.Objects.Hat</samp>.
===Data format===
The hat data in <samp>Data/Hats</samp> consists of an integer→string dictionary with entries like this:
<syntaxhighlight lang="json">
  "5": "Official Cap/Looks like it belonged to a postman or policeman. Either way, it's still very soft and smells okay./false/true"
</syntaxhighlight>
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> and the value is a slash-delimited string with these fields:


===Advanced===
{| class="wikitable"
{| class="wikitable"
|-
|-
! index
! field
! field
! effect
! purpose
|-
| 0
| name
| The internal item name (and display name in English).
|-
| 1
| description
| The translated item description shown in-game.
|-
|-
| 2
| <samp>CustomFields</samp>
| show real hair
| ''(Optional)'' The [[Modding:Common data field types#Custom fields|custom fields]] for this entry.  
| Whether to show the player's hairstyle as-is when the hat is worn (<samp>true</samp>), or change the hairstyle to fit the hat (<samp>false</samp>).
|-
| 3
| skip hairstyle offset
| Whether to ignore the current style when positioning the hat (one of <samp>true</samp> or <samp>false</samp>). For example, the [[Eye Patch|eye patch]] sets <samp>true</samp> since its position isn't affected by the hair, but the [[Butterfly Bow|butterfly bow]] sets <samp>false</samp> to adjust its position on top of your hair.
|-
| 4
| display name
| The translated item name shown in-game (for non-English assets only).
|}
|}


Hats have a hard-coded category of -95 (<samp>Hats.cs::Load</samp>)
==Unobtainable items==
The spritesheet and data have items that can't normally be found in the player inventory (like twigs and lumber), and some sprites have no corresponding item data. There are also multiple entries for ''weeds'' and ''stone'' corresponding to different sprites, but the player can only normally obtain one ''stone'' item (index 390) and no ''weeds'' items.


==Tools==
==For C# mods==
[[Tools]] are items that can be swung or used by the player to perform some effect (e.g. dig dirt, chop trees, etc).
Object-type items are represented by the <samp>StardewValley.Object</samp> type.


They have their in-game sprites in <samp>TileSheets/Tools</samp>, and their code in <samp>StardewValley.Tool</samp> and various subclasses like <samp>StardewValley.Tools.Axe</samp>.
This provides many methods to simplify common logic. Some notable examples:


===Data format===
{| class="wikitable"
Tools are currently hardcoded and can't be edited by content packs.
 
==Weapons==
[[Weapons]] are tools that can be used by the player to damage monsters.
 
They have their data in <samp>Data/Weapons</samp>, their in-game sprites in <samp>TileSheets/weapons</samp>, and their code in <samp>StardewValley.Tools.MeleeWeapon</samp> and <samp>StardewValley.Tools.Slingshot</samp>.
 
===Data format===
The weapon data in <samp>Data/Weapons</samp> consists of an integer→string dictionary with entries like this:
 
<syntaxhighlight lang="json">
  "12": "Wooden Blade/Not bad for a piece of carved wood./3/7/1/0/0/0/0/3/-1/0/.02/3"
</syntaxhighlight>
 
For each entry in the data asset, the key is the item's <samp>ParentSheetIndex</samp> and the value is a slash-delimited string with these fields:
 
; Melee weapons
: {| class="wikitable"
|-
|-
! index
! method
! field
! effect
! effect
|-
|-
| 0
| <samp>Object.GetRadiusForScarecrow()</samp>
| name
| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t|radius}}</samp> [[Modding:Context tags|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise. Can be patched to support custom scarecrows.
| The internal weapon name (and display name in English).
|-
|-
| 1
| <samp>Object.IsBar()</samp>
| description
| Whether the item is a [[Copper Bar|copper bar]], [[Iron Bar|iron bar]], [[Gold Bar|gold bar]], [[Iridium Bar|iridium bar]], or [[Radioactive Bar|radioactive bar]].
| The translated item description shown in-game.
|-
|-
| 2<br />3
| <samp>Object.IsBreakableStone()</samp>
| min damage<br />max damage
| Whether the item is a stone debris item which can be broken by a pickaxe.
| The minimum and maximum damage caused when hitting a monster with this weapon.
|-
|-
| 4
| <samp>Object.IsFence()</samp>
| knockback
| Whether the item is a [[Crafting#Fences|fence]].
| How far the target is pushed when hit, as a multiplayer relative to a base weapon like the [[Rusty Sword]] (e.g. <samp>1.5</samp> for 150% of Rusty Sword's weight).
|-
|-
| 5
| <samp>Object.IsFruitTreeSapling()</samp>
| speed
| Whether the item is a [[Fruit Trees|fruit tree]] sapling. This checks the <samp>Data\fruitTrees</samp> keys, so it works with custom fruit trees too.
| How fast the player can swing the weapon. Each point of speed is worth 40ms of swing time relative to 0. This stacks with the [[speed|player's weapon speed]].
|-
|-
| 6
| <samp>Object.IsHeldOverHead()</samp>
| added precision
| Whether the player is shown holding up the item when it's selected in their toolbar. Default true (except for furniture).
| Reduces the chance that a strike will miss.
|-
|-
| 7
| <samp>Object.IsIncubator()</samp>
| added defence
| Whether the item can incubate [[Animals|farm animal]] eggs when placed in a building.
| Reduces damage received by the player.
|-
|-
| 8
| <samp>Object.IsScarecrow()</samp>
| type
| Whether the item is a scarecrow. Default: <samp>true</samp> if the object has the <samp>crow_scare</samp> [[Modding:Context_tags|context tag]]. Otherwise, returns whether the object's internal name contains "arecrow". Can be patched to support custom scarecrows.
| The weapon type. One of <samp>0</samp> (stabbing sword), <samp>1</samp> (dagger), <samp>2</samp> (club or hammer), or <samp>3</samp> (slashing sword).
|-
|-
| 9<br />10
| <samp>Object.IsTapper()</samp>
| base mine level<br />min mine level
| Whether the item is a [[Tapper|tapper]] or [[Heavy Tapper|heavy tapper]].
| The base and minimum mine level, which affect [[#Mine container drops|mine container drops]].
|-
|-
| 11
| <samp>Object.IsTeaSapling()</samp>
| added area of effect
| Whether the item is a [[Tea Sapling|tea sapling]].
| Slightly increases the area of effect.
|-
|-
| 12
| <samp>Object.IsTwig()</samp>
| critical chance
| Whether the item is a twig debris item.
| The chance of a critical hit, as a decimal value between 0 and 1.
|-
|-
| 13
| <samp>Object.IsWeeds()</samp>
| critical damage
| Whether the item is a weed debris item.
| A multiplier applied to the damage for critical hit.
|-
| 14
| display name
| The translated item name (in non-English assets only).
|}
|}
; Slingshots
: {| class="wikitable"
|-
! index
! field
! effect
|-
| 0
| name
| The internal weapon name (and display name in English).
|-
| 1
| description
| The translated item description shown in-game (for non-English assets only).
|-
| 2&ndash;8
| ''unused''
|
|-
| 9<br />10
| base mine level<br />min mine level
| The base and minimum mine level, which affect [[#Mine container drops|mine container drops]].
|-
| 11&ndash;13
| ''unused''
|
|-
| 14
| display name
| The translated item description shown in-game (for non-English assets only).
|}
Weapons have a hardcoded category of -98 (<samp>Object.weaponCategory</samp>).
===Slingshot notes===
* The base [[slingshot]] has <samp>ParentSheetIndex</samp> 32 in the weapon data, which increases by one for each upgrade level (up to 34 in the weapon data, though only 32 and 33 are obtainable without mods).
* Slingshot damage is [[Slingshot#Ammunition|calculated dynamically]] regardless of the weapon data.
===Mine container drops===
When the player breaks a container in [[The Mines|the mines]], there's a chance it will drop a weapon. Here's how the weapon to drop is chosen<ref>See <samp>Utility.getUncommonItemForThisMineLevel</samp> in the game code.</ref>:
<ol>
<li>Match weapons whose minimum mine level ([[#Format|field 10]]) is less than the current mine level.</li>
<li>From that list, match weapons with a probability check based on the gap between the base mine level ([[#Format|field 9]]) and current mine level. The probability is a bell curve centered on the base mine level:
{| class="wikitable"
|-
! level difference
! probability
|-
| 0
| 100%
|-
| 5
| 92%
|-
| 10
| 71%
|-
| 15
| 46%
|-
| 20
| 25%
|-
| 25
| 4%
|}
The difference applies in both directions; for example, two weapons whose base levels are 5 below and 5 above the current level both have a 92% chance. (The probability is calculated with a [[wikipedia:Gaussian function|Gaussian function]] <code>e<sup>-(current mine level - base mine level)<sup>2</sup> / (2 * 12<sup>2</sup>)</sup></code>.)</li>
<li>Find the weapon with the smallest gap between the current and base mine levels, and add it to the list. (If the item was also selected in step 2, it has two chances to drop.)</li>
<li>From the remaining list of weapons, randomly choose one to drop.</li>
</ol>


==See also==
==See also==
* [[Modding:Index]] for related content like [[Modding:Crop data|crops]], [[Modding:Fish data|fish]], [[Modding:Gift taste data|gift tastes]], and [[Modding:Recipe data|recipes]]
* [[Modding:Items]] for item data in general
 
==References==
<references />


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


[[ru:Модификации:Объекты]]
[[ru:Модификации:Объекты]]
[[zh:模组:物体]]

Latest revision as of 10:59, 8 August 2026

← Items

This page explains how the game stores and parses object-type item data. For items in general, see Modding:Items.

Overview

Objects are the default type for items in inventories or in the world. Depending on their data, they can be placed, picked up, eaten, sold to shops, etc.

They have item type (O) (or ItemRegistry.type_object in C# code), their data in Data/Objects, their icon sprites in Maps/springobjects or TileSheets/Objects_2 by default, and their code in StardewValley.Object. See a table of sprites and their corresponding indexes.

Data format

The object data in Data/Objects consists of a string → model lookup, where...

  • The key is the unqualified item ID.
  • The value is a model with the fields listed below.

Basic info

field purpose
Name The internal item name.
DisplayName
Description 		A tokenizable string for the item's in-game display name and description.
Type The item's general type, like Arch (artifact) or Minerals. The vanilla types are: Basic, Arch (artifact), Litter (e.g. debris), Minerals, Quest, Crafting, Fish, Cooking, Seeds, Ring, interactive, and some placeholder values like asdf.

Caution: adding custom items with the Arch type is inadvisable as it often leads to artifact spots becoming broken and not giving any items.

Note: The "Type" affects whether an item shows up in the collections menu. For example, items with Type: Cooking will show up as silhouettes in the cooked items collection menu, items with Type: Minerals will show up as silhouettes in the mineral collection menu, etc. However, the Category of the item must also be the correct number or the item will not count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must also be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.

Category The item category.
Price (Optional) The price when sold by the player. This is not the price when bought from a shop. Default 0.

Appearance

field purpose
Texture The asset name for the texture containing the item's sprite. Defaults to Maps/springobjects.
SpriteIndex The sprite's index within the Texture, where 0 is the top-left sprite.
ColorOverlayFromNextIndex (Optional) When drawn as a colored object, whether to apply the color to the next sprite in the spritesheet and draw that over the main sprite. If false, the color is applied to the main sprite instead. Default false.

Edibility

field purpose
Edibility (Optional) A numeric value that determines how much energy (edibility × 2.5) and health (edibility × 1.125) is restored when this item is eaten. An item with an edibility of -300 can't be eaten, values from -299 to -1 reduce health and energy, and zero can be eaten but doesn't change health/energy. Default -300.
IsDrink (Optional) Whether to drink the item instead of eating it. Default false.
Buffs (Optional) The buffs to apply to the player when this item is eaten, if any. Default none.

This consists of a list of models with these fields:

field purpose
Id The unique string ID for this entry within the list.
Duration (Optional if BuffId is set) The buff duration measured in in-game minutes. This can be set to -2 for a buff that should last for the rest of the day.
BuffId (Optional) The unique ID of a buff from Data/Buffs to apply, or null to ignore Data/Buffs and set the ID to food or drink depending on the item's IsDrink field.

If a buff from Data/Buffs is applied and you also specify other fields, here's how the buff data is combined:

field result
Duration
IconTexture
IconSpriteIndex
GlowColor 		If specified, the value in Data/Objects is used instead of the one in Data/Buffs. If omitted, defaults to the value from Data/Buffs.
CustomAttributes The values from both entries are combined (e.g. +1 speed in Data/Objects and +1 speed in Data/Buffs results in +2 speed).
IsDebuff The value in Data/Objects is used.
IsDebuff (Optional) Whether this buff counts as a debuff, so its duration should be halved when wearing a Sturdy Ring. Default false.
IconTexture (Optional) The asset name for the icon texture to load. This must contain one or more 16x16 icons in a grid of any size. If omitted, the game will draw a default icon based on the BuffId and CustomAttributes fields.
IconSpriteIndex (Optional) The buff's icon index within the IconTexture, where 0 is the top-left icon. Default 0.
GlowColor (Optional) The glow color to apply to the player. See color format. Default none.
CustomAttributes The custom buff attributes to apply, if any.

This consists of a model with any combination of these fields:

field purpose
CombatLevel
FarmingLevel
FishingLevel
ForagingLevel
LuckLevel
MiningLevel 		(Optional) An amount applied to the matching skill level while the buff is active. This can be negative for a debuff. Default 0.
Attack
AttackMultiplier
CriticalChanceMultiplier
CriticalPowerMultiplier
Defense
Immunity
KnockbackMultiplier
MagneticRadius
MaxStamina
Speed
WeaponPrecisionMultiplier
WeaponSpeedMultiplier 		(Optional) An amount applied to the player's attack, critical chance and critical power, defense, immunity, knockback (i.e. weight), magnetic radius, maximum stamina, speed, or weapon precision/speed while the buff is active. This can be negative for a debuff. Default 0.
CustomFields (Optional) The custom fields for this entry.

Geodes & artifact spots

field purpose
GeodeDrops
GeodeDropsDefaultItems 		(Optional) The items that can be dropped when breaking open this item as a geode. Specifying either or both fields automatically enables geode behavior for this item.

You can specify one or both fields:

  • GeodeDrops can be set to the specific items to drop. Default none. This consists of a list of models with these fields:
    field purpose
    common fields See item spawn fields for the generic item fields supported by geode drops.

    If set to an item query which returns multiple items, one of them will be selected at random.

    Chance (Optional) The probability that the item will be dropped if the other fields match, as a decimal value between 0 (never) and 1 (always). Default 1.
    SetFlagOnPickup (Optional) The mail flag to set for the current player when this drop is picked up.
    Precedence (Optional) The order in which this entry should be checked, where lower values are checked first. This can be a negative value. Geode drops with the same precedence are checked in the order listed. Default 0.

    For consistency, vanilla drops mostly use these values:

    • -1000: special overrides like the golden helmet;
    • 0: normal items.
  • GeodeDropsDefaultItems chooses a predefined list of possible geode drops like clay, coal, copper, iridium, etc. Default false.

If both fields are specified, each geode will choose between them with an equal 50% chance. If GeodeDrops is specified but no entries match, the geode will use the GeodeDropsDefaultItems regardless of whether it's true.

ArtifactSpotChances (Optional) If this is an artifact (i.e. the Type field is Arch), the chance that it can be found by digging artifact spots in each location.

This consists of a string → model lookup, where:

  • the key is the internal location name;
  • the value is the probability the item will spawn if checked, as a decimal value between 0 (never) and 1 (always).

Context tags & exclusions

field purpose
ContextTags (Optional) The custom context tags to add for this item (in addition to the tags added automatically based on the other object data). This is formatted as a list; for example: 
"ContextTags": [ "color_yellow", "fish_ocean", "fish_upright", "season_summer" ]
CanBeGivenAsGift (Optional) Whether this item can be gifted to NPCs. Default true.
CanBeTrashed (Optional) Whether this item can be trashed from the player's inventory. Also affects whether the item can be shipped but not whether it can be sold to shops. Default true.
ExcludeFromRandomSale (Optional) Whether to exclude this item from shops when selecting random items to sell. Default false.
ExcludeFromFishingCollection
ExcludeFromShippingCollection 		(Optional) Whether to exclude this item from the fishing/shipping collection and their respective effect on the perfection score. Default false, in which case the normal requirements apply (e.g., artifacts are always excluded from the shipping collection).

Advanced

field purpose
CustomFields (Optional) The custom fields for this entry.

Unobtainable items

The spritesheet and data have items that can't normally be found in the player inventory (like twigs and lumber), and some sprites have no corresponding item data. There are also multiple entries for weeds and stone corresponding to different sprites, but the player can only normally obtain one stone item (index 390) and no weeds items.

For C# mods

Object-type items are represented by the StardewValley.Object type.

This provides many methods to simplify common logic. Some notable examples:

method effect
Object.GetRadiusForScarecrow() The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the crow_scare_radius_<radius> context tag if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise. Can be patched to support custom scarecrows.
Object.IsBar() Whether the item is a copper bar, iron bar, gold bar, iridium bar, or radioactive bar.
Object.IsBreakableStone() Whether the item is a stone debris item which can be broken by a pickaxe.
Object.IsFence() Whether the item is a fence.
Object.IsFruitTreeSapling() Whether the item is a fruit tree sapling. This checks the Data\fruitTrees keys, so it works with custom fruit trees too.
Object.IsHeldOverHead() Whether the player is shown holding up the item when it's selected in their toolbar. Default true (except for furniture).
Object.IsIncubator() Whether the item can incubate farm animal eggs when placed in a building.
Object.IsScarecrow() Whether the item is a scarecrow. Default: true if the object has the crow_scare context tag. Otherwise, returns whether the object's internal name contains "arecrow". Can be patched to support custom scarecrows.
Object.IsTapper() Whether the item is a tapper or heavy tapper.
Object.IsTeaSapling() Whether the item is a tea sapling.
Object.IsTwig() Whether the item is a twig debris item.
Object.IsWeeds() Whether the item is a weed debris item.

See also

Retrieved from "https://stardew.fastobject.net/index.php?title=Modding:Objects&oldid=173528"