Stardew Valley: Add tracker text client integrated with UT and commands to explain the logic #4378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ardew-text-client
github-actions
bot
added
the
waiting-on: peer-review
agilbert1412
added
is: enhancement
|
I haven't reviewed it yet, but I will. Just want to say that this looks friggin amazing, great work! |
agilbert1412
removed
the
waiting-on: other
| locations=(location for location in ctx.multiworld.get_locations() if (not location.address))) | ||
|
|
||
| return state | ||
| return updateTracker(ctx)[3] |
There was a problem hiding this comment.
This will work, but updateTracker now returns a CurrentTrackerState named tuple (defined in worlds.tracker if you want to grab that but i don't think you need to) so you should be able to change this to updateTracker(ctx).state
We did this just in case the return needs to expand again, so it's less likely to break things in the future
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
This PR is based on #3596, which has been up for a long time now...
This adds a custom client for Stardew Valley that is integrated with Universal Tracker (need to be installed separately).
This leverages the Stardew rule framework to dig into the rules and explain them. We already had functions to explain the logic, but it was only used to debug test failure. Being able to make the rules human-readable helped us a lot while developing, so making the rules available to users to read seems only natural.
The client comes with 4 commands to explain Stardew's deep logic to end users (see screenshots). Universal tracker is required for the Stardew Valley Tracker client to appear in the launcher.
How does it work?
This uses UT ability to generate a world consistently with the player settings and its ability to build a collection state updated with the current multi world. UT uses it to find what locations are currently in logic, but with the Stardew rule framework, since the rules are not lambda but complete objects, we can easily dig into them and find out why they evaluate to True or False.
How was this tested?
Generate multiple explain for different rule types. Made sure colors are correctly applied. See screenshots.
A version of the current
stardew_valley.apworldwas released with the tracker packaged in for players to test. https://github.com/agilbert1412/Archipelago/releases/tag/0.5.1-stardew-6.6.5-trackerIf this makes graphical changes, please attach screenshots.
In case you forgot that tomatoes grow in summer
Working with UT means using UT commands! You can manually collect stuff and the explains will adapt.
Sadly, some rules are not meant for humans...
Ahh, yes, that's where the mine is!
No need to remember location name with fuzzy matching!
Using
explain_missingwill focus on the rules you're missing, and skip explaining what you already have collected.