User:Pathoschild/Modding wishlist

A list of requested changes in the game code to support modders. This list does not include complex refactoring or rewriting, which is unlikely to be accepted.

Wishlist

Bug fixes

• ☐ Object.getOne doesn't copy the owner field, so it's not set correctly for most placed items.
• ☐ TrashBear.updateItemWanted is hardcoded to assume Data\CookingRecipes field 2 is an item ID, but it can actually be an item ID and count like 272 5 (e.g. see CraftingRecipe constructor). That means it crashes if it randomly chooses a recipe with multiple outputs.

Small changes

• ☐ Add a Data/LocationNames asset or Data/Festivals/* field instead of hardcoding specific festival location names in performTenMinuteClockUpdate (search for Game1.cs.2634).
• ☐ Change all remaining internal class and private class to public class to simplify mod access.
• ☐ Remove unused BloomComponent, BloomSettings, and all code which references them (this is broken and never enabled).

Medium changes

• ☐ Some XNB files have a separate display name field, but only in non-English. Using display names consistently regardless of language would let mods rename things without breaking keys:
  • ☐ Data\Bundles
  • ☐ Data\CraftingRecipes
  • ☐ Data\CookingRecipes
  • ☐ Data\Weapons
• ☐ Remove hardcoded logic that ignores display names when playing in English (e.g. for NPC gift taste dialogues); can search LocalizedContentManager.LanguageCode.en to find many of them. That causes a bug where renamed NPCs still show their internal name in some places.
• ☐ Get the spouse room offset from Data/NPCDispositions, instead of hardcoding it in FarmHouse.loadSpouseRoom.
• ☐ Call Game1.hooks.OnGameLocation_CheckAction from overridden checkAction methods too, not only the base one.

Refactoring

• ☐ Replace Item.ParentSheetIndex with three properties:

  field	type	notes
  ID	string	An ID unique across all item types (like parsnip or radish_salad). That would allow unambiguous and human-readable item references throughout the code (e.g. gift tastes, machine behaviour, etc), fix bugs like the wallpaper glitch, and make it easy to avoid ID collisions in mods (e.g. spacechase0.JsonAssets/watermelon).
  Sheet	Texture2D	The spritesheet to draw (e.g. Game1.objectSpriteSheet). This lets modders easily add custom items with their own spritesheet, and simplifies draw logic.
  SheetIndex	int	Equivalent to the old ParentSheetIndex, but for the Sheet texture. No longer used as an ID.

  Files like Data/ObjectInformation would be updated to use the new IDs:

  # old format
  634: "Apricot/50/15/Basic -79/Apricot/A tender little fruit with a rock-hard pit."
  629: "Apricot Sapling/500/-300/Basic -74/Apricot Sapling/Takes 28 days to produce a mature Apricot tree. Bears fruit in the spring. Only grows if the 8 surrounding \"tiles\" are empty."
  
  # new format
  apricot: "634/Apricot/50/15/Basic -79/A tender little fruit with a rock-hard pit."
  apricot_sapling: "629/Apricot Sapling/500/-300/Basic -74/Takes 28 days to produce a mature Apricot tree. Bears fruit in the spring. Only grows if the 8 surrounding \"tiles\" are empty."
  

  With equivalent changes in files like Data/NPCGiftTastes:

  # old format
  Universal_Like: "-2 -7 -26 -75 -80 72 395 613 634 635 636 637 638 724 459"
  
  # new format
  Universal_Like: "-2 -7 -26 -75 -80 apple apricot cherry coffee maple_syrup mead orange peach pomegranate shrimp"
  

  Creating a vanilla item would use a key lookup like before:

  Object item = new Object("apricot"); // equivalent to new Object("apricot", "Maps/springobjects", 634, ...);
  

  This also avoids needing to check item types in most code (e.g. no need to exclude bigcraftables in gift tastes, since there's no possible ID overlap with the IDs listed in Data/NPCGiftTastes).

• ☐ Change all const fields to static readonly. They're accessed the same way and the performance difference is negligible, but that'll make the decompiled code much easier to understand, and avoid issues where const values get 'baked in' to mod assemblies.

Completed items

See the list of items completed in previous game versions.