feat: add weeds and compost #311

lstebner · 2022-07-17T06:48:40Z

note: this is a work in progress. the art is especially mediocre at this point but it's mostly working haha

What this PR does

add "weeds" and "compost"

weeds grow randomly overnight in unoccupied plots. they're worth very little but can be sold
weeds can be harvested and turned into compost through crafting
compost acts like fertilizer

How this change can be validated

Questions or concerns about this change

Additional information

- weeds grow randomly overnight in unoccupied plots - weeds can be turned into compost through crafting - compost acts like fertilizer

vercel · 2022-07-17T06:48:43Z

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

Name	Status	Preview	Updated
farmhand	✅ Ready (Inspect)	Visit Preview	Jul 21, 2022 at 2:41PM (UTC)

jeremyckahn · 2022-07-17T15:48:14Z

This is very cool! I love the idea. I know you're still working on this so I won't dig into the code yet. I've got some initial play testing feedback (some of which you probably have in mind already):

Weeds shouldn't be considered crops. I think it makes sense for weeds to just be a farmhand.plotContent, and not a farmhand.crop:

farmhand/src/index.js

Lines 37 to 44 in a0384fd

    
           /** 
        
            * This is a minimalist base type to be inherited and expanded on by types like 
        
            * farmhand.crop. This also represents non-crop plot content like scarecrows 
        
            * and sprinklers. 
        
            * @typedef farmhand.plotContent 
        
            * @type {Object} 
        
            * @property {string} itemId 
        
            */

As part of this, pulling weeds shouldn't trigger the harvest-crop achievement:

farmhand/src/data/achievements.js

Lines 62 to 69 in a0384fd

    
           ((reward = 200) => ({ 
        
             id: 'harvest-crop', 
        
             name: 'Harvest a Crop', 
        
             description: 'Harvest a crop that you planted.', 
        
             rewardDescription: dollarString(reward), 
        
             condition: state => sumOfCropsHarvested(state.cropsHarvested) >= 1, 
        
             reward: state => addMoney(state, reward), 
        
           }))(),

It might make sense to start new games with some weeds in the field.
Crows shouldn't eat weeds.
Weeds shouldn't have fluctuating prices. I think they should be sell-able for something like a stable $0.10.
Perhaps instead of being directly plantable in the field, perhaps Compost should be an ingredient for a Fertilizer recipe?

- added purchaseable composter - weeds are no longer considered crops - lower value on weeds - added itemType 'WEEDS' - refactored harvestPlot a bit to make it easier to understand for weeds vs crops

…cipes

jeremyckahn

Awesome work so far! We've already talked about a few things here on Discord, but I wanted to get it all in once place here on the PR. Hopefully none of my suggestions are too onerous to deal with.

The art looks great to me!

jeremyckahn · 2022-07-17T23:45:45Z

src/enums.js

+  'NONE',
+  'STANDARD',
+  'RAINBOW',
+  'COMPOST',


Would it make sense to drop the COMPOST fertilizer type and instead craft STANDARD fertilizer with pulled weeds? I'm thinking that would be simplify the implementation and perhaps be a little more straightforward for players too.

src/constants.js

jeremyckahn · 2022-07-18T01:15:53Z

src/data/items.js

+  type: WEEDS,
+})
+
+export { weeds }


Totally not a big deal, but if you have to go back in here it might be worth exporting the weeds variable directly from its definition above to keep consistent with other item definitions.

jeremyckahn · 2022-07-18T01:16:13Z

src/data/items.js

