User:Pathoschild/Modding wishlist - Revision history

imported>Pathoschild: /* Medium changes */ move consistent display name usage to done

2022-12-04T03:19:13Z

Medium changes: move consistent display name usage to done

← Older revision		Revision as of 03:19, 4 December 2022
Line 10:		Line 10:
	===Medium changes===		===Medium changes===
	* ☐ Add map property for default warp location (e.g. <samp>Utility.getDefaultWarpLocation</samp>).		* ☐ Add map property for default warp location (e.g. <samp>Utility.getDefaultWarpLocation</samp>).
	* ☐ 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:
	** ☐ <samp>Data\Bundles</samp>
	* ☐ Remove hardcoded logic that ignores display names when playing in English (e.g. for NPC gift taste dialogues); can search <code>LocalizedContentManager.LanguageCode.en</code> to find many of them. That causes a bug where renamed NPCs still show their internal name in some places.

	===Refactoring===		===Refactoring===

imported>Pathoschild: /* Small changes */ move public class change to done

2022-12-04T03:17:30Z

Small changes: move public class change to done

← Older revision		Revision as of 03:17, 4 December 2022
Line 6:		Line 6:

	===Small changes===		===Small changes===
	* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.		''All done!''

	===Medium changes===		===Medium changes===

imported>Pathoschild: /* Small changes */ move virtual Background methods to done

2022-12-04T03:12:30Z

Small changes: move virtual Background methods to done

@@ Line 7: / Line 7: @@
 ===Small changes===
 * ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.
 ===Medium changes===

imported>Pathoschild: /* Small changes */ move parallax horizon sunset change to done

2022-11-19T19:49:27Z

Small changes: move parallax horizon sunset change to done

