Modding:Shirts: Difference between revisions
imported>Pathoschild split from Modding:Items; attribution: Pathoschild (main author), BarleyZP (copied info from 1.6 migration guide with main content by Pathoschild and formatting fixes by Atravita, followup fixes) |
imported>Sunbeam135 No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
← [[Modding:Items|Items]] | ← [[Modding:Items|Items]] | ||
This page explains how the game stores and parses shirt-type item data. For items in general, see [[Modding:Items]]. | |||
== | ==Overview== | ||
Shirts are items that can be equipped in the player's [[Tailoring#Shirts|shirt]] slot. These change the player sprite. | |||
They have [[Modding:Items#Item types|item type]] <code>(S)</code> (or <code>ItemRegistry.type_shirt</code> in C# code), their data in <samp>Data/Shirts</samp>, their icon sprites in <samp>Characters/Farmer/shirts</samp> by default, and their code in <samp>StardewValley.Objects.Clothing</samp>. | |||
* The key is the | |||
==Data format== | |||
The shirt data in <samp>Data/Shirts</samp> consists of a string → model lookup, where... | |||
* The key is the [[Modding:Common data field types#Item ID|unqualified item ID]]. | |||
* The value is a model with the fields listed below. | * The value is a model with the fields listed below. | ||
===Basic data=== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 25: | Line 29: | ||
|} | |} | ||
===Appearance=== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 33: | Line 37: | ||
| <samp>Texture</samp> | | <samp>Texture</samp> | ||
| The asset name for the texture containing the shirt's sprite. Defaults to <samp>Characters/Farmer/shirts</samp>. | | The asset name for the texture containing the shirt's sprite. Defaults to <samp>Characters/Farmer/shirts</samp>. | ||
Shirt textures must be exactly 256 pixels wide, divided into two halves: the left half for the shirt sprites, and the right half for any dye masks. The remaining space can be left blank if needed. They can have any number of rows. | |||
<pre> | |||
sprites dye masks | |||
/-----------\ /-----------\ | |||
┌────────────────────────────────┐ | |||
│ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │ | |||
│ │ 0 ││ 1 ││ 2 ││ a ││ b ││ c │ │ | |||
│ └───┘└───┘└───┘└───┘└───┘└───┘ │ | |||
│ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │ | |||
│ │ 3 ││ 4 ││ 5 ││ d ││ e ││ f │ │ | |||
│ └───┘└───┘└───┘└───┘└───┘└───┘ │ | |||
└────────────────────────────────┘ | |||
</pre> | |||
|- | |- | ||
| <samp>SpriteIndex</samp> | | <samp>SpriteIndex</samp> | ||
| Line 50: | Line 68: | ||
|} | |} | ||
===Other=== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 62: | Line 80: | ||
| The [[Modding:Common_data_field_types#Custom_fields|custom fields]] for this entry. | | The [[Modding:Common_data_field_types#Custom_fields|custom fields]] for this entry. | ||
|} | |} | ||
==See also== | |||
* [[Modding:Items]] for item data in general | |||
[[Category:Modding]] | [[Category:Modding]] | ||
[[ru:Модификации:Топы]] | |||
[[zh:模组:上衣]] | |||
Latest revision as of 22:03, 12 January 2026
← Items
This page explains how the game stores and parses shirt-type item data. For items in general, see Modding:Items.
Overview
Shirts are items that can be equipped in the player's shirt slot. These change the player sprite.
They have item type (S) (or ItemRegistry.type_shirt in C# code), their data in Data/Shirts, their icon sprites in Characters/Farmer/shirts by default, and their code in StardewValley.Objects.Clothing.
Data format
The shirt data in Data/Shirts 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 data
| field | purpose |
|---|---|
| Name | (Optional) The internal name for the item. Default Shirt. |
| DisplayName Description |
(Optional) A tokenizable string for the item's in-game display name and description. Defaults to the generic shirt text (Shirt and A wearable shirt). |
| Price | (Optional) The default price when the item is sold to the player in a shop. Default 50. |
Appearance
| field | purpose |
|---|---|
| Texture | The asset name for the texture containing the shirt's sprite. Defaults to Characters/Farmer/shirts.
Shirt textures must be exactly 256 pixels wide, divided into two halves: the left half for the shirt sprites, and the right half for any dye masks. The remaining space can be left blank if needed. They can have any number of rows. sprites dye masks /-----------\ /-----------\ ┌────────────────────────────────┐ │ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │ │ │ 0 ││ 1 ││ 2 ││ a ││ b ││ c │ │ │ └───┘└───┘└───┘└───┘└───┘└───┘ │ │ ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ │ │ │ 3 ││ 4 ││ 5 ││ d ││ e ││ f │ │ │ └───┘└───┘└───┘└───┘└───┘└───┘ │ └────────────────────────────────┘ |
| SpriteIndex | The shirt's sprite index within the Texture, where 0 is the top-left set. |
| DefaultColor | (Optional) The dye color to apply to the sprite when the player hasn't dyed it yet, if any. See color format. Default none. |
| CanBeDyed | (Optional) Whether the player can dye this shirt. Default false. |
| IsPrismatic | (Optional) Whether the shirt continuously shifts colors. This overrides DefaultColor and CanBeDyed if set. Default false. |
| HasSleeves | (Optional) Whether to draw shirt sleeves. Default true. |
Other
| field | purpose |
|---|---|
| CanChooseDuringCharacterCustomization | (Optional) Whether this shirt can be selected on the character customization screen (e.g. when creating a character). Default false. |
| CustomFields | The custom fields for this entry. |
See also
- Modding:Items for item data in general