+const weeds = freeze({
+  id: 'weeds',
+  name: 'Weeds',


What do you think about changing these terms to be be singular rather than plural, to be consistent with the other items? So, weed/Weed instead of weeds/Weeds.

jeremyckahn · 2022-07-18T01:34:59Z

src/utils.js

 export const getPlotImage = plotContent => {
  if (plotContent) {
    if (getPlotContentType(plotContent) === itemType.CROP) {
+      console.log(getCropLifeStage(plotContent), getCropId(plotContent))


Reminder to drop this before merging. 🎗️

src/game-logic/reducers/spawnWeeds.js

jeremyckahn · 2022-07-18T02:27:21Z

src/enums.js

  'TOMATO',
  'WATERMELON',
  'WHEAT',
+  'WEEDS',


What do you think about switching from plural "weeds" semantics to singular ("weed") for both the cropType here and the itemType below in order to remain consistent with the other cropType and itemType semantics?

jeremyckahn · 2022-07-18T02:29:34Z

src/enums.js

+  'NONE',
+  'STANDARD',
+  'RAINBOW',
+  'COMPOST',


If we drop the mechanic of using compost as fertilizer directly, I think we can drop this addition.

jeremyckahn · 2022-07-18T02:30:36Z

src/components/Plot/Plot.js


-  if (plotContent.fertilizerType === fertilizerType.STANDARD) {
+  if (
+    [fertilizerType.STANDARD, fertilizerType.COMPOST].includes(


If we drop fertilizerType.COMPOST, we can revert this change.

src/components/Inventory/Inventory.js

… into new Recycling area of workshop

…ngredients, and consider weeds ripe so they are highlighted when using scythe

lstebner · 2022-07-18T04:32:42Z

thank you for the excellent and thorough review @jeremyckahn ! you had a ton of great suggestions and I believe I made them all (except one that I responded to). i also made an additional change to support multiple images for weeds and changed the graphic in general so make sure you give that code a look and let me know if it's ok or there's a better way to do it. after playing a bit i actually kinda like the compost image, but am open to modifying it if you have ideas.

Co-authored-by: Jeremy Kahn <[email protected]>

jeremyckahn · 2022-07-19T14:44:15Z

I found a separate issue that may also be related to shoveling:

To reproduce this issue, load crashing-farmhand-data.zip, go to the Field, select the Hoe, and click on the field. This may or may not be related to shoveling some days prior, but I haven't been able to debug much yet.

jeremyckahn · 2022-07-20T14:10:51Z

99fdcaa seems to be addressing the weed animation issue! Nice work on that. I'm still able to reproduce the crashing issue, but that seems like the last remaining bug.

jeremyckahn · 2022-07-20T14:32:52Z

I'm still able to reproduce the crashing issue, but that seems like the last remaining bug.

This should be fixed in 760bcb4! Please review and make sure it's working correctly for you.

I noticed some tests are failing due to 99fdcaa, so we'll just need to determine whether these are legitimate breakages or just outdated tests.

lstebner · 2022-07-20T15:51:02Z

This should be fixed in 760bcb4! Please review and make sure it's working correctly for you.

thank you! i tested with the save you provided and it doesn't crash anymore 🎉

I noticed some tests are failing due to 99fdcaa, so we'll just need to determine whether these are legitimate breakages or just outdated tests.

these should be fixed now!

jeremyckahn

I found another bug. 😩

Unfortunately the Plot code is a little fragile, as we're seeing now. We are getting close though!

src/utils.js

src/game-logic/reducers/resetWasShoveled.js

jeremyckahn · 2022-07-21T01:08:44Z

src/game-logic/reducers/minePlot.js

  state = modifyFieldPlotAt(state, x, y, () => {
    return {
      isShoveled: true,
+      wasJustShoveled: true,


jeremyckahn · 2022-07-21T02:25:38Z

src/components/Plot/Plot.js

-  useEffect(() => {
-    if (
-      !initialIsShoveledState &&
-      plotContent?.isShoveled &&
-      plotContent?.oreId
-    ) {
-      setWasJustShoveled(true)
-    }
-  }, [initialIsShoveledState, plotContent])


I think I know why this was here now. I found a newly-introduced bug wherein the "mined" animation replays when you leave the Field and then come back:

Screencast.from.07-20-2022.09.19.21.PM.webm

We'll have to figure out a solution for this before we can merge. 😕

jeremyckahn

I think this is ready to go now! I just pushed some cleanup and refactoring work, so please review that and let me know if it looks good to you. If it does, feel free to merge and run a minor release since this change affects the persisted data structure.

Awesome work here! Thanks for sticking with this and knocking out all the bugs. And congrats on implementing a brand new feature! 🎉

feat: add weeds and compost

0d5e470

- weeds grow randomly overnight in unoccupied plots - weeds can be turned into compost through crafting - compost acts like fertilizer

vercel bot deployed to Preview July 17, 2022 06:50 View deployment

vercel bot deployed to Preview July 17, 2022 17:33 View deployment

updates based on feedback

c92808e

- added purchaseable composter - weeds are no longer considered crops - lower value on weeds - added itemType 'WEEDS' - refactored harvestPlot a bit to make it easier to understand for weeds vs crops

lstebner force-pushed the lstebner/weeds-and-compost branch from f1c994f to c92808e Compare July 17, 2022 17:57

vercel bot deployed to Preview July 17, 2022 18:01 View deployment

remove fertilizer from items in favor of one in recipes

6e95990

vercel bot had a problem deploying to Preview July 17, 2022 22:51 Failure

fixing some references to items.fertilizer since it is now part of re…

724f4c4

…cipes

vercel bot deployed to Preview July 18, 2022 01:58 View deployment

add field to saveDataStubFactory

172722a

vercel bot deployed to Preview July 18, 2022 02:07 View deployment

jeremyckahn requested changes Jul 18, 2022

View reviewed changes

lstebner added 5 commits July 17, 2022 20:22

remove type COMPOST

5a27de1

change WEEDS to WEED

159e671

change composter name to 'Basic' and change export to be inline

b4eed15

change weeds to weed

dac5556

more code review feedback updates

2583b13

vercel bot deployed to Preview July 18, 2022 03:43 View deployment

categorize weeds in new Foraged Items category and associated recipes…

6b7d09e

… into new Recycling area of workshop

vercel bot deployed to Preview July 18, 2022 04:05 View deployment

lstebner added 2 commits July 17, 2022 21:15

add some variety to weed image and remove original one

c03b15b

jsdoc

a42cf79

lstebner marked this pull request as ready for review July 18, 2022 04:18

vercel bot deployed to Preview July 18, 2022 04:23 View deployment

fix fertilizer image not showing in workshop, change compost recipe i…

d572730

…ngredients, and consider weeds ripe so they are highlighted when using scythe

vercel bot deployed to Preview July 18, 2022 04:32 View deployment

Update src/game-logic/reducers/purchaseSmelter.test.js

33d7d91

Co-authored-by: Jeremy Kahn <[email protected]>

vercel bot deployed to Preview July 19, 2022 03:34 View deployment

add wasJustShoveled to plotContents when mined

99fdcaa

vercel bot deployed to Preview July 19, 2022 16:08 View deployment

fix: update clearPlot to handle weeds

760bcb4

vercel bot deployed to Preview July 20, 2022 14:33 View deployment

update specs for wasJustShoveled changes

ba36404

vercel bot deployed to Preview July 20, 2022 15:52 View deployment

slightly simpler way to write this bit

06a5b1f

vercel bot deployed to Preview July 20, 2022 15:57 View deployment

add compost piskel file

e8f48b4

vercel bot deployed to Preview July 20, 2022 16:01 View deployment

jeremyckahn requested changes Jul 21, 2022

View reviewed changes

fix: update JSDoc

e7908c4

vercel bot deployed to Preview July 21, 2022 02:34 View deployment

fix: prevent shoveled plot animations from replaying

e830fad

vercel bot deployed to Preview July 21, 2022 03:11 View deployment

refactor: remove wasJustShoveled from farmhand.crop typedef

8cf4ccd

vercel bot deployed to Preview July 21, 2022 14:24 View deployment

refactor: rename resetWasShoveled to updatePlotShoveledState

bc9e211

vercel bot deployed to Preview July 21, 2022 14:36 View deployment

refactor: rename isRipe to canBeHarvested

e7aef69

vercel bot deployed to Preview July 21, 2022 14:41 View deployment

jeremyckahn approved these changes Jul 21, 2022

View reviewed changes

lstebner merged commit e3965ef into develop Jul 21, 2022

lstebner deleted the lstebner/weeds-and-compost branch July 21, 2022 15:47

feat: add weeds and compost #311

feat: add weeds and compost #311

Uh oh!

Conversation

lstebner commented Jul 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does

How this change can be validated

Questions or concerns about this change

Additional information

Uh oh!

vercel bot commented Jul 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeremyckahn commented Jul 17, 2022

Uh oh!

jeremyckahn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lstebner commented Jul 18, 2022

Uh oh!

jeremyckahn commented Jul 19, 2022

Uh oh!

jeremyckahn commented Jul 20, 2022

Uh oh!

jeremyckahn commented Jul 20, 2022

Uh oh!

lstebner commented Jul 20, 2022

Uh oh!

jeremyckahn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeremyckahn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lstebner commented Jul 17, 2022 •

edited

Loading

vercel bot commented Jul 17, 2022 •

edited

Loading