← Older revision		Revision as of 19:49, 19 November 2022
Line 8:		Line 8:
	* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.		* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.
	<ul>		<ul>
	~~<li>☐ Change the logic in <samp>IslandLocation.DrawParallaxHorizon</samp> to support custom sunset times that aren't on the hour. Specifically:~~
	~~<syntaxhighlight lang="c#">~~
	~~// before~~
	float day_night_transition = Utility.ConvertTimeToMinutes(Game1.timeOfDay + (int)((float)Game1.gameTimeInterval / 7000f * 10f % 10f) - Game1.getStartingToGetDarkTime()) / (float)Utility.ConvertTimeToMinutes(Game1.getTrulyDarkTime() - Game1.getStartingToGetDarkTime());

	~~// after~~
	float day_night_transition = Utility.CalculateMinutesBetweenTimes(Game1.getStartingToGetDarkTime(), (Game1.timeOfDay + (int)(Game1.gameTimeInterval / 7000f * 10f % 10f))) / (float)Utility.CalculateMinutesBetweenTimes(Game1.getStartingToGetDarkTime(), Game1.getTrulyDarkTime());
	~~</syntaxhighlight></li>~~
	<li>☐ Make methods virtual:		<li>☐ Make methods virtual:
	{\| class="wikitable"		{\| class="wikitable"

imported>Pathoschild: /* Refactoring */ move some to completed in 1.6

2022-02-12T23:37:00Z

Refactoring: move some to completed in 1.6

← Older revision		Revision as of 23:37, 12 February 2022
Line 34:		Line 34:

	===Refactoring===		===Refactoring===
	* ☐ Add unique item keys and allow custom spritesheets per item. This would eliminate the current complexities with adding custom items to Stardew Valley, make code much more readable, simplify troubleshooting mod errors, and make it possible to support any item type in cases like sending mail. See the [https://gist.github.com/Pathoschild/92d1fcb7c2ffeb7e1461c242cdb025e2 detailed proposal doc].
	* ☐ Change all <code>const</code> fields to <code>static readonly</code>. 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.		* ☐ Change all <code>const</code> fields to <code>static readonly</code>. 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.
	* ☐ Move shop inventories into a data asset so mods can easily change them (e.g. <code>"<shop id>": "item_id quantity_available [required_mail_flag]/..."</code>).

	==Completed items==		==Completed items==

imported>Pathoschild: /* Medium changes */ move some to completed in 1.6

2022-02-12T23:34:53Z

Medium changes: move some to completed in 1.6

← Older revision		Revision as of 23:34, 12 February 2022
Line 31:		Line 31:
	* ☐ 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:		* ☐ 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:
	** ☐ <samp>Data\Bundles</samp>		** ☐ <samp>Data\Bundles</samp>
	** ☐ <samp>Data\CraftingRecipes</samp>
	** ☐ <samp>Data\CookingRecipes</samp>
	** ☐ <samp>Data\Weapons</samp>
	* ☐ Remove hardcoded logic that ignores display names when playing in English (e.g. for NPC gift taste dialogues); can search <code>LocalizedContentManager.LanguageCode.en</code> to find many of them. That causes a bug where renamed NPCs still show their internal name in some places.		* ☐ Remove hardcoded logic that ignores display names when playing in English (e.g. for NPC gift taste dialogues); can search <code>LocalizedContentManager.LanguageCode.en</code> to find many of them. That causes a bug where renamed NPCs still show their internal name in some places.

imported>Pathoschild: /* Small changes */ + support mod sunset times in island parallax rendering

2022-01-13T05:58:43Z

Small changes: + support mod sunset times in island parallax rendering

← Older revision		Revision as of 05:58, 13 January 2022
Line 7:		Line 7:
	===Small changes===		===Small changes===
	* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.		* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.
			<ul>
			<li>☐ Change the logic in <samp>IslandLocation.DrawParallaxHorizon</samp> to support custom sunset times that aren't on the hour. Specifically:
			<syntaxhighlight lang="c#">
			// before
			float day_night_transition = Utility.ConvertTimeToMinutes(Game1.timeOfDay + (int)((float)Game1.gameTimeInterval / 7000f * 10f % 10f) - Game1.getStartingToGetDarkTime()) / (float)Utility.ConvertTimeToMinutes(Game1.getTrulyDarkTime() - Game1.getStartingToGetDarkTime());

			// after
			float day_night_transition = Utility.CalculateMinutesBetweenTimes(Game1.getStartingToGetDarkTime(), (Game1.timeOfDay + (int)(Game1.gameTimeInterval / 7000f * 10f % 10f))) / (float)Utility.CalculateMinutesBetweenTimes(Game1.getStartingToGetDarkTime(), Game1.getTrulyDarkTime());
			</syntaxhighlight></li>
	<li>☐ Make methods virtual:		<li>☐ Make methods virtual:
	{\| class="wikitable"		{\| class="wikitable"
Line 16:		Line 25:
	\| <samp>draw</samp>, <samp>update</samp>		\| <samp>draw</samp>, <samp>update</samp>
	\|}</li>		\|}</li>
			</ul>

	===Medium changes===		===Medium changes===

imported>Pathoschild: /* Refactoring */ + un-hardcode shops

2021-12-22T02:18:31Z

Refactoring: + un-hardcode shops

← Older revision		Revision as of 02:18, 22 December 2021
Line 29:		Line 29:
	* ☐ Add unique item keys and allow custom spritesheets per item. This would eliminate the current complexities with adding custom items to Stardew Valley, make code much more readable, simplify troubleshooting mod errors, and make it possible to support any item type in cases like sending mail. See the [https://gist.github.com/Pathoschild/92d1fcb7c2ffeb7e1461c242cdb025e2 detailed proposal doc].		* ☐ Add unique item keys and allow custom spritesheets per item. This would eliminate the current complexities with adding custom items to Stardew Valley, make code much more readable, simplify troubleshooting mod errors, and make it possible to support any item type in cases like sending mail. See the [https://gist.github.com/Pathoschild/92d1fcb7c2ffeb7e1461c242cdb025e2 detailed proposal doc].
	* ☐ Change all <code>const</code> fields to <code>static readonly</code>. 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.		* ☐ Change all <code>const</code> fields to <code>static readonly</code>. 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.
			* ☐ Move shop inventories into a data asset so mods can easily change them (e.g. <code>"<shop id>": "item_id quantity_available [required_mail_flag]/..."</code>).

	==Completed items==		==Completed items==

imported>Pathoschild: /* Medium changes */ + warp property for default warp location

2021-12-11T01:03:42Z

Medium changes: + warp property for default warp location

← Older revision		Revision as of 01:03, 11 December 2021
Line 18:		Line 18:

	===Medium changes===		===Medium changes===
			* ☐ Add map property for default warp location (e.g. <samp>Utility.getDefaultWarpLocation</samp>).
	* ☐ 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:		* ☐ 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:
	** ☐ <samp>Data\Bundles</samp>		** ☐ <samp>Data\Bundles</samp>

imported>Pathoschild: /* Small changes */ +2 virtual methods

2021-12-11T00:39:25Z

Small changes: +2 virtual methods

← Older revision		Revision as of 00:39, 11 December 2021
Line 7:		Line 7:
	===Small changes===		===Small changes===
	* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.		* ☐ Change all remaining <code>internal class</code> and <code>private class</code> to <code>public class</code> to simplify mod access.
			<li>☐ Make methods virtual:
			{\| class="wikitable"
			\|-
			! class
			! methods
			\|-
			\| <samp>Background</samp>
			\| <samp>draw</samp>, <samp>update</samp>
			\|}</li>

	===Medium changes===		===Medium changes===