SkyHanni icon indicating copy to clipboard operation
SkyHanni copied to clipboard

Improvement: Berberis Helper Rework

Open MajOfMyth opened this issue 1 year ago • 35 comments

What

Berberis is a crop in the Rift that grows one at a time, then needs to be broken in the same order they grew in. The base game guides you to each bush using particles. The problem with this is that the particles don't have the best visibility, and you can break the next bush as soon as the previous was broken, having you waste time waiting to see where the particles lead you.

SkyHanni already has a helper for this, which solves the particle visibility. It highlights the bush the particles are currently on when not moving, and follows them to the next bush while moving.

This new system shows you two bushes ahead of the one you need to break so you no longer have to wait for the particles!

It does this by watching them as they spawn in, and remembering the order they did so. It then highlights the next one to break, and the next two after that.

Images

https://github.com/user-attachments/assets/cca6b6c1-2db4-45e9-9260-b19b1deb1733

Changelog Improvements

  • Reworked Berberis Farming Helper in the Rift. - Maj
    • Previews what bushes need to be broken after the current one if you were in the plot when they last regrew.
    • If you were in another plot when they grew, or it is wrong about the order for any reason, it will fall back to the original helper.

MajOfMyth avatar Jan 02 '25 11:01 MajOfMyth

I have detected some issues with your pull request:

Body issues: Change should end with a full stop in text: Initial Rework

Please fix these issues. For the correct format, refer to the pull request template.

github-actions[bot] avatar Jan 02 '25 11:01 github-actions[bot]

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 02 '25 11:01 github-actions[bot]

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 02 '25 11:01 github-actions[bot]

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 03 '25 10:01 github-actions[bot]

If you use IntelliJ, please click the auto refomat hotkey (control + alt + L) before every commit

hannibal002 avatar Jan 03 '25 10:01 hannibal002

oh my god thank you so much

MajOfMyth avatar Jan 03 '25 10:01 MajOfMyth

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 03 '25 10:01 github-actions[bot]

ok it didnt fix everything ig

MajOfMyth avatar Jan 03 '25 10:01 MajOfMyth

torry I'm struggling with this so much 😭

MajOfMyth avatar Jan 03 '25 10:01 MajOfMyth

the wording of the changelog should be readable for users without technical knowledge (except the technical details/backend category). their "main line" should explain in a whole sentence what got changed in a broad statement, the "small line below" can include additional information about that change.

Your current wording is neither explanatory nor user ready, please change that

hannibal002 avatar Jan 04 '25 11:01 hannibal002

Updated. I hope this is better :)

MajOfMyth avatar Jan 04 '25 11:01 MajOfMyth

image im talking about those two statements. they dont mean anything on its own. they are the only lines showing up in the changelog, the pr name or the description above is not there. so the user lacks the context what is this about at all. and the extra text below should not provide context but rather better explain what this change means.

e.g. you could call them "Reworked Berberis Particle Helper in the Rift", then mention that the new design will remember the order after one full clean of the field and additionally still use the legacy system as fallback/while the order is not loaded yet. also you can merge both entires into one and have two smaller sentences below. e.g.

+ title. - your name
    * line 1
    * line 2

hannibal002 avatar Jan 04 '25 12:01 hannibal002

Ohh sorry my bad, 1 sec

MajOfMyth avatar Jan 04 '25 12:01 MajOfMyth

That better?

MajOfMyth avatar Jan 04 '25 12:01 MajOfMyth

yes, way better. thanks!

hannibal002 avatar Jan 04 '25 12:01 hannibal002

How does that look?

MajOfMyth avatar Jan 05 '25 16:01 MajOfMyth

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 05 '25 16:01 github-actions[bot]

there :)

MajOfMyth avatar Jan 06 '25 04:01 MajOfMyth

please click on the resolve button when a comment is done. also please rerequest a review from me when you want me to look again at that pr

image image

hannibal002 avatar Jan 07 '25 14:01 hannibal002

Oh sorry, this is my first time doing a pull request if it wasn't obvious :P

MajOfMyth avatar Jan 07 '25 14:01 MajOfMyth

This pull request has conflicts with the base branch "beta". Please resolve those so we can test out your changes.

github-actions[bot] avatar Jan 24 '25 05:01 github-actions[bot]

Conflicts have been resolved! 🎉

github-actions[bot] avatar Jan 25 '25 16:01 github-actions[bot]

This pull request has conflicts with the base branch "beta". Please resolve those so we can test out your changes.

github-actions[bot] avatar Jan 27 '25 01:01 github-actions[bot]

One or more Detekt Failures were detected:

github-actions[bot] avatar Jan 27 '25 01:01 github-actions[bot]

This is getting a bit overwhelming and outside what I know how to do. I wanted to make this work but I don't think I can handle much further than this.

MajOfMyth avatar Jan 27 '25 01:01 MajOfMyth

Solved you the problems you had with the requests of hannibal. The three changes work together, so I suggest implementing all at the same time (otherwise they might not work).

Seriously thank you so much

MajOfMyth avatar Jan 30 '25 04:01 MajOfMyth

why is detekt angry :( it looks like the handle event stuff but idk what it wants me to do-?

MajOfMyth avatar Jan 30 '25 04:01 MajOfMyth

oops loll I see that now 😭

MajOfMyth avatar Jan 30 '25 06:01 MajOfMyth

Conflicts have been resolved! 🎉

github-actions[bot] avatar Feb 11 '25 12:02 github-actions[bot]

One or more Detekt Failures were detected:

github-actions[bot] avatar Feb 11 '25 13:02 github-actions[bot]