Changes

Modding:Migrate to Stardew Valley 1.5.5 (view source)

Revision as of 18:48, 4 November 2021

948 bytes added , 18:48, 4 November 2021

m

Text replacement - "tt>" to "samp>"

Line 13: Line 13:

<ol>

<li>[[Modding:Migrate to 64-bit on Windows#How do I update mod code for 64-bit?|Enable 64-bit compatibility]] if you haven't already. (Unless you explicitly changed the project settings, mods are 64-bit ready by default.)</li>

−

<li>Migrate your <tt>.csproj</tt> files to the new format if you haven't already:<ol>

+

<li>Migrate your <samp>.csproj</samp> files to the new format if you haven't already:<ol>

−

<li>Replace your mod's <tt>.csproj</tt> file with this:

+

<li>Replace your mod's <samp>.csproj</samp> file with this:

Line 31: Line 31:

</li>

<li>If the mod uses [[Modding:Modder Guide/APIs/Harmony|Harmony]], add <code><nowiki><EnableHarmony>true</EnableHarmony></nowiki></code> to the property group.</li>

−

<li>Update the <tt>AssemblyName</tt>, <tt>RootNamespace</tt>, and <tt>Version</tt> tags. (You can delete the <tt>AssemblyName</tt> and <tt>RootNamespace</tt> tags if they just match the project name.)</li>

+

<li>Update the <samp>AssemblyName</samp>, <samp>RootNamespace</samp>, and <samp>Version</samp> tags. (You can delete the <samp>AssemblyName</samp> and <samp>RootNamespace</samp> tags if they just match the project name.)</li>

<li>Add any other NuGet packages you used, if any.</li>

−

<li>Delete the <tt>Properties/AssemblyInfo.cs</tt> file, <tt>packages</tt> folder, and <tt>packages.config</tt> file (if present).</li>

+

<li>Delete the <samp>Properties/AssemblyInfo.cs</samp> file, <samp>packages</samp> folder, and <samp>packages.config</samp> file (if present).</li>

</ol>

</li>

−

<li>Edit your mod's <tt>.csproj</tt> file, and replace <code><nowiki><TargetFramework>net452</TargetFramework></nowiki></code> with <code><nowiki><TargetFramework>net5.0</TargetFramework></nowiki></code>.</li>

+

<li>Edit your mod's <samp>.csproj</samp> file, and replace <code><nowiki><TargetFramework>net452</TargetFramework></nowiki></code> with <code><nowiki><TargetFramework>net5.0</TargetFramework></nowiki></code>.</li>

<li>Update the mod build package to the prerelease 4.0.0 version.</li>

<li>Exit Visual Studio.</li>

−

<li>Delete your solution's hidden <tt>.vs</tt> folder, and every project's <tt>bin</tt> and <tt>obj</tt> folders.</li>

+

<li>Delete your solution's hidden <samp>.vs</samp> folder, and every project's <samp>bin</samp> and <samp>obj</samp> folders.</li>

<li>Reopen the solution in Visual Studio, click ''Build > Rebuild Solution'', fix any errors, and test the mod in-game.</li>

</ol>

Specific things to check for:

−

* [[Modding:Modder Guide/APIs/Utilities#Constants|<code>Constants.GameFramework</code>]] now always returns <tt>MonoGame</tt>. Any code which checks for <tt>Xna</tt> can be removed or rewritten.

+

* [[Modding:Modder Guide/APIs/Utilities#Constants|<code>Constants.GameFramework</code>]] now always returns <samp>MonoGame</samp>. Any code which checks for <samp>Xna</samp> can be removed or rewritten.

If you need help, feel free to ask in [[Modding:Community#Discord|#making-mods on the Stardew Valley Discord]]!

Line 127: Line 127:

! Content Patcher

|-

−

| <tt>Data/TV/TipChannel</tt>

+

| <samp>Data/TV/TipChannel</samp>

| fixed typo

| ✘ will remove changes

| ✓ mostly unaffected

|-

−

| <tt>Effects/BloomCombine</tt> <tt>Effects/BloomExtract</tt> <tt>Effects/GaussianBlur</tt>

+

| <samp>Effects/BloomCombine</samp> <samp>Effects/BloomExtract</samp> <samp>Effects/GaussianBlur</samp>

| deleted

|

|-

−

| <tt>Fonts/*</tt>

+

| <samp>Fonts/*</samp>

| no changes ([[Modding:Editing XNB files#unpack|unpacked format]] may differ on Windows due to [[#64-bit MonoGame and .NET 5|MonoGame]])

|

|-

−

| <tt>LooseSprites/Cursors2</tt>

+

| <samp>LooseSprites/Cursors2</samp>

| new sprite in empty area

| '''✘ broken'''

| ✓ mostly unaffected

|-

−

| <tt>Maps/Desert</tt>

+

| <samp>Maps/Desert</samp>

| cosmetic fixes

| ✘ will remove changes

| ✓ mostly unaffected

|-

−

| <tt>Maps/ElliottHouse</tt>

+

| <samp>Maps/ElliottHouse</samp>

| minor fixes

| ✘ will remove changes

| ✓ mostly unaffected

|-

−

| <tt>Maps/Farm</tt> <tt>Maps/Farm_Combat</tt> <tt>Maps/Farm_Fishing</tt> <tt>Maps/Farm_Foraging</tt> <tt>Maps/Farm_FourCorners</tt> <tt>Maps/Farm_Island</tt> <tt>Maps/Farm_Mining</tt>

+

| <samp>Maps/Farm</samp> <samp>Maps/Farm_Combat</samp> <samp>Maps/Farm_Fishing</samp> <samp>Maps/Farm_Foraging</samp> <samp>Maps/Farm_FourCorners</samp> <samp>Maps/Farm_Island</samp> <samp>Maps/Farm_Mining</samp>

| cave and shipping areas now use tile properties to disable building, instead of being hardcoded

| ✘ will remove those build restrictions

| ✘ may remove those build restrictions

|-

−

| <tt>Maps/FarmHouse</tt> <tt>Maps/FarmHouse1</tt> <tt>Maps/FarmHouse1_marriage</tt> <tt>Maps/FarmHouse2</tt> <tt>Maps/FarmHouse2_marriage</tt> <tt>Maps/Farmhouse_*</tt> renovation maps <tt>Maps/IslandFarmHouse</tt> <tt>Maps/Shed</tt> <tt>Maps/Shed2</tt>

+

| <samp>Maps/FarmHouse</samp> <samp>Maps/FarmHouse1</samp> <samp>Maps/FarmHouse1_marriage</samp> <samp>Maps/FarmHouse2</samp> <samp>Maps/FarmHouse2_marriage</samp> <samp>Maps/Farmhouse_*</samp> renovation maps <samp>Maps/IslandFarmHouse</samp> <samp>Maps/Shed</samp> <samp>Maps/Shed2</samp>

| added new [[#Custom floors/walls|wall/flooring properties]]

| '''✘ broken''' (will disable most floor/walls when renovations applied)

| ✘ may disable some floor/walls when renovations applied

|-

−

| <tt>Maps/spouseRooms</tt>

+

| <samp>Maps/spouseRooms</samp>

| added [[#Custom spouse rooms|spouse standing spots]] (defaults to old offset if not set)

| ✓ mostly unaffected

|-

−

| <tt>Strings/Locations</tt>

+

| <samp>Strings/Locations</samp>

−

| changed <tt>ManorHouse_DivorceBook_*</tt> entries to support [[#Non-Krobus roommates|Non-Krobus roommates]]

+

| changed <samp>ManorHouse_DivorceBook_*</samp> entries to support [[#Non-Krobus roommates|Non-Krobus roommates]]

| '''✘ broken'''

| ✓ mostly unaffected

Line 185: Line 185:

===Horse footstep changes===

−

You can now override the footstep logic for a horse by setting its <tt>onFootstepAction</tt> field. For example:

+

You can now override the footstep logic for a horse by setting its <samp>onFootstepAction</samp> field. For example:

Horse horse = ...; // get the horse instance you want to change

Line 198: Line 198:

===Custom farm types===

−

You can now add custom farm types by editing the <tt>Data/AdditionalFarms</tt> asset. Each entry consists of an object with these fields:

+

You can now add custom farm types by editing the <samp>Data/AdditionalFarms</samp> asset. Each entry consists of an object with these fields:

{| class="wikitable"

Line 205: Line 205:

! description

|-

−

| <tt>ID</tt>

+

| <samp>ID</samp>

−

| A unique ID value. This must be '''globally''' unique across all mods, so you should prefix your mod ID (e.g. <tt>Example.PineapplesAnywhere/PineappleFarm</tt>). You should avoid commas for compatibility with Content Patcher packs checking the <tt><nowiki>{{FarmType}}</nowiki></tt> token. This is not shown in-game.

+

| A unique ID value. This must be '''globally''' unique across all mods, so you should prefix your mod ID (e.g. <samp>Example.PineapplesAnywhere/PineappleFarm</samp>). You should avoid commas for compatibility with Content Patcher packs checking the <samp><nowiki>{{FarmType}}</nowiki></samp> token. This is not shown in-game.

|-

−

| <tt>TooltipStringPath</tt>

+

| <samp>TooltipStringPath</samp>

−

| Where to get the translatable farm name and description. This must be a key in the form <tt>{{t|asset name}}:{{t|key}}</tt>; for example, <tt>Strings/UI:Farm_Description</tt> will get it from the <tt>Farm_Description</tt> entry in the <tt>Strings/UI</tt> file. The translated text must be in the form "<tt>{{t|name}}_{{t|description}}</tt>", like "Pineapple Farm_A farm shaped like a pineapple".

+

| Where to get the translatable farm name and description. This must be a key in the form <samp>{{t|asset name}}:{{t|key}}</samp>; for example, <samp>Strings/UI:Farm_Description</samp> will get it from the <samp>Farm_Description</samp> entry in the <samp>Strings/UI</samp> file. The translated text must be in the form "<samp>{{t|name}}_{{t|description}}</samp>", like "Pineapple Farm_A farm shaped like a pineapple".

|-

−

| <tt>MapName</tt>

+

| <samp>MapName</samp>

−

| The map asset name relative to the <tt>Maps</tt> folder. For example, <tt>Farm_Pineapple</tt> would load <tt>Maps/Farm_Pineapple</tt>.

+

| The map asset name relative to the <samp>Maps</samp> folder. For example, <samp>Farm_Pineapple</samp> would load <samp>Maps/Farm_Pineapple</samp>.

|-

−

| <tt>IconTexture</tt>

+

| <samp>IconTexture</samp>

| ''(optional)'' The asset name for a 22x20 pixel icon texture, shown on the 'New Game' and co-op join screens.

|-

−

| <tt>WorldMapTexture</tt>

+

| <samp>WorldMapTexture</samp>

| ''(optional)'' The asset name for a 131x61 pixel texture that's drawn over the farm area in the in-game world map.

|-

−

| <tt>ModData</tt>

+

| <samp>ModData</samp>

−

| ''(optional)'' A string→string dictionary of mod-specific metadata for the farm, which can be accessed in C# code via <tt>Game1.GetFarmTypeModData(key)</tt>.

+

| ''(optional)'' A string→string dictionary of mod-specific metadata for the farm, which can be accessed in C# code via <samp>Game1.GetFarmTypeModData(key)</samp>.

|}

Line 272: Line 272:

−

You can now add custom languages by editing the <tt>Data/AdditionalLanguages</tt> asset. Each entry consists of an object with these fields:

+

You can now add custom languages by editing the <samp>Data/AdditionalLanguages</samp> asset. Each entry consists of an object with these fields:

{| class="wikitable"

Line 279: Line 279:

! description

|-

−

| <tt>ID</tt>

+

| <samp>ID</samp>

| A unique ID value. This is not shown in-game.

|-

−

| <tt>LanguageCode</tt>

+

| <samp>LanguageCode</samp>

−

| The language code for this localization. This should ideally be a [[wikipedia:List of ISO 639-1 codes|ISO 639-1 code]]. You should avoid commas for compatibility with Content Patcher packs checking the <tt><nowiki>{{Language}}</nowiki></tt> token.

+

| The language code for this localization. This should ideally be a [[wikipedia:List of ISO 639-1 codes|ISO 639-1 code]]. You should avoid commas for compatibility with Content Patcher packs checking the <samp><nowiki>{{Language}}</nowiki></samp> token.

|-

−

| <tt>ButtonTexture</tt>

+

| <samp>ButtonTexture</samp>

| The asset name for a 174x78 pixel texture containing the button of the language for language selection menu. The top half of the sprite is the default state, while the bottom half is the hover state.

|-

−

| <tt>UseLatinFont</tt>

+

| <samp>UseLatinFont</samp>

−

| Whether the language uses the same Latin character font as English. If set to <tt>false</tt>, you must set the <tt>FontFile</tt> field.

+

| Whether the language uses the same Latin character font as English. If set to <samp>false</samp>, you must set the <samp>FontFile</samp> field.

|-

−

| <tt>TimeFormat</tt>

+

| <samp>TimeFormat</samp>

| A string which describes the in-game time format, with tokens replaced by in-game values. For example, <code>[HOURS_12]:[MINUTES] [AM_PM]</code> would show <code>12:00 PM</code> at noon.

Line 302: Line 302:

* <code>[AM_PM]</code>: the localized text for "am" or "pm" (taken from <code>Strings\\StringsFromCSFiles:DayTimeMoneyBox.cs.10370</code> and <code>DayTimeMoneyBox.cs.10371</code> respectively). The game shows "pm" between noon and 11:59pm inclusively; it shows "am" otherwise.

|-

−

| <tt>ClockTimeFormat</tt>

+

| <samp>ClockTimeFormat</samp>

−

| A string which describes the in-game time format. Equivalent to <tt>TimeFormat</tt>, but used for the in-game clock.

+

| A string which describes the in-game time format. Equivalent to <samp>TimeFormat</samp>, but used for the in-game clock.

|-

−

| <tt>ClockDateFormat</tt>

+

| <samp>ClockDateFormat</samp>

| A string which describes the in-game date format as shown in the in-game clock, with tokens replaced by in-game values. For example, <code>[DAY_OF_WEEK]. [DAY_OF_MONTH]</code> would show <code>Mon. 1</code>.

The valid tokens are:

−

* <code>[DAY_OF_WEEK]</code>: the abbreviated day of week as returned by <code>Game1.shortDayDisplayNameFromDayOfSeason</code> (like <tt>Mon</tt> for Monday).

+

* <code>[DAY_OF_WEEK]</code>: the abbreviated day of week as returned by <code>Game1.shortDayDisplayNameFromDayOfSeason</code> (like <samp>Mon</samp> for Monday).

* <code>[DAY_OF_MONTH]</code>: the numerical day of the month.

|-

−

| <tt>FontFile</tt>

+

| <samp>FontFile</samp>

−

| ''(optional)'' The asset name for the font file to use (if <tt>UseLatinFont</tt> is <tt>false</tt>).

+

| ''(optional)'' The asset name for the font file to use (if <samp>UseLatinFont</samp> is <samp>false</samp>).

|-

−

| <tt>FontPixelZoom</tt>

+

| <samp>FontPixelZoom</samp>

| ''(optional)'' A factor by while to multiply the font size.

|-

−

| <tt>FontApplyYOffset</tt>

+

| <samp>FontApplyYOffset</samp>

−

| ''(optional)'' Whether to shift the font up by four pixels (multiplied by the <tt>FontPixelZoom</tt>), to better align languages with larger characters like Chinese and Japanese.

+

| ''(optional)'' Whether to shift the font up by four pixels (multiplied by the <samp>FontPixelZoom</samp>), to better align languages with larger characters like Chinese and Japanese.

|-

−

| <tt>NumberComma</tt>

+

| <samp>NumberComma</samp>

| ''(optional)'' The string to use as the thousands separator (e.g. <code>","</code> for <code>5,000,000</code>). Defaults to a comma.

|-

−

| <tt>SmallFontLineSpacing</tt>

+

| <samp>SmallFontLineSpacing</samp>

−

| ''(optional)'' The line spacing value used by <tt>smallFont</tt>. Defaults to 26.

+

| ''(optional)'' The line spacing value used by <samp>smallFont</samp>. Defaults to 26.

|-

−

| <tt>UseGenderedCharacterTranslations</tt>

+

| <samp>UseGenderedCharacterTranslations</samp>

| ''(optional)'' Whether the social tab and gift log will use gender-specific translations (like the vanilla Portuguese language). Defaults to false.

−

Specifically, this affects the <tt>Strings\StringsFromCSFiles:SocialPage.cs.11635</tt> translation ("''(Single)''"). When enabled, it can contain male and female translations separated by <code>/</code>, like the vanilla Portuguese translation: "''(solteiro)/(solteira)''".

+

Specifically, this affects the <samp>Strings\StringsFromCSFiles:SocialPage.cs.11635</samp> translation ("''(Single)''"). When enabled, it can contain male and female translations separated by <code>/</code>, like the vanilla Portuguese translation: "''(solteiro)/(solteira)''".

|}

Line 381: Line 381:

===Custom festival location names===

−

The location name in the festival-started message (e.g. "''The Luau has begun on the beach''") was previously hardcoded, so it would always show the internal name for non-vanilla festival locations. You can now add a <tt>locationDisplayName</tt> field in the <tt>Data/Festivals/*</tt> file to set the display name.

+

The location name in the festival-started message (e.g. "''The Luau has begun on the beach''") was previously hardcoded, so it would always show the internal name for non-vanilla festival locations. You can now add a <samp>locationDisplayName</samp> field in the <samp>Data/Festivals/*</samp> file to set the display name.

===Custom spouse rooms===

Adding spouse rooms for custom NPCs is now much easier.

<ul>

−

<li>You can edit the <tt>Data/SpouseRooms</tt> asset to add the spouse room info in this format: <code>"{{t|NPC name}}": "{{t|map name}}/{{t|map index}}"</code>.

+

<li>You can edit the <samp>Data/SpouseRooms</samp> asset to add the spouse room info in this format: <code>"{{t|NPC name}}": "{{t|map name}}/{{t|map index}}"</code>.

{| class="wikitable"

Line 394: Line 394:

|-

| <code>{{t|NPC name}}</code>

−

| The internal name of the NPC (i.e. their key in <tt>Data/NPCDispositions</tt>).

+

| The internal name of the NPC (i.e. their key in <samp>Data/NPCDispositions</samp>).

|-

| <code>{{t|map name}}</code>

−

| The asset name of the map in the game's <tt>Content/Maps</tt> folder. This can be a custom map loaded through Content Patcher's <tt>Load</tt> action or SMAPI's <tt>IAssetLoader</tt> API.

+

| The asset name of the map in the game's <samp>Content/Maps</samp> folder. This can be a custom map loaded through Content Patcher's <samp>Load</samp> action or SMAPI's <samp>IAssetLoader</samp> API.

|-

| <code>{{t|map index}}</code>

| The index of the spouse room within the map file, to allow multiple spouse rooms in the same file. Each spouse room is 6 tiles across by 9 tiles down, starting with index 0 in the top-left corner. You can have any number of rows and columns (the index will wrap at the end of the row), as long as they fit an integer number of spouse rooms.

|}</li>

−

<li>You can mark where the spouse stands in their spouse room by placing the red circle path tile (tile index 7) on [[Modding:Maps#Paths layer|the <tt>Paths</tt> layer]].</li>

+

<li>You can mark where the spouse stands in their spouse room by placing the red circle path tile (tile index 7) on [[Modding:Maps#Paths layer|the <samp>Paths</samp> layer]].</li>

<li>The spouse room maps are now applied using the game's newer map override system, so tile properties and custom tilesheets in the spouse room map are copied over automatically.</li>

<li>Some of the game's spouse room code (e.g. positions for Sebastian's 14-heart frog terrarium) was updated to potentially allow moving spouse rooms around. However, some things like event positions are still hardcoded and will need to be fixed to fully support this feature.</li>

Line 431: Line 431:

===Custom spouse outside areas===

−

You can now customize the [[Marriage#Spouse Outside Area|spouse outside area]] for any NPC by editing <tt>Data/SpousePatios</tt>, which has four slash-delimited fields:

+

You can now customize the [[Marriage#Spouse Outside Area|spouse outside area]] for any NPC by editing <samp>Data/SpousePatios</samp>, which has four slash-delimited fields:

{| class="wikitable"

|-

Line 437: Line 437:

! effect

|-

−

| <tt>map asset name</tt>

+

| <samp>map asset name</samp>

−

| The asset name relative to the <tt>Content/Maps</tt> folder which contains the spouse area map. The map must contain one or more 4x4 tile areas, with any number of rows and columns.

+

| The asset name relative to the <samp>Content/Maps</samp> folder which contains the spouse area map. The map must contain one or more 4x4 tile areas, with any number of rows and columns.

|-

−

| <tt>index</tt>

+

| <samp>index</samp>

| The index (starting at zero) within the map for the 4x4 area to use as the outdoor area.

|-

−

| <tt>NPC animation frames</tt>

+

| <samp>NPC animation frames</samp>

| ''(Optional)'' The spouse's animation frames, as a sequence of space-delimited frame indexes in their sprite's spritesheet each lasting 100 milliseconds. If not set, vanilla spouses will use their hardcoded animations and custom spouses won't be animated.

|-

−

| <tt>{{t|NPC offset X}} {{t|NPC offset Y}}</tt>

+

| <samp>{{t|NPC offset X}} {{t|NPC offset Y}}</samp>

| ''(Optional)'' A pixel X and Y offset applied to the NPC's position when they're in their outdoor area.

|}

−

You can mark where the spouse stands in their spouse area by placing the red circle path tile (tile index 7) on [[Modding:Maps#Paths layer|the <tt>Paths</tt> layer]].

+

You can mark where the spouse stands in their spouse area by placing the red circle path tile (tile index 7) on [[Modding:Maps#Paths layer|the <samp>Paths</samp> layer]].

For example, this Content Patcher pack would add the outside area for a new Akila NPC. When in the outside area, their sprite would cycle through spritesheet indexes 16–19 for 300 milliseconds each, and be offset by 1 pixel to the right and 5 pixels down.

Line 485: Line 485:

|-

| farmhouse

−

| <tt>AdditionalRenovations {{t|renovation}}+</tt>

+

| <samp>AdditionalRenovations {{t|renovation}}+</samp>

−

| A comma-separated list of renovations to apply, each in the form <tt>{{t|map patch ID}} {{t|required mail flag}} {{t|map asset if active}} {{t|map asset if inactive}} {{o|area rectangle}}</tt>. Fields:

+

| A comma-separated list of renovations to apply, each in the form <samp>{{t|map patch ID}} {{t|required mail flag}} {{t|map asset if active}} {{t|map asset if inactive}} {{o|area rectangle}}</samp>. Fields:

{| class="wikitable"

|-

Line 492: Line 492:

! effect

|-

−

| <tt>map patch ID</tt>

+

| <samp>map patch ID</samp>

| A unique ID for the patch being applied. This is usually similar to the renovation name, but can be any unique value. If a renovation applies multiple map patches, each one must have unique ID.

|-

−

| <tt>required mail flag</tt>

+

| <samp>required mail flag</samp>

| The [[Modding:Mail data#Mail flags|mail flag]] that is checked on the house's owner to decide whether the patch should be applied.

|-

−

| <tt>map asset if active</tt>

+

| <samp>map asset if active</samp>

−

| The asset name for the map applied when the mail flag is set, relative to the <tt>Maps</tt> folder.

+

| The asset name for the map applied when the mail flag is set, relative to the <samp>Maps</samp> folder.

|-

−

| <tt>map asset if inactive</tt>

+

| <samp>map asset if inactive</samp>

−

| The asset name for the map applied when the mail flag is not set, relative to the <tt>Maps</tt> folder.

+

| The asset name for the map applied when the mail flag is not set, relative to the <samp>Maps</samp> folder.

|-

−

| <tt>area rectangle</tt>

+

| <samp>area rectangle</samp>

−

| ''(Optional)'' The tile area in the map to patch, specified as <tt>{{t|X}} {{t|Y}} {{t|width}} {{t|height}}</tt>. If {{t|X}} isn't set, this defaults to the top-left corner of the map. If it is, you must specify all four values.

+

| ''(Optional)'' The tile area in the map to patch, specified as <samp>{{t|X}} {{t|Y}} {{t|width}} {{t|height}}</samp>. If {{t|X}} isn't set, this defaults to the top-left corner of the map. If it is, you must specify all four values.

|}

−

For example, this Content Patcher pack would add a renovation to the fully-upgraded farmhouse based on a custom <tt>Pathoschild_PineapplesEverywhere_HasRenovation</tt> flag. Note that <tt>TextOperations</tt> is used to avoid overwriting any renovations added by another mod, and <tt>Pathoschild_PineapplesEverywhere_</tt> is a unique prefix for the hypothetical mod to avoid conflicts with other mods.

+

For example, this Content Patcher pack would add a renovation to the fully-upgraded farmhouse based on a custom <samp>Pathoschild_PineapplesEverywhere_HasRenovation</samp> flag. Note that <samp>TextOperations</samp> is used to avoid overwriting any renovations added by another mod, and <samp>Pathoschild_PineapplesEverywhere_</samp> is a unique prefix for the hypothetical mod to avoid conflicts with other mods.

{{#tag:syntaxhighlight|

{

Line 557: Line 557:

|-

| ''decoratable locations''

−

| <tt>FloorIDs {{o|area}}+</tt> <tt>WallIDs {{o|area}}+</tt>

+

| <samp>FloorIDs {{o|area}}+</samp> <samp>WallIDs {{o|area}}+</samp>

−

| A comma-separated list of the distinct areas which have flooring or walls. The <tt>FloorIDs</tt> and <tt>WallIDs</tt> don't need to match. Each area has the form <code>{{t|area ID}} {{o|default flooring/wallpaper ID}}</code>, where:

+

| A comma-separated list of the distinct areas which have flooring or walls. The <samp>FloorIDs</samp> and <samp>WallIDs</samp> don't need to match. Each area has the form <code>{{t|area ID}} {{o|default flooring/wallpaper ID}}</code>, where:

−

* <tt>{{t|area ID}}</tt> uniquely identifies the area or room.

+

* <samp>{{t|area ID}}</samp> uniquely identifies the area or room.

−

* <tt>{{o|default flooring/wallpaper ID}}</tt> (optional) sets the initial flooring/wallpaper ID if that area hasn't been customized by the player yet. This can be defined in three forms:

+

* <samp>{{o|default flooring/wallpaper ID}}</samp> (optional) sets the initial flooring/wallpaper ID if that area hasn't been customized by the player yet. This can be defined in three forms:

−

** <code>{{t|index}}</code>: get the floor/wallpaper matching that index in the vanilla <tt>Maps/walls_and_floors</tt> tilesheet.

+

** <code>{{t|index}}</code>: get the floor/wallpaper matching that index in the vanilla <samp>Maps/walls_and_floors</samp> tilesheet.

−

** <code>{{t|tilesheet}}:{{t|index}}</code>: add <tt>Maps/{{t|tilesheet}}</tt> to the map, and match the index in that tilesheet.

+

** <code>{{t|tilesheet}}:{{t|index}}</code>: add <samp>Maps/{{t|tilesheet}}</samp> to the map, and match the index in that tilesheet.

−

** <code>{{t|area ID}}</code>: inherit the default floor/wallpaper from the named area. For example, <tt>Hallway_Bedroom Bedroom</tt> applies the bedroom wallpaper to the hallway between the bedroom and living room when the farmhouse is first upgraded.

+

** <code>{{t|area ID}}</code>: inherit the default floor/wallpaper from the named area. For example, <samp>Hallway_Bedroom Bedroom</samp> applies the bedroom wallpaper to the hallway between the bedroom and living room when the farmhouse is first upgraded.

** If omitted, the default will be flooring/wallpaper #0.

Line 569: Line 569:

WallIDs: LivingRoom, Hallway_Bedroom Bedroom, Bedroom</pre>

−

You don't need to add every area to the <tt>FloorIDs</tt>/<tt>WallIDs</tt> list; assigning a flooring/wall to an unlisted value will be handled correctly. You only really need to add an area to <tt>FloorIDs</tt>/<tt>WallIDs</tt> to set the default flooring/wallpaper value, or for cases where the order of the walls/floors is important (for backwards compatibility with code that sets wallpaper/flooring by an integer room index, as is the case with the floors/walls in the vanilla farmhouse).

+

You don't need to add every area to the <samp>FloorIDs</samp>/<samp>WallIDs</samp> list; assigning a flooring/wall to an unlisted value will be handled correctly. You only really need to add an area to <samp>FloorIDs</samp>/<samp>WallIDs</samp> to set the default flooring/wallpaper value, or for cases where the order of the walls/floors is important (for backwards compatibility with code that sets wallpaper/flooring by an integer room index, as is the case with the floors/walls in the vanilla farmhouse).

|}

Line 580: Line 580:

! effect

|-

−

| <tt>Back</tt>

+

| <samp>Back</samp>

−

| <tt>WallID {{t|area ID}}</tt> <tt>FloorID {{t|area ID}}</tt>

+

| <samp>WallID {{t|area ID}}</samp> <samp>FloorID {{t|area ID}}</samp>

−

| Adds this tile to the given floor/wall area. Each floor tile should have the <tt>FloorID</tt> property, but only the top edge of the wall should have <tt>WallID</tt>.

+

| Adds this tile to the given floor/wall area. Each floor tile should have the <samp>FloorID</samp> property, but only the top edge of the wall should have <samp>WallID</samp>.

|}

====In the furniture catalogue====

−

You can also add new flooring/wallpaper options to the furniture catalogue by adding it to <tt>Data/AdditionalWallpaperFlooring</tt>. Each entry consists of an object with these fields:

+

You can also add new flooring/wallpaper options to the furniture catalogue by adding it to <samp>Data/AdditionalWallpaperFlooring</samp>. Each entry consists of an object with these fields:

{| class="wikitable"

Line 593: Line 593:

! description

|-

−

| <tt>ID</tt>

+

| <samp>ID</samp>

| A unique ID value. This is not shown in-game.

|-

−

| <tt>Texture</tt>

+

| <samp>Texture</samp>

| The asset name which contains 32x32 pixel (flooring) or 16x48 pixel (wallpaper) sprites. The tilesheet must be 256 pixels wide, but can have any number of flooring/wallpaper rows.

|-

−

| <tt>IsFlooring</tt>

+

| <samp>IsFlooring</samp>

| Whether this is a flooring tilesheet; else it's a wallpaper tilesheet.

|-

−

| <tt>Count</tt>

+

| <samp>Count</samp>

| The number of flooring or wallpaper sprites in the tilesheet.

|}

Line 644: Line 644:

|-

| ''any''

−

| <tt>AllowGrassGrowInWinter T</tt>

+

| <samp>AllowGrassGrowInWinter T</samp>

| Allows [[grass]] to spread in winter.

|-

| ''any''

−

| <tt>AllowGrassSurviveInWinter T</tt>

+

| <samp>AllowGrassSurviveInWinter T</samp>

| Allows [[grass]] that's alive on the last day of fall to survive through to winter.

|-

| ''any''

−

| <tt>ClearEmptyDirtOnNewMonth T</tt>

+

| <samp>ClearEmptyDirtOnNewMonth T</samp>

| Destroy most tilled dirt that doesn't contain crops when a new year starts.

|-

| ''any''

−

| <tt>EnableGrassSpread T</tt>

+

| <samp>EnableGrassSpread T</samp>

| Gives [[grass]] in the location a chance to spread each day.

|-

| ''any''

−

| <tt>ForceAllowTreePlanting T</tt>

+

| <samp>ForceAllowTreePlanting T</samp>

| Allows planting trees (both wild and fruit) in this location, even if it normally wouldn't be allowed.

|-

| ''any''

−

| <tt>IsFarm T</tt>

+

| <samp>IsFarm T</samp>

| Marks the location as a farm. This only affects generic location/interaction logic which checks the in-code <code>location.IsFarm</code> property; logic hardcoded into the game's <code>Farm</code> class (e.g. farm animals, pets, crows/scarecrows, greenhouse, farm buildings, etc) is still limited to the actual farm.

|-

| ''any''

−

| <tt>IsGreenhouse T</tt>

+

| <samp>IsGreenhouse T</samp>

| Marks the location as a greenhouse.

|-

| ''any''

−

| <tt>SpawnGrassFromPathsOnNewYear T</tt>

+

| <samp>SpawnGrassFromPathsOnNewYear T</samp>

−

| Spawns grass on every tile with index 22 on the <tt>Paths</tt> layer when a new year starts. See also <tt>SpawnRandomGrassOnNewYear</tt>.

+

| Spawns grass on every tile with index 22 on the <samp>Paths</samp> layer when a new year starts. See also <samp>SpawnRandomGrassOnNewYear</samp>.

|-

| ''any''

−

| <tt>SpawnDebrisOnNewMonth T</tt> <tt>SpawnDebrisOnNewYear T</tt>

+

| <samp>SpawnDebrisOnNewMonth T</samp> <samp>SpawnDebrisOnNewYear T</samp>

| Spawns weeds, stones, or twigs at random positions when a new month/year starts (subject to their usual spawn rules).

|-

| ''any''

−

| <tt>SpawnRandomGrassOnNewYear T</tt>

+

| <samp>SpawnRandomGrassOnNewYear T</samp>

−

| Spawns grass at random positions when a new year starts (subject to its usual spawn rules). See also <tt>SpawnGrassFromPathsOnNewYear</tt>.

+

| Spawns grass at random positions when a new year starts (subject to its usual spawn rules). See also <samp>SpawnGrassFromPathsOnNewYear</samp>.

|-

| farm

−

| <tt>FarmFishLocationOverride {{t|location name}} {{t|chance}}</tt>

+

| <samp>FarmFishLocationOverride {{t|location name}} {{t|chance}}</samp>

−

| Adds an alternative location name when catching fish, where the {{t|chance}} is a decimal value between 0 (never happens) and 1 (always happens). For example, <tt>FarmFishLocationOverride Mountain 0.5</tt> adds a 50% chance of catching mountain fish instead of the normal fish for that location. The location name is case-sensitive, and matches those shown by the {{nexus mod|679|Debug Mode mod}}.

+

| Adds an alternative location name when catching fish, where the {{t|chance}} is a decimal value between 0 (never happens) and 1 (always happens). For example, <samp>FarmFishLocationOverride Mountain 0.5</samp> adds a 50% chance of catching mountain fish instead of the normal fish for that location. The location name is case-sensitive, and matches those shown by the {{nexus mod|679|Debug Mode mod}}.

|-

| farm

−

| <tt>FarmHouseFurniture [{{t|furniture ID}} {{t|tile X}} {{t|tile Y}} {{t|rotations}}]+</tt>

+

| <samp>FarmHouseFurniture [{{t|furniture ID}} {{t|tile X}} {{t|tile Y}} {{t|rotations}}]+</samp>

−

| Spawns initial furniture in the farmhouse when creating a new save. If you add multiple furniture to the same tile, the first one will be placed on the ground and the last one will be placed on the first one. This is also required to enable the <tt>FarmHouseWallpaper</tt>, <tt>FarmHouseFlooring</tt>, and <tt>FarmHouseStarterSeedsPosition</tt> properties. You can enable it without spawning any furniture with <tt>FarmHouseFurniture -1 0 0 0</tt>.

+

| Spawns initial furniture in the farmhouse when creating a new save. If you add multiple furniture to the same tile, the first one will be placed on the ground and the last one will be placed on the first one. This is also required to enable the <samp>FarmHouseWallpaper</samp>, <samp>FarmHouseFlooring</samp>, and <samp>FarmHouseStarterSeedsPosition</samp> properties. You can enable it without spawning any furniture with <samp>FarmHouseFurniture -1 0 0 0</samp>.

|-

| farm

−

| <tt>FarmHouseFlooring {{t|flooring id}}</tt>

+

| <samp>FarmHouseFlooring {{t|flooring id}}</samp>

−

| Sets the initial farmhouse floor to the given ID when creating a new save. These are mapped to the 4x4 tile areas in the <tt>Maps/walls_and_floors</tt> tilesheet starting at tile index 336 (where index 0 is mapped to the top-left square). This is only enabled if <tt>FarmHouseFurniture</tt> is set.

+

| Sets the initial farmhouse floor to the given ID when creating a new save. These are mapped to the 4x4 tile areas in the <samp>Maps/walls_and_floors</samp> tilesheet starting at tile index 336 (where index 0 is mapped to the top-left square). This is only enabled if <samp>FarmHouseFurniture</samp> is set.

|-

| farm

−

| <tt>FarmHouseWallpaper {{t|wallpaper id}}</tt>

+

| <samp>FarmHouseWallpaper {{t|wallpaper id}}</samp>

−

| Sets the initial farmhouse wallpaper to the given ID when creating a new save. These are mapped to the 1x4 tile areas in the <tt>Maps/walls_and_floors</tt> tilesheet starting from the top-left. This is only enabled if <tt>FarmHouseFurniture</tt> is set.

+

| Sets the initial farmhouse wallpaper to the given ID when creating a new save. These are mapped to the 1x4 tile areas in the <samp>Maps/walls_and_floors</samp> tilesheet starting from the top-left. This is only enabled if <samp>FarmHouseFurniture</samp> is set.

|-

| farm

−

| <tt>FarmHouseStarterSeedsPosition {{t|tile X}} {{t|tile Y}}</tt>

+

| <samp>FarmHouseStarterSeedsPosition {{t|tile X}} {{t|tile Y}}</samp>

−

| Sets the tile position in the farmhouse where the seed package is placed when creating a new save. This is only enabled if <tt>FarmHouseFurniture</tt> is set.

+

| Sets the tile position in the farmhouse where the seed package is placed when creating a new save. This is only enabled if <samp>FarmHouseFurniture</samp> is set.

|-

| farm

−

| <tt>FarmOceanCrabPotOverride T</tt>

+

| <samp>FarmOceanCrabPotOverride T</samp>

| Causes crab pots on the farm should catch ocean fish.

|-

| farm

−

| <tt>SpawnBeachFarmForage T</tt>

+

| <samp>SpawnBeachFarmForage T</samp>

−

| Randomly spawns beach forage and [[Supply Crate|supply crates]] on the farm (like the [[Farm Maps|vanilla beach farm]]). Forage and crates will only appear on tiles which have the <tt>BeachSpawn T</tt> property on the <tt>Back</tt> layer, are clear for placement, and don't have a tile on the <tt>AlwaysFront</tt> layer.

+

| Randomly spawns beach forage and [[Supply Crate|supply crates]] on the farm (like the [[Farm Maps|vanilla beach farm]]). Forage and crates will only appear on tiles which have the <samp>BeachSpawn T</samp> property on the <samp>Back</samp> layer, are clear for placement, and don't have a tile on the <samp>AlwaysFront</samp> layer.

|-

| farm

−

| <tt>SpawnForestFarmForage T</tt>

+

| <samp>SpawnForestFarmForage T</samp>

−

| Randomly spawns forest forage on the farm (like the [[Farm Maps|vanilla forest farm]]). Forage will only spawn on tiles which have the <tt>Type Grass</tt> tile property, are clear for placement, and don't have a tile on the <tt>AlwaysFront</tt> layer.

+

| Randomly spawns forest forage on the farm (like the [[Farm Maps|vanilla forest farm]]). Forage will only spawn on tiles which have the <samp>Type Grass</samp> tile property, are clear for placement, and don't have a tile on the <samp>AlwaysFront</samp> layer.

|-

| farm

−

| <tt>SpawnMountainFarmOreRect {{t|tile X}} {{t|tile Y}} {{t|tile width}} {{t|tile height}}</tt>

+

| <samp>SpawnMountainFarmOreRect {{t|tile X}} {{t|tile Y}} {{t|tile width}} {{t|tile height}}</samp>

−

| The tile area on the farm map where ores should randomly spawn (like the [[Farm Maps|vanilla hilltop farm]]). Ores will only spawn on tiles which have the <tt>Type Dirt</tt> tile property and are clear for object placement.

+

| The tile area on the farm map where ores should randomly spawn (like the [[Farm Maps|vanilla hilltop farm]]). Ores will only spawn on tiles which have the <samp>Type Dirt</samp> tile property and are clear for object placement.

|-

| farmhouse

−

| <tt>EntryLocation {{t|tile X}} {{t|tile Y}}</tt>

+

| <samp>EntryLocation {{t|tile X}} {{t|tile Y}}</samp>

| Sets the tile on which the player appears when they warp into the farmhouse.

|}

Line 732: Line 732:

! effect

|-

−

| <tt>Back</tt>

+

| <samp>Back</samp>

−

| <tt>TouchAction Warp {{t|area}} {{t|x}} {{t|y}} {{o|string prerequisite}}</tt>

+

| <samp>TouchAction Warp {{t|area}} {{t|x}} {{t|y}} {{o|string prerequisite}}</samp>

−

| Adds a player-only warp on the tile to the specified location name and position. This is exactly equivalent to <tt>TouchAction MagicWarp</tt>, but without the magic sound/visual effect.

+

| Adds a player-only warp on the tile to the specified location name and position. This is exactly equivalent to <samp>TouchAction MagicWarp</samp>, but without the magic sound/visual effect.

|}

Line 744: Line 744:

! effect

|-

−

| <tt>Back</tt>

+

| <samp>Back</samp>

−

| <tt>Water</tt>

+

| <samp>Water</samp>

−

| Setting the value to <tt>I</tt> (uppercase i) will make the tile behave like normal water, but won't render the water animation overlay for it.

+

| Setting the value to <samp>I</samp> (uppercase i) will make the tile behave like normal water, but won't render the water animation overlay for it.

|}

Line 754: Line 754:

Specifically:

<ul>

−

<li>Items with the "<tt>propose_roommate_{{t|NPC name}}</tt>" [[Modding:Context tags|context tag]] will trigger a roommate proposal when given to the named NPC. The NPC name must be lowercase with underscores instead of spaces (e.g. <tt>propose_roommate_dwarf</tt>).</li>

+

<li>Items with the "<samp>propose_roommate_{{t|NPC name}}</samp>" [[Modding:Context tags|context tag]] will trigger a roommate proposal when given to the named NPC. The NPC name must be lowercase with underscores instead of spaces (e.g. <samp>propose_roommate_dwarf</samp>).</li>

<li>These [[Modding:Dialogue|dialogue keys]] apply before they move in:

{| class="wikitable"

Line 762: Line 762:

! effect

|-

−

| <tt>Strings/StringsFromCSFiles</tt>

+

| <samp>Strings/StringsFromCSFiles</samp>

−

| <tt>{{t|NPC name}}_EngagedRoommate</tt>

+

| <samp>{{t|NPC name}}_EngagedRoommate</samp>

−

| The NPC's roommate proposal accept dialogue. ⚠ Ignored if you don't specify <tt>Data/EngagementDialogue:{{t|NPC name}}Roommate0</tt>. For example: ''A Void Ghost pendant! How did you...?$3#$b#Oh, wow.$7#$b#@... yes, I'll come live with you, if you like. But we have to keep it secret from everyone.#$b#I'll be at your house in a few days... okay?$h''

+

| The NPC's roommate proposal accept dialogue. ⚠ Ignored if you don't specify <samp>Data/EngagementDialogue:{{t|NPC name}}Roommate0</samp>. For example: ''A Void Ghost pendant! How did you...?$3#$b#Oh, wow.$7#$b#@... yes, I'll come live with you, if you like. But we have to keep it secret from everyone.#$b#I'll be at your house in a few days... okay?$h''

|-

−

| <tt>Strings/Characters</tt>

+

| <samp>Strings/Characters</samp>

−

| <tt>MovieInvite_NoTheater</tt>

+

| <samp>MovieInvite_NoTheater</samp>

| The NPC's roommate proposal rejection text when you don't meet the requirements (i.e. min friendship + house upgrade level, and not already having a roommate/spouse). This is the same dialogue used when you can't invite someone to the movies.

|-

−

| <tt>Data/EngagementDialogue</tt>

+

| <samp>Data/EngagementDialogue</samp>

−

| <tt>{{t|NPC name}}Roommate0</tt> <tt>{{t|NPC name}}Roommate1</tt>

+

| <samp>{{t|NPC name}}Roommate0</samp> <samp>{{t|NPC name}}Roommate1</samp>

−

| The NPC's normal dialogue after accepting the proposal, but before moving in. The <tt>Roommate0</tt> variant is always used on the day the NPC accepted; on subsequent days the NPC randomly chooses <tt>Roommate0</tt> or <tt>Roommate1</tt>. If the <tt>Roommate0</tt> variant isn't defined, the NPC will use the normal <tt>{{t|NPC Name}}0</tt> and <tt>{{t|NPC Name}}1</tt> keys. If the <tt>Roommate0</tt> variant is defined, <tt>Roommate1</tt> must be set too to avoid errors. For example: ''@... I'm afraid we'll have to keep this a secret... Neither my people nor yours would accept us living together.''

+

| The NPC's normal dialogue after accepting the proposal, but before moving in. The <samp>Roommate0</samp> variant is always used on the day the NPC accepted; on subsequent days the NPC randomly chooses <samp>Roommate0</samp> or <samp>Roommate1</samp>. If the <samp>Roommate0</samp> variant isn't defined, the NPC will use the normal <samp>{{t|NPC Name}}0</samp> and <samp>{{t|NPC Name}}1</samp> keys. If the <samp>Roommate0</samp> variant is defined, <samp>Roommate1</samp> must be set too to avoid errors. For example: ''@... I'm afraid we'll have to keep this a secret... Neither my people nor yours would accept us living together.''

|}

Line 782: Line 782:

! effect

|-

−

| <tt>Characters/Dialogue/MarriageDialogue{{t|NPC name}}Roommate</tt>

+

| <samp>Characters/Dialogue/MarriageDialogue{{t|NPC name}}Roommate</samp>

| ''all keys''

−

| Equivalent to <tt>Characters/Dialogue/MarriageDialogue{{t|NPC name}}</tt>, but only applies if the NPC is a roommate. If the file exists, it completely replaces the spouse version; otherwise the game defaults to the spouse version.

+

| Equivalent to <samp>Characters/Dialogue/MarriageDialogue{{t|NPC name}}</samp>, but only applies if the NPC is a roommate. If the file exists, it completely replaces the spouse version; otherwise the game defaults to the spouse version.

|-

−

| <tt>Characters/Dialogue/MarriageDialogue</tt>

+

| <samp>Characters/Dialogue/MarriageDialogue</samp>

−

| <tt>*Roommate</tt>

+

| <samp>*Roommate</samp>

−

| Keys with the <tt>Roommate</tt> suffix take priority if they exist (only in this file, not the <tt>MarriageDialogue{{t|NPC name}}</tt> files).

+

| Keys with the <samp>Roommate</samp> suffix take priority if they exist (only in this file, not the <samp>MarriageDialogue{{t|NPC name}}</samp> files).

|-

−

| <tt>Data/Festivals/*</tt>

+

| <samp>Data/Festivals/*</samp>

−

| <tt>{{t|NPC name}}_roommate</tt>

+

| <samp>{{t|NPC name}}_roommate</samp>

−

| The NPC's normal dialogue at the festival if they're a roommate. If the key isn't defined, they'll use <tt>{{t|NPC name}}_spouse</tt> instead.

+

| The NPC's normal dialogue at the festival if they're a roommate. If the key isn't defined, they'll use <samp>{{t|NPC name}}_spouse</samp> instead.

|}

Line 802: Line 802:

! effect

|-

−

| <tt>Characters/Dialogue/*</tt>

+

| <samp>Characters/Dialogue/*</samp>

−

| <tt>*_roommate_*</tt>

+

| <samp>*_roommate_*</samp>

−

| Equivalent to the <tt>*_inlaw_*</tt> infix in [[Modding:Dialogue#Generic dialogue|generic dialogue]], used if you're a roommate with the NPC. If not defined, the game will fallback to the non-infixed dialogue (it won't use the <tt>*_inlaw_*</tt> variant).

+

| Equivalent to the <samp>*_inlaw_*</samp> infix in [[Modding:Dialogue#Generic dialogue|generic dialogue]], used if you're a roommate with the NPC. If not defined, the game will fallback to the non-infixed dialogue (it won't use the <samp>*_inlaw_*</samp> variant).

|}</li>

<li>Roommates will sleep in a [[Single Bed]] if one is available and unused in the house; otherwise they'll use a double bed like a normal spouse. (Krobus is an exception, since he doesn't sleep in a bed.)</li>

−

<li>Added [[Modding:Event data#Event preconditions|event preconditions]] to check whether the local player has a roommate (<tt>R</tt>) or doesn't have a roommate (<tt>Rf</tt>). This can be combined with <tt>O {{t|NPC name}}</tt> to check for a specific roommate, like <tt>R/O Abigail</tt>.</li>

+

<li>Added [[Modding:Event data#Event preconditions|event preconditions]] to check whether the local player has a roommate (<samp>R</samp>) or doesn't have a roommate (<samp>Rf</samp>). This can be combined with <samp>O {{t|NPC name}}</samp> to check for a specific roommate, like <samp>R/O Abigail</samp>.</li>

</ul>

===Custom mail formatting===

−

You can now customize [[Modding:Mail data|mail]] and [[Secret Notes|secret notes]] by including three custom commands in the letter text (including the <tt>[]</tt> characters):

+

You can now customize [[Modding:Mail data|mail]] and [[Secret Notes|secret notes]] by including three custom commands in the letter text (including the <samp>[]</samp> characters):

{| class="wikitable"

|-

Line 817: Line 817:

! effect

|-

−

| <tt>[letterbg {{t|index}}]</tt>

+

| <samp>[letterbg {{t|index}}]</samp>

−

| Changes the default letter background to a vanilla background from <tt>LooseSprites/letterBG</tt>. The index can be 0 (default letter), 1 (Sandy's lined paper), 2 (Wizard style), or 3 (Krobus style). This will also set the default text color for that style, unless overridden by <tt>textcolor</tt>.

+

| Changes the default letter background to a vanilla background from <samp>LooseSprites/letterBG</samp>. The index can be 0 (default letter), 1 (Sandy's lined paper), 2 (Wizard style), or 3 (Krobus style). This will also set the default text color for that style, unless overridden by <samp>textcolor</samp>.

|-

−

| <tt>[letterbg {{t|asset name}} {{t|index}}]</tt>

+

| <samp>[letterbg {{t|asset name}} {{t|index}}]</samp>

| Changes the default letter background to the given texture. The asset name should match a texture containing two rows: one with 320x180 pixel letter background images, and one with 24x24 pixel button backgrounds shown behind attached items. The index is the sprite to use from those rows, starting at 0 for the first one.

|-

−

| <tt>[textcolor {{t|color}}]</tt>

+

| <samp>[textcolor {{t|color}}]</samp>

−

| Changes the letter text color. The valid colors are <tt>black</tt>, <tt>blue</tt>, <tt>cyan</tt>, <tt>gray</tt>, <tt>green</tt>, <tt>orange</tt>, <tt>purple</tt>, <tt>red</tt>, and <tt>white</tt>.

+

| Changes the letter text color. The valid colors are <samp>black</samp>, <samp>blue</samp>, <samp>cyan</samp>, <samp>gray</samp>, <samp>green</samp>, <samp>orange</samp>, <samp>purple</samp>, <samp>red</samp>, and <samp>white</samp>.

|}

Line 835: Line 835:

! effect

|-

−

| <tt>crow_scare</tt>

+

| <samp>crow_scare</samp>

| Sets the item as a placeable scarecrow. If not set, the item is considered a scarecrow if its default name contains the substring <code>arecrow</code> (like before).

|-

−

| <tt>crow_scare_radius_{{t|radius}}</tt>

+

| <samp>crow_scare_radius_{{t|radius}}</samp>

| If the item is a scarecrow, sets the radius that it covers. If not set, the scarecrow defaults to 17 if the default name contains the substring <code>Deluxe</code> and 9 otherwise.

|}

===Improved map seats===

−

When defining map seats via <tt>Data\ChairTiles</tt> (see [[Modding:Migrate to Stardew Valley 1.5#Sitting on non-furniture chairs|docs in the 1.5 migration guide]]), you can now set the type field to <tt>custom {{t|offset_x}} {{t|offset_y}} {{t|extra_height}}</tt> to override the hardcoded offset and height values in code. The three values are measured in tiles (e.g. an X offset value of 0.5 would shift the sitting location by half a tile).

+

When defining map seats via <samp>Data\ChairTiles</samp> (see [[Modding:Migrate to Stardew Valley 1.5#Sitting on non-furniture chairs|docs in the 1.5 migration guide]]), you can now set the type field to <samp>custom {{t|offset_x}} {{t|offset_y}} {{t|extra_height}}</samp> to override the hardcoded offset and height values in code. The three values are measured in tiles (e.g. an X offset value of 0.5 would shift the sitting location by half a tile).

==See also==

Margotbean

Interface administrators, patroller, Suppressors, Administrators, translators

105,662

edits

Changes

Modding:Migrate to Stardew Valley 1.5.5 (view source)

Revision as of 18:48, 4 November 2021

Navigation menu

Search