From e36342f3ecd79f6a39647b2e56c08a9e84351917 Mon Sep 17 00:00:00 2001 From: dayfine Date: Tue, 20 Oct 2026 19:29:57 -0700 Subject: [PATCH 1/2] Move BBQ quest identity into its own Options module The BBQuests enum lived in Options/PokemonSV_BBQOption.h, but its slug map and string_to_enum lived in Programs/Farming/ PokemonSV_BlueberryQuests.{h,cpp}. Anything that needed a quest name had to depend on the whole BBQ program module, and BlueberryCatchPhoto.h included BlueberryQuests.h only for these types while BlueberryQuests.cpp included BlueberryCatchPhoto.h. Move the enum and slug mapping into Options/PokemonSV_BBQuests.{h,cpp}, next to BBQOption.h, which now includes it. Add BBQuests_enum_to_string, backed by a reverse map built once from the existing slug map. Move CameraAngle into BlueberryCatchPhoto.h, its only user. The catch/photo module no longer includes BlueberryQuests.h. No behavior change. Add a unit test that every quest round-trips through its slug. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01AKYzhrMnPK61XHWEch4a6E --- .../PokemonSV/Options/PokemonSV_BBQOption.h | 13 +- .../PokemonSV/Options/PokemonSV_BBQuests.cpp | 131 ++++++++++++++++++ .../PokemonSV/Options/PokemonSV_BBQuests.h | 39 ++++++ .../VideoGames/PokemonSV/PokemonSV_Tests.cpp | 31 +++++ .../Farming/PokemonSV_BlueberryCatchPhoto.cpp | 1 - .../Farming/PokemonSV_BlueberryCatchPhoto.h | 8 +- .../Farming/PokemonSV_BlueberryQuests.cpp | 90 ------------ .../Farming/PokemonSV_BlueberryQuests.h | 8 -- SerialPrograms/cmake/SourceFiles.cmake | 2 + 9 files changed, 211 insertions(+), 112 deletions(-) create mode 100644 SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.cpp create mode 100644 SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h index 48db02d5f9..f5715a10c7 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h @@ -16,23 +16,12 @@ #include "VideoGames/PokemonSwSh/Options/PokemonSwSh_BallSelectOption.h" #include "VideoGames/PokemonSV/Options/PokemonSV_TeraAIOption.h" #include "VideoGames/PokemonSV/Options/PokemonSV_TeraCatchOnWinOption.h" +#include "VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h" namespace PokemonAutomation{ namespace NintendoSwitch{ namespace PokemonSV{ -enum class BBQuests{ - auto_10, make_tm, pickup_10, sneak_up, photo_fly, photo_swim, photo_canyon, photo_coastal, photo_polar, photo_savanna, tera_self_defeat, - travel_500, catch_any, catch_normal, catch_fighting, catch_flying, catch_poison, catch_ground, catch_rock, catch_bug, catch_ghost, catch_steel, - catch_fire, catch_water, catch_grass, catch_electric, catch_psychic, catch_ice, catch_dragon, catch_dark, catch_fairy, - wash_pokemon, wild_tera, auto_30, tera_raid, sandwich_three, bitter_sandwich, sweet_sandwich, salty_sandwich, sour_sandwich, spicy_sandwich, hatch_egg, - photo_normal, photo_fighting, photo_flying, photo_poison, photo_ground, photo_rock, photo_bug, photo_ghost, photo_steel, photo_fire, photo_water, - photo_grass, photo_electric, photo_psychic, photo_ice, photo_dragon, photo_dark, photo_fairy, - ditto_central, ditto_canyon, ditto_coastal, ditto_polar, ditto_savanna, group_canyon, group_coastal, group_polar, group_savanna, group_eyewear, group_nonuniform, - group_masks, sandwich_four, catch_hint, catch_hint2, - UnableToDetect -}; - enum class BBQAction{ run, skip, diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.cpp new file mode 100644 index 0000000000..9e90e5702d --- /dev/null +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.cpp @@ -0,0 +1,131 @@ +/* Blueberry Quests + * + * From: https://github.com/PokemonAutomation/ + * + */ + +#include +#include "PokemonSV_BBQuests.h" + +namespace PokemonAutomation{ +namespace NintendoSwitch{ +namespace PokemonSV{ + +namespace{ + +const std::map& BBQuests_TOKEN_TO_ENUM(){ + static std::map data{ + {"auto-10", BBQuests::auto_10}, + {"make-tm", BBQuests::make_tm }, + {"pickup-10", BBQuests::pickup_10}, + {"sneak-up", BBQuests::sneak_up}, + {"photo-fly", BBQuests::photo_fly}, + {"photo-swim", BBQuests::photo_swim}, + {"photo-canyon", BBQuests::photo_canyon}, + {"photo-coastal", BBQuests::photo_coastal}, + {"photo-polar", BBQuests::photo_polar}, + {"photo-savanna", BBQuests::photo_savanna}, + {"tera-self-defeat", BBQuests::tera_self_defeat}, + {"travel-500", BBQuests::travel_500}, + {"catch-any", BBQuests::catch_any}, + {"catch-normal", BBQuests::catch_normal}, + {"catch-fighting", BBQuests::catch_fighting}, + {"catch-flying", BBQuests::catch_flying}, + {"catch-poison", BBQuests::catch_poison}, + {"catch-ground", BBQuests::catch_ground}, + {"catch-rock", BBQuests::catch_rock}, + {"catch-bug", BBQuests::catch_bug}, + {"catch-ghost", BBQuests::catch_ghost}, + {"catch-steel", BBQuests::catch_steel}, + {"catch-fire", BBQuests::catch_fire}, + {"catch-water", BBQuests::catch_water}, + {"catch-grass", BBQuests::catch_grass}, + {"catch-electric", BBQuests::catch_electric}, + {"catch-psychic", BBQuests::catch_psychic}, + {"catch-ice", BBQuests::catch_ice}, + {"catch-dragon", BBQuests::catch_dragon}, + {"catch-dark", BBQuests::catch_dark}, + {"catch-fairy", BBQuests::catch_fairy}, + {"wash-pokemon", BBQuests::wash_pokemon}, + {"wild-tera", BBQuests::wild_tera}, + {"auto-30", BBQuests::auto_30}, + {"tera-raid", BBQuests::tera_raid}, + {"sandwich-three", BBQuests::sandwich_three}, + {"bitter-sandwich", BBQuests::bitter_sandwich}, + {"sweet-sandwich", BBQuests::sweet_sandwich}, + {"salty-sandwich", BBQuests::salty_sandwich}, + {"sour-sandwich", BBQuests::sour_sandwich}, + {"spicy-sandwich", BBQuests::spicy_sandwich}, + {"hatch-egg", BBQuests::hatch_egg}, + {"photo-normal", BBQuests::photo_normal}, + {"photo-fighting", BBQuests::photo_fighting}, + {"photo-flying", BBQuests::photo_flying}, + {"photo-poison", BBQuests::photo_poison}, + {"photo-ground", BBQuests::photo_ground}, + {"photo-rock", BBQuests::photo_rock}, + {"photo-bug", BBQuests::photo_bug}, + {"photo-ghost", BBQuests::photo_ghost}, + {"photo-steel", BBQuests::photo_steel}, + {"photo-fire", BBQuests::photo_fire}, + {"photo-water", BBQuests::photo_water}, + {"photo-grass", BBQuests::photo_grass}, + {"photo-electric", BBQuests::photo_electric}, + {"photo-psychic", BBQuests::photo_psychic}, + {"photo-ice", BBQuests::photo_ice}, + {"photo-dragon", BBQuests::photo_dragon}, + {"photo-dark", BBQuests::photo_dark}, + {"photo-fairy", BBQuests::photo_fairy}, + {"ditto-central", BBQuests::ditto_central}, + {"ditto-canyon", BBQuests::ditto_canyon}, + {"ditto-coastal", BBQuests::ditto_coastal}, + {"ditto-polar", BBQuests::ditto_polar}, + {"ditto-savanna", BBQuests::ditto_savanna}, + {"group-canyon", BBQuests::group_canyon}, + {"group-coastal", BBQuests::group_coastal}, + {"group-polar", BBQuests::group_polar}, + {"group-savanna", BBQuests::group_savanna}, + {"group-eyewear", BBQuests::group_eyewear}, + {"group-nonuniform", BBQuests::group_nonuniform}, + {"group-masks", BBQuests::group_masks}, + {"sandwich-four", BBQuests::sandwich_four}, + {"catch-hint", BBQuests::catch_hint}, + {"catch-hint2", BBQuests::catch_hint2}, + {"", BBQuests::UnableToDetect}, + }; + return data; +} + +const std::map& BBQuests_ENUM_TO_TOKEN(){ + static std::map data = []{ + std::map ret; + for (const auto& [token, quest] : BBQuests_TOKEN_TO_ENUM()){ + ret.emplace(quest, token); + } + return ret; + }(); + return data; +} + +} + +BBQuests BBQuests_string_to_enum(const std::string& token){ + auto iter = BBQuests_TOKEN_TO_ENUM().find(token); + if (iter == BBQuests_TOKEN_TO_ENUM().end()){ + return BBQuests::UnableToDetect; + } + return iter->second; +} + +const std::string& BBQuests_enum_to_string(BBQuests quest){ + static const std::string EMPTY; + auto iter = BBQuests_ENUM_TO_TOKEN().find(quest); + if (iter == BBQuests_ENUM_TO_TOKEN().end()){ + return EMPTY; + } + return iter->second; +} + + +} +} +} diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h new file mode 100644 index 0000000000..2f37ade6bf --- /dev/null +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h @@ -0,0 +1,39 @@ +/* Blueberry Quests + * + * From: https://github.com/PokemonAutomation/ + * + */ + +#ifndef PokemonAutomation_PokemonSV_BBQuests_H +#define PokemonAutomation_PokemonSV_BBQuests_H + +#include + +namespace PokemonAutomation{ +namespace NintendoSwitch{ +namespace PokemonSV{ + +enum class BBQuests{ + auto_10, make_tm, pickup_10, sneak_up, photo_fly, photo_swim, photo_canyon, photo_coastal, photo_polar, photo_savanna, tera_self_defeat, + travel_500, catch_any, catch_normal, catch_fighting, catch_flying, catch_poison, catch_ground, catch_rock, catch_bug, catch_ghost, catch_steel, + catch_fire, catch_water, catch_grass, catch_electric, catch_psychic, catch_ice, catch_dragon, catch_dark, catch_fairy, + wash_pokemon, wild_tera, auto_30, tera_raid, sandwich_three, bitter_sandwich, sweet_sandwich, salty_sandwich, sour_sandwich, spicy_sandwich, hatch_egg, + photo_normal, photo_fighting, photo_flying, photo_poison, photo_ground, photo_rock, photo_bug, photo_ghost, photo_steel, photo_fire, photo_water, + photo_grass, photo_electric, photo_psychic, photo_ice, photo_dragon, photo_dark, photo_fairy, + ditto_central, ditto_canyon, ditto_coastal, ditto_polar, ditto_savanna, group_canyon, group_coastal, group_polar, group_savanna, group_eyewear, group_nonuniform, + group_masks, sandwich_four, catch_hint, catch_hint2, + UnableToDetect +}; + +// Map a quest slug (as returned by BlueberryQuestDetector) to its enum. +// Unrecognized slugs return UnableToDetect. +BBQuests BBQuests_string_to_enum(const std::string& token); + +// Map a quest to its slug. UnableToDetect maps to the empty string. +const std::string& BBQuests_enum_to_string(BBQuests quest); + + +} +} +} +#endif diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp index d966bfe133..61c51d435a 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp @@ -25,15 +25,46 @@ #include "Inference/Overworld/PokemonSV_LetsGoKillDetector.h" #include "Inference/Picnics/PokemonSV_SandwichRecipeDetector.h" #include "Inference/Picnics/PokemonSV_SandwichHandDetector.h" +#include "Options/PokemonSV_BBQuests.h" #include "PokemonSV_Tests.h" namespace PokemonAutomation{ namespace NintendoSwitch{ namespace PokemonSV{ +namespace{ +class Test_BBQuestsSlugs : public UnitTest{ +public: + Test_BBQuestsSlugs() + : UnitTest("PokemonSV::BBQuests - slug round trip") + {} + + virtual UnitTestResult run(Logger&, CancellableScope&) const override{ + for (int c = 0; c < (int)BBQuests::UnableToDetect; c++){ + const BBQuests quest = (BBQuests)c; + const std::string& slug = BBQuests_enum_to_string(quest); + if (slug.empty()){ + return "Quest " + std::to_string(c) + " has no slug."; + } + if (BBQuests_string_to_enum(slug) != quest){ + return "Slug " + slug + " does not map back to quest " + std::to_string(c) + "."; + } + } + if (!BBQuests_enum_to_string(BBQuests::UnableToDetect).empty()){ + return "UnableToDetect must map to the empty slug."; + } + if (BBQuests_string_to_enum("not-a-quest") != BBQuests::UnableToDetect){ + return "An unrecognized slug must map to UnableToDetect."; + } + return true; + } +}; + +} void add_tests(UnitTestDatabase& database){ + database.add(); add_tests_WhiteButtonDetector(database); add_tests_BoxInfoDetector(database); add_tests_BoxEggDetector(database); diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp index b4f217420c..ab0290f4ea 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp @@ -27,7 +27,6 @@ #include "VideoGames/PokemonSV/Programs/PokemonSV_WorldNavigation.h" #include "VideoGames/PokemonSV/Programs/Battles/PokemonSV_BasicCatcher.h" #include "VideoGames/PokemonSV/Programs/PokemonSV_Terarium.h" -#include "PokemonSV_BlueberryQuests.h" #include #include "PokemonSV_BlueberryCatchPhoto.h" diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.h b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.h index c4a99efb65..862285c3c3 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.h +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.h @@ -9,7 +9,7 @@ #include "NintendoSwitch/Controllers/Procon/NintendoSwitch_ProController.h" #include "NintendoSwitch/NintendoSwitch_Settings.h" -#include "VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.h" +#include "NintendoSwitch/NintendoSwitch_ConsoleHandle.h" #include "VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h" using namespace std; @@ -19,6 +19,12 @@ namespace PokemonAutomation{ namespace NintendoSwitch{ namespace PokemonSV{ +enum class CameraAngle{ + none, + up, + down +}; + //Navigate to a photo target CameraAngle quest_photo_navi( const ProgramInfo& info, diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp index 43740d2c1c..6ea759ba96 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp @@ -50,96 +50,6 @@ namespace PokemonAutomation{ namespace NintendoSwitch{ namespace PokemonSV{ -const std::map& BBQuests_TOKEN_TO_ENUM(){ - static std::map data{ - {"auto-10", BBQuests::auto_10}, - {"make-tm", BBQuests::make_tm }, - {"pickup-10", BBQuests::pickup_10}, - {"sneak-up", BBQuests::sneak_up}, - {"photo-fly", BBQuests::photo_fly}, - {"photo-swim", BBQuests::photo_swim}, - {"photo-canyon", BBQuests::photo_canyon}, - {"photo-coastal", BBQuests::photo_coastal}, - {"photo-polar", BBQuests::photo_polar}, - {"photo-savanna", BBQuests::photo_savanna}, - {"tera-self-defeat", BBQuests::tera_self_defeat}, - {"travel-500", BBQuests::travel_500}, - {"catch-any", BBQuests::catch_any}, - {"catch-normal", BBQuests::catch_normal}, - {"catch-fighting", BBQuests::catch_fighting}, - {"catch-flying", BBQuests::catch_flying}, - {"catch-poison", BBQuests::catch_poison}, - {"catch-ground", BBQuests::catch_ground}, - {"catch-rock", BBQuests::catch_rock}, - {"catch-bug", BBQuests::catch_bug}, - {"catch-ghost", BBQuests::catch_ghost}, - {"catch-steel", BBQuests::catch_steel}, - {"catch-fire", BBQuests::catch_fire}, - {"catch-water", BBQuests::catch_water}, - {"catch-grass", BBQuests::catch_grass}, - {"catch-electric", BBQuests::catch_electric}, - {"catch-psychic", BBQuests::catch_psychic}, - {"catch-ice", BBQuests::catch_ice}, - {"catch-dragon", BBQuests::catch_dragon}, - {"catch-dark", BBQuests::catch_dark}, - {"catch-fairy", BBQuests::catch_fairy}, - {"wash-pokemon", BBQuests::wash_pokemon}, - {"wild-tera", BBQuests::wild_tera}, - {"auto-30", BBQuests::auto_30}, - {"tera-raid", BBQuests::tera_raid}, - {"sandwich-three", BBQuests::sandwich_three}, - {"bitter-sandwich", BBQuests::bitter_sandwich}, - {"sweet-sandwich", BBQuests::sweet_sandwich}, - {"salty-sandwich", BBQuests::salty_sandwich}, - {"sour-sandwich", BBQuests::sour_sandwich}, - {"spicy-sandwich", BBQuests::spicy_sandwich}, - {"hatch-egg", BBQuests::hatch_egg}, - {"photo-normal", BBQuests::photo_normal}, - {"photo-fighting", BBQuests::photo_fighting}, - {"photo-flying", BBQuests::photo_flying}, - {"photo-poison", BBQuests::photo_poison}, - {"photo-ground", BBQuests::photo_ground}, - {"photo-rock", BBQuests::photo_rock}, - {"photo-bug", BBQuests::photo_bug}, - {"photo-ghost", BBQuests::photo_ghost}, - {"photo-steel", BBQuests::photo_steel}, - {"photo-fire", BBQuests::photo_fire}, - {"photo-water", BBQuests::photo_water}, - {"photo-grass", BBQuests::photo_grass}, - {"photo-electric", BBQuests::photo_electric}, - {"photo-psychic", BBQuests::photo_psychic}, - {"photo-ice", BBQuests::photo_ice}, - {"photo-dragon", BBQuests::photo_dragon}, - {"photo-dark", BBQuests::photo_dark}, - {"photo-fairy", BBQuests::photo_fairy}, - {"ditto-central", BBQuests::ditto_central}, - {"ditto-canyon", BBQuests::ditto_canyon}, - {"ditto-coastal", BBQuests::ditto_coastal}, - {"ditto-polar", BBQuests::ditto_polar}, - {"ditto-savanna", BBQuests::ditto_savanna}, - {"group-canyon", BBQuests::group_canyon}, - {"group-coastal", BBQuests::group_coastal}, - {"group-polar", BBQuests::group_polar}, - {"group-savanna", BBQuests::group_savanna}, - {"group-eyewear", BBQuests::group_eyewear}, - {"group-nonuniform", BBQuests::group_nonuniform}, - {"group-masks", BBQuests::group_masks}, - {"sandwich-four", BBQuests::sandwich_four}, - {"catch-hint", BBQuests::catch_hint}, - {"catch-hint2", BBQuests::catch_hint2}, - {"", BBQuests::UnableToDetect}, - }; - return data; -} - -BBQuests BBQuests_string_to_enum(const std::string& token){ - auto iter = BBQuests_TOKEN_TO_ENUM().find(token); - if (iter == BBQuests_TOKEN_TO_ENUM().end()){ - return BBQuests::UnableToDetect; - } - return iter->second; -} - int read_BP(const ProgramInfo& info, VideoStream& stream, ProControllerContext& context){ WhiteButtonWatcher right_panel(COLOR_BLUE, WhiteButton::ButtonB, {0.484, 0.117, 0.022, 0.037}); int result = run_until( diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.h b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.h index 957a3c50e9..3b8b70521a 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.h +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.h @@ -18,14 +18,6 @@ namespace PokemonAutomation{ namespace NintendoSwitch{ namespace PokemonSV{ -BBQuests BBQuests_string_to_enum(const std::string& token); - -enum class CameraAngle{ - none, - up, - down -}; - //Basic blue quests const std::set blue_quests = { BBQuests::auto_10, BBQuests::make_tm, BBQuests::pickup_10, BBQuests::sneak_up, BBQuests::photo_fly, BBQuests::photo_swim, BBQuests::photo_canyon, BBQuests::photo_coastal, BBQuests::photo_polar, BBQuests::photo_savanna, BBQuests::tera_self_defeat, diff --git a/SerialPrograms/cmake/SourceFiles.cmake b/SerialPrograms/cmake/SourceFiles.cmake index 4a370e7d9a..aeb68781ae 100644 --- a/SerialPrograms/cmake/SourceFiles.cmake +++ b/SerialPrograms/cmake/SourceFiles.cmake @@ -2425,6 +2425,8 @@ file(GLOB LIBRARY_SOURCES Source/VideoGames/PokemonSV/Options/PokemonSV_BattleMoveTable.h Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.cpp Source/VideoGames/PokemonSV/Options/PokemonSV_BBQOption.h + Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.cpp + Source/VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h Source/VideoGames/PokemonSV/Options/PokemonSV_EggPowerSandwichOption.cpp Source/VideoGames/PokemonSV/Options/PokemonSV_EggPowerSandwichOption.h Source/VideoGames/PokemonSV/Options/PokemonSV_EncounterActionsTable.cpp From 0ceac54aa6415ff77b37cfaefc82d058b834fc60 Mon Sep 17 00:00:00 2001 From: dayfine Date: Tue, 20 Oct 2026 19:56:32 -0700 Subject: [PATCH 2/2] Log BBQ boards and quest attempts through BBQLogger BBQ failures are hard to attribute to a specific quest and attempt from the existing logs. Add one-line "BBQ ..." events: - board: panel detected and quest slugs in board order, each time read_quests() reads the panel - per attempt: start, route_return and result, with attempt/limit and route, verification and total durations - catch battle-entry timeout, and retry exhaustion BBQLogger depends only on Logger and the Options/PokemonSV_BBQuests leaf, so the quest and catch/photo modules call into it without a dependency back. Durations use explicit steady_clock timestamps so tests can check them without depending on wall-clock time. Add four PokemonSV::BBQDiagnosticLogs tests with a recording logger covering board formatting, success, failure with retry exhaustion, and long/zero durations. Controller sequences, retry limits and reroll policy are unchanged. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01AKYzhrMnPK61XHWEch4a6E --- .../VideoGames/PokemonSV/PokemonSV_Tests.cpp | 76 +++++++++++++++ .../Programs/Farming/PokemonSV_BBQLogger.cpp | 94 +++++++++++++++++++ .../Programs/Farming/PokemonSV_BBQLogger.h | 73 ++++++++++++++ .../Farming/PokemonSV_BlueberryCatchPhoto.cpp | 2 + .../Farming/PokemonSV_BlueberryQuests.cpp | 8 ++ SerialPrograms/cmake/SourceFiles.cmake | 2 + 6 files changed, 255 insertions(+) create mode 100644 SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.cpp create mode 100644 SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.h diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp index 61c51d435a..3f206618ba 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/PokemonSV_Tests.cpp @@ -26,6 +26,7 @@ #include "Inference/Picnics/PokemonSV_SandwichRecipeDetector.h" #include "Inference/Picnics/PokemonSV_SandwichHandDetector.h" #include "Options/PokemonSV_BBQuests.h" +#include "Programs/Farming/PokemonSV_BBQLogger.h" #include "PokemonSV_Tests.h" namespace PokemonAutomation{ @@ -61,9 +62,84 @@ class Test_BBQuestsSlugs : public UnitTest{ } }; +class BBQTestLogger : public Logger{ +public: + virtual void log(const std::string& message, Color) override{ + messages.push_back(message); + } + std::vector messages; +}; + +class Test_BBQDiagnosticLogs : public UnitTest{ +public: + Test_BBQDiagnosticLogs(const std::string& scenario) + : UnitTest("PokemonSV::BBQDiagnosticLogs - " + scenario), m_scenario(scenario) + {} + + virtual UnitTestResult run(Logger&, CancellableScope&) const override{ + BBQTestLogger logger; + std::vector expected; + const BBQAttemptLog::Clock::time_point start{}; + if (m_scenario == "board"){ + BBQLogger(logger).board(true, + {BBQuests::photo_swim, BBQuests::sneak_up, BBQuests::auto_10}); + BBQLogger(logger).board(false, {BBQuests::UnableToDetect}); + BBQLogger(logger).board(true, {}); + expected = { + "BBQ event=board panel_detected=1 quests=photo-swim,sneak-up,auto-10", + "BBQ event=board panel_detected=0 quests=unknown", + "BBQ event=board panel_detected=1 quests=", + }; + }else if (m_scenario == "success"){ + BBQAttemptLog attempt_log(logger, BBQuests::make_tm, 1, 2, start); + attempt_log.route_return(start + std::chrono::milliseconds(2000)); + attempt_log.result(true, start + std::chrono::milliseconds(2500)); + expected = { + "BBQ quest=make-tm attempt=1 limit=2 event=start", + "BBQ quest=make-tm attempt=1 limit=2 event=route_return elapsed_ms=2000 elapsed=\"2.000 seconds\"", + "BBQ quest=make-tm attempt=1 limit=2 event=result outcome=absent_from_board verification_ms=500 verification=\"0.500 seconds\" total_ms=2500 total=\"2.500 seconds\"", + }; + }else if (m_scenario == "retry-exhausted"){ + BBQLogger(logger).battle_entry_timeout(BBQuests::catch_any); + BBQAttemptLog attempt_log(logger, BBQuests::catch_any, 2, 2, start); + attempt_log.route_return(start + std::chrono::milliseconds(3345)); + attempt_log.result(false, start + std::chrono::milliseconds(4110)); + BBQLogger(logger).retry_exhausted(BBQuests::catch_any); + expected = { + "BBQ quest=catch-any event=battle_entry outcome=timeout", + "BBQ quest=catch-any attempt=2 limit=2 event=start", + "BBQ quest=catch-any attempt=2 limit=2 event=route_return elapsed_ms=3345 elapsed=\"3.345 seconds\"", + "BBQ quest=catch-any attempt=2 limit=2 event=result outcome=still_on_board verification_ms=765 verification=\"0.765 seconds\" total_ms=4110 total=\"4.110 seconds\"", + "BBQ quest=catch-any event=retry_exhausted recovery=skip_current_batch", + }; + }else if (m_scenario == "long-duration"){ + BBQAttemptLog attempt_log(logger, BBQuests::UnableToDetect, 256, 256, start); + attempt_log.route_return(start + std::chrono::milliseconds(120000)); + attempt_log.result(false, start + std::chrono::milliseconds(120000)); + expected = { + "BBQ quest=unknown attempt=256 limit=256 event=start", + "BBQ quest=unknown attempt=256 limit=256 event=route_return elapsed_ms=120000 elapsed=\"2.000 minutes\"", + "BBQ quest=unknown attempt=256 limit=256 event=result outcome=still_on_board verification_ms=0 verification=\"0.000 seconds\" total_ms=120000 total=\"2.000 minutes\"", + }; + }else{ + return "Unknown BBQ log test scenario."; + } + if (logger.messages != expected){ + return "Unexpected BBQ diagnostic log sequence for " + m_scenario; + } + return true; + } + +private: + const std::string m_scenario; +}; + } void add_tests(UnitTestDatabase& database){ + for (const char* scenario : {"board", "success", "retry-exhausted", "long-duration"}){ + database.add(scenario); + } database.add(); add_tests_WhiteButtonDetector(database); add_tests_BoxInfoDetector(database); diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.cpp new file mode 100644 index 0000000000..ce408705c0 --- /dev/null +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.cpp @@ -0,0 +1,94 @@ +/* BBQ Diagnostic Logger + * + * From: https://github.com/PokemonAutomation/ + * + */ + +#include +#include +#include "Common/Cpp/PrettyPrint.h" +#include "PokemonSV_BBQLogger.h" + +namespace PokemonAutomation{ +namespace NintendoSwitch{ +namespace PokemonSV{ + + +namespace{ + +constexpr std::string_view UNKNOWN = "unknown"; + +std::string_view quest_label(BBQuests quest){ + const std::string& slug = BBQuests_enum_to_string(quest); + return slug.empty() ? UNKNOWN : std::string_view(slug); +} + +void append_elapsed(std::ostream& out, std::string_view field, BBQAttemptLog::Clock::duration elapsed){ + const auto milliseconds = std::chrono::duration_cast(elapsed); + out << ' ' << field << "_ms=" << milliseconds.count() + << ' ' << field << "=\"" << duration_to_string(milliseconds) << '\"'; +} + +} + + +void BBQLogger::board(bool panel_detected, const std::vector& quests){ + std::ostringstream out; + out << "BBQ event=board panel_detected=" << panel_detected << " quests="; + bool first = true; + for (BBQuests quest : quests){ + if (!first) out << ','; + first = false; + out << quest_label(quest); + } + m_logger.log(out.str()); +} + +void BBQLogger::battle_entry_timeout(BBQuests quest){ + std::ostringstream out; + out << "BBQ quest=" << quest_label(quest) << " event=battle_entry outcome=timeout"; + m_logger.log(out.str()); +} + +void BBQLogger::retry_exhausted(BBQuests quest){ + std::ostringstream out; + out << "BBQ quest=" << quest_label(quest) << " event=retry_exhausted recovery=skip_current_batch"; + m_logger.log(out.str()); +} + + +BBQAttemptLog::BBQAttemptLog( + Logger& logger, BBQuests quest, + unsigned attempt, unsigned limit, + Clock::time_point start +) + : m_logger(logger), m_start(start), m_route_end(start) +{ + std::ostringstream out; + out << "BBQ quest=" << quest_label(quest) << " attempt=" << attempt << " limit=" << limit; + m_attempt_description = out.str(); + out << " event=start"; + m_logger.log(out.str()); +} + +void BBQAttemptLog::route_return(Clock::time_point end){ + m_route_end = end; + std::ostringstream out; + out << m_attempt_description << " event=route_return"; + append_elapsed(out, "elapsed", end - m_start); + m_logger.log(out.str()); +} + +void BBQAttemptLog::result(bool completed, Clock::time_point end){ + std::ostringstream out; + out << m_attempt_description << " event=result outcome=" + << (completed ? "absent_from_board" : "still_on_board"); + append_elapsed(out, "verification", end - m_route_end); + append_elapsed(out, "total", end - m_start); + m_logger.log(out.str()); +} + + +} +} +} diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.h b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.h new file mode 100644 index 0000000000..cd53ba7a06 --- /dev/null +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.h @@ -0,0 +1,73 @@ +/* BBQ Diagnostic Logger + * + * From: https://github.com/PokemonAutomation/ + * + */ + +#ifndef PokemonAutomation_PokemonSV_BBQLogger_H +#define PokemonAutomation_PokemonSV_BBQLogger_H + +#include +#include +#include +#include "Common/Cpp/Logging/AbstractLogger.h" +#include "VideoGames/PokemonSV/Options/PokemonSV_BBQuests.h" + +namespace PokemonAutomation{ +namespace NintendoSwitch{ +namespace PokemonSV{ + + +// Formats one-line "BBQ ..." diagnostic events through an existing Logger. +// Does no image I/O and no controller input. +class BBQLogger{ +public: + explicit BBQLogger(Logger& logger) : m_logger(logger) {} + + // The quest board as read from one panel snapshot: whether the panel was + // detected, and the quests in board order. + void board(bool panel_detected, const std::vector& quests); + + // A catch quest gave up waiting for the battle menu after navigating to its target. + void battle_entry_timeout(BBQuests quest); + + // A quest used all of its attempts and the rest of the batch will be skipped. + void retry_exhausted(BBQuests quest); + +private: + Logger& m_logger; +}; + + +// The event sequence and monotonic timing of one quest attempt. +// Timestamps default to now; tests pass fixed values. +class BBQAttemptLog{ +public: + using Clock = std::chrono::steady_clock; + + // Logs the start of attempt number `attempt` out of `limit`. + BBQAttemptLog( + Logger& logger, BBQuests quest, + unsigned attempt, unsigned limit, + Clock::time_point start = Clock::now() + ); + + // The quest routine returned; logs the time since start. + void route_return(Clock::time_point end = Clock::now()); + + // The board was re-read. `completed` means the quest is no longer on it. + // Logs the verification time since route_return() and the total time. + void result(bool completed, Clock::time_point end = Clock::now()); + +private: + Logger& m_logger; + const Clock::time_point m_start; + Clock::time_point m_route_end; + std::string m_attempt_description; +}; + + +} +} +} +#endif diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp index ab0290f4ea..8044eb941e 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp @@ -27,6 +27,7 @@ #include "VideoGames/PokemonSV/Programs/PokemonSV_WorldNavigation.h" #include "VideoGames/PokemonSV/Programs/Battles/PokemonSV_BasicCatcher.h" #include "VideoGames/PokemonSV/Programs/PokemonSV_Terarium.h" +#include "PokemonSV_BBQLogger.h" #include #include "PokemonSV_BlueberryCatchPhoto.h" @@ -920,6 +921,7 @@ void quest_catch( ); if (ret2 != 0){ console.log("Did not enter battle. Did target spawn?"); + BBQLogger(console.logger()).battle_entry_timeout(current_quest); } }, { diff --git a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp index 6ea759ba96..1ac4eb109c 100644 --- a/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp +++ b/SerialPrograms/Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryQuests.cpp @@ -42,6 +42,7 @@ #include "VideoGames/PokemonSV/Programs/TeraRaids/PokemonSV_TeraBattler.h" #include "VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.h" #include "VideoGames/PokemonSV/Programs/PokemonSV_Terarium.h" +#include "PokemonSV_BBQLogger.h" #include "PokemonSV_BlueberryQuests.h" #include @@ -124,6 +125,8 @@ std::vector read_quests( quest_list.push_back(BBQuests_string_to_enum(fourth_quest)); } + BBQLogger(stream.logger()).board(result == 0, quest_list); + //Close quest list pbf_mash_button(context, BUTTON_B, 800ms); context.wait_for_all_requests(); @@ -323,6 +326,8 @@ bool process_and_do_quest( int quest_attempts = 0; while (!quest_completed){ + BBQAttemptLog attempt_log(console.logger(), current_quest, quest_attempts + 1, + (unsigned)BBQ_OPTIONS.NUM_RETRIES + 1); switch (current_quest){ case BBQuests::make_tm: quest_make_tm(env.program_info(), console, context); @@ -421,6 +426,7 @@ bool process_and_do_quest( break; } + attempt_log.route_return(); //Validate quest was completed by checking list std::vector quest_list = read_quests(env.program_info(), console, context, BBQ_OPTIONS); if (std::find(quest_list.begin(), quest_list.end(), current_quest) != quest_list.end()){ @@ -436,7 +442,9 @@ bool process_and_do_quest( quest_completed = true; } + attempt_log.result(quest_completed); if (quest_attempts > BBQ_OPTIONS.NUM_RETRIES){ + BBQLogger(console.logger()).retry_exhausted(current_quest); console.log("Failed to complete a quest multiple times. Skipping it for now.", COLOR_RED); break; } diff --git a/SerialPrograms/cmake/SourceFiles.cmake b/SerialPrograms/cmake/SourceFiles.cmake index aeb68781ae..261f8f32a2 100644 --- a/SerialPrograms/cmake/SourceFiles.cmake +++ b/SerialPrograms/cmake/SourceFiles.cmake @@ -2579,6 +2579,8 @@ file(GLOB LIBRARY_SOURCES Source/VideoGames/PokemonSV/Programs/Eggs/PokemonSV_EggRoutines.h Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_AuctionFarmer.cpp Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_AuctionFarmer.h + Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.cpp + Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQLogger.h Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQSoloFarmer.cpp Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BBQSoloFarmer.h Source/VideoGames/PokemonSV/Programs/Farming/PokemonSV_BlueberryCatchPhoto.cpp