feat(closes #491): Winemaking

[jeremyckahn]

What this PR does

For #491, this PR implements Winemaking. Wine works similarly to fermented crop recipes: Once the player purchases a cellar, they can combine Yeast and Grapes to produce a Wine keg. Wine kegs compound in value but top out at 100 days after maturity. Unlike fermented crops, wines do not spoil.

This PR also changes how Bread-related recipes work. Previously, Wheat could be made directly into Bread. Now, Wheat must be made into Flour which can then be made into Bread. This was changed to allow Flour to be made into Yeast, which is a new ingredient of Bread but also Wine. This has the downstream effect of raising the value of all Bread-derived recipes.

This PR also makes a few small tweaks throughout the UX. Specifically, the Items Sold list under Farm Stats is ordered alphabetically by name, and the Quantity Input UX has been improved to work more consistently.

This PR also updates and improves various type annotations throughout the project.

How this change can be validated

I recommend modifying the game state to give yourself a lot of money, grape items, and wheat. Here's a save file that can be used to get a head start.

• Validate that Wheat can be made into Flour
• Validate that Flour can be made into Yeast
• Validate that Flour and Yeast can be made into Bread
• Validate that the "Winemaking" tab appears on the Cellar screen after a Cellar is purchased
• Validate that various wines can be created according to their indicated ingredient requirements (different wines require different amounts of Yeast, but always 50 of their respective grape)
• Validate that wines take several days to mature (different wines take different amounts of time)
• Validate that wine kegs in the Cellar increase in value for up to 100 days and then stop
• Validate that wine kegs do not spoil
• Validate the wine kegs can be sold (each wine has a different value)

Additional information

This is just the first iteration of this feature and I'm sure it will be improved and expanded over time.

This PR introduces a lot of commented-out wine recipes. These will be enabled in a future update.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
farmhand	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 9, 2024 3:17pm

[lstebner]

thanks for the stub savestate, it was quite helpful. i ended up with just a few comments and i wouldn't consider any required to change so i'll go ahead and approve as well. this is a huge feature so i also want to say nice work!

[lstebner]

should we also (or maybe instead?) update the workshop to filter out recipeType === recipeType.WINE recipes?

[jeremyckahn]

It doesn't seem that the additional filtering logic would change the behavior caused by this, and I don't think it's worth introducing code that isn't necessary.

Taking the filtering approach in the Workshop rendering logic would also be good solution, but condition is a required property of farmhand.recipe, so I figure we might at well use it to solve this specific problem (even if it's a bit of an unusual use of the mechanism):

farmhand/src/index.js

Lines 158 to 165 in cc2b3c0

	/**
	* @typedef {farmhand.item & {
	* recipeType: recipeType, // The type of recipe of recipe this is.
	* ingredients: Record<string, number>, // An object where each key is the id of a farmhand.item and the value is the quantity of that item.
	* condition: farmhand.recipeCondition, // This must return `true` for the recipe to be made available to the player.
	* }} farmhand.recipe
	* @readonly
	*/

[jeremyckahn]

Thanks for the excellent review, @lstebner! I think the code is in much better shape with your suggestions. I'll merge and ship this!

[jeremyckahn]

It doesn't seem that the additional filtering logic would change the behavior caused by this, and I don't think it's worth introducing code that isn't necessary.

Taking the filtering approach in the Workshop rendering logic would also be good solution, but condition is a required property of farmhand.recipe, so I figure we might at well use it to solve this specific problem (even if it's a bit of an unusual use of the mechanism):

farmhand/src/index.js

Lines 158 to 165 in cc2b3c0

	/**
	* @typedef {farmhand.item & {
	* recipeType: recipeType, // The type of recipe of recipe this is.
	* ingredients: Record<string, number>, // An object where each key is the id of a farmhand.item and the value is the quantity of that item.
	* condition: farmhand.recipeCondition, // This must return `true` for the recipe to be made available to the player.
	* }} farmhand.recipe
	* @readonly
	*/