Add feature of material farming in task RogueWorld #361

Schwarze-Katze · 2024-03-06T09:21:40Z

When RogueWorld_WeeklyFarming is enabled, task RogueWorld will not stop when weekly points are full, instead farming the boss 33 times (i.e., 11 simulated universe) to obtain trace materials.
RogueWorld_WeeklyFarmingCount denotes how many turns of rogue remain to complete this week and will be reset to 11 each Monday 04:00.
Does not handle whether the last rogue run failed due to one who use this feature may have less chance of failure.

#231 #247 #264 #288 #294

Correction: Sorry I was misled by #288. Rogue boss has 100 drop times per week, not 33 times. See this.

…nabled to acquire materials from boss

Schwarze-Katze · 2024-03-06T09:27:13Z

Im not quite sure about the usage of self.config.stored.SimulatedUniverse.is_expired() function.
I assume this function would return True when a new week begins and the rogue counter/reward point resets. Please point out if I misunderstood.

Schwarze-Katze

Should I discard the modification of .gitignore or seperate it into a new PR?

LmeSzinc

Im not quite sure about the usage of self.config.stored.SimulatedUniverse.is_expired() function.

Check out the echo of war countdown

StarRailCopilot/module/config/stored/classes.py

Lines 284 to 285 in 58e054a

    
           class StoredEchoOfWar(StoredCounter, StoredExpiredAtMonday0400): 
        
               FIXED_TOTAL = 3

https://github.com/LmeSzinc/AzurLaneAutoScript/wiki/6.1.-GUI-Option

Should I discard the modification of .gitignore or seperate it into a new PR?

yes, and comment that these are electron files

LmeSzinc · 2024-03-07T09:58:31Z

tasks/rogue/entry/entry.py

        if self.config.stored.SimulatedUniverse.is_expired():
-            # Expired, do rogue
-            pass
+            # Expired, do rogue and reset weekly farming count
+            self.config.RogueWorld_WeeklyFarmingCount = 11
+


Don't share records, it should have its own counter, counter starts from 100 and reduces after cleared an elite or boss

Understood. Thank your correction and I ll fix that later today.

foodtooth · 2024-03-07T16:43:46Z

why adding an extra local variable for this while we can just detect the material result after the elite fight? Extra local variable means redundant logic and conflicts as you may wanna do some dlc runs in-game by yourself

Zebartin · 2024-03-08T03:28:20Z

why adding an extra local variable for this while we can just detect the material result after the elite fight? Extra local variable means redundant logic and conflicts as you may wanna do some dlc runs in-game by yourself

you are right but is there any material result that is easy and reliable to detect?

the combat rewards shown at the left side disappear in seconds, easy but not reliable
detect item quantities or credit, reliable but time-consuming

…rrent PR

foodtooth · 2024-03-08T04:58:01Z

why adding an extra local variable for this while we can just detect the material result after the elite fight? Extra local variable means redundant logic and conflicts as you may wanna do some dlc runs in-game by yourself

you are right but is there any material result that is easy and reliable to detect?

the combat rewards shown at the left side disappear in seconds, easy but not reliable

detect item quantities or credit, reliable but time-consuming

Not necessarily relying on any specific material, simply employing template matching for the multiplication sign and counting the quantity should be reliable enough. any thoughts?

Schwarze-Katze · 2024-03-09T07:45:34Z

I have taken @LmeSzinc 's suggestion and set a farming counter in self.config.stored.SimulatedUniverse class.
This counter starts from 100, and decreases each time the elite boss is cleared. When the counter is beyond 0, task SimulatedUniverse enters rogue route even though weekly rogue point is full.

I have noted the idea of detecting boss drop list by @foodtooth 's suggestion.
This way has several pros and cons:

✔️More stable and energy-saving when user plays rogue both manually and by SRC
✔️Avoids adding more and more variables
❌Lacks of robustness, the drop list disappears soon thus may be ignored due to lag of simulator, which may cause the farming feature to stop earlier than expected. In commparison, the former way ensures to complete farming for expected times.
❌Lacks of versatility, no other modules can benefit from this feature, thus has a low input-output ratio

I cannot conclude which way is better than the other, so I adopted the former one. Furthermore, consider of maintainability, every variable name in this commit contains farm prefix, which is unique in SimulatedUniverse module, making it easy to pick out for future modification.

Schwarze-Katze · 2024-03-10T11:09:49Z

🥲It seems that StoredSimulatedUniverse class will not save the counter to disk, causing the counter to reset when src restarts. I dont know how to save this counter, should I use this way or adding the counter value directly to GUI?

Another known issue: if SRC is terminated after clearing elite boss but before exiting elite boss's dungeon(which means just a little walk and one click, will not take much time), farming counter will decrease again at the next time the RogueWorld task enters that elite dungeon, resulting in decreasing the counter twice at one boss battle.

LmeSzinc · 2024-03-31T15:01:52Z

module/config/stored/classes.py

 class StoredSimulatedUniverse(StoredCounter, StoredExpiredAtMonday0400):
-    pass
+    # These variables are used in Rogue Farming feature.
+
+    # Times of boss drop chance per week. In current version of StarRail, this value is 100.
+    FIXED_DEFAULT = 100


Add standalone storage

class StoredSimulatedUniverseElite(StoredCounter, StoredExpiredAtMonday0400): pass

LmeSzinc · 2024-03-31T15:03:51Z

tasks/rogue/route/base.py

        result = super().clear_enemy(*waypoints)
+
+        # runs when one elite battle finishes (do not handle whether the battle succeeded or failed), and decreases rogue farming count by 1
+        if self.config.RogueWorld_WeeklyFarming and self.config.stored.SimulatedUniverse.farm_not_complete():
+            self.config.stored.SimulatedUniverse.farm_dec()
+            logger.info(
+                f"Cleared elite boss, decrease farming count by 1, now {self.config.stored.SimulatedUniverse.FarmingCounter}")


check the result above, reduce counter if "enemy" in result

Schwarze-Katze · 2024-03-31T18:08:33Z

Thanks to @LmeSzinc 's suggestion, I have fixed the problem.
Now MapControl.clear_enemy(self, *waypoints) and MapControl.clear_item(self, *waypoints) methods in tasks/map/control/control.py will return result array, instead of None. I think these two methods' not returning anything is a bug, so I let them to return self.goto(*waypoints)‘s result.
Any code who expect these two methods to return None may have unexpected result, but during my review no one uses the return value except mine.

Schwarze-Katze and others added 5 commits March 6, 2024 15:06

modify .gitignore to ignore files automatically added by src deployer

f50fbb7

rogue farming feature: enter rogue when RogueWorld_WeeklyFarming is e…

0d4ee26

…nabled to acquire materials from boss

multilanguage translation

e49ec54

Merge branch 'LmeSzinc:master' into master

7c845c0

translation bugfix

7130b09

Schwarze-Katze commented Mar 6, 2024

View reviewed changes

LmeSzinc reviewed Mar 7, 2024

View reviewed changes

discard modification of .gitignore cause it is less related to the cu…

76c8f9e

…rrent PR

Use stored counter to count boss farming times to run

f5bc0d0

Add comments in stored counter class definition

2bc797f

LmeSzinc reviewed Mar 31, 2024

View reviewed changes

Schwarze-Katze and others added 2 commits April 1, 2024 00:27

Merge branch 'LmeSzinc:master' into master

792eb21

Seperate stored counter into an independent class

f262140

Schwarze-Katze added 2 commits April 1, 2024 10:33

improves readability

721ae38

optimize expiration judging

4988fb1

LmeSzinc added good first issue / 首次贡献 Good for newcomers feature request / 功能请求 New feature or requests labels Apr 5, 2024

LmeSzinc changed the base branch from master to dev April 14, 2024 13:42

LmeSzinc merged commit 6c56f5e into LmeSzinc:dev Apr 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add feature of material farming in task RogueWorld #361

Add feature of material farming in task RogueWorld #361

Schwarze-Katze commented Mar 6, 2024 •

edited

Schwarze-Katze commented Mar 6, 2024

Schwarze-Katze left a comment •

edited

LmeSzinc left a comment

LmeSzinc Mar 7, 2024

Schwarze-Katze Mar 8, 2024

foodtooth commented Mar 7, 2024

Zebartin commented Mar 8, 2024

foodtooth commented Mar 8, 2024

Schwarze-Katze commented Mar 9, 2024 •

edited

Schwarze-Katze commented Mar 10, 2024 •

edited

LmeSzinc Mar 31, 2024

LmeSzinc Mar 31, 2024

Schwarze-Katze commented Mar 31, 2024 •

edited

	class StoredEchoOfWar(StoredCounter, StoredExpiredAtMonday0400):
	FIXED_TOTAL = 3

Add feature of material farming in task RogueWorld #361

Add feature of material farming in task RogueWorld #361

Conversation

Schwarze-Katze commented Mar 6, 2024 • edited

Schwarze-Katze commented Mar 6, 2024

Schwarze-Katze left a comment • edited

Choose a reason for hiding this comment

LmeSzinc left a comment

Choose a reason for hiding this comment

LmeSzinc Mar 7, 2024

Choose a reason for hiding this comment

Schwarze-Katze Mar 8, 2024

Choose a reason for hiding this comment

foodtooth commented Mar 7, 2024

Zebartin commented Mar 8, 2024

foodtooth commented Mar 8, 2024

Schwarze-Katze commented Mar 9, 2024 • edited

Schwarze-Katze commented Mar 10, 2024 • edited

LmeSzinc Mar 31, 2024

Choose a reason for hiding this comment

LmeSzinc Mar 31, 2024

Choose a reason for hiding this comment

Schwarze-Katze commented Mar 31, 2024 • edited

Schwarze-Katze commented Mar 6, 2024 •

edited

Schwarze-Katze left a comment •

edited

Schwarze-Katze commented Mar 9, 2024 •

edited

Schwarze-Katze commented Mar 10, 2024 •

edited

Schwarze-Katze commented Mar 31, 2024 •

edited