Merge branch 'main' of https://github.com/PokemonAutomation/Arduino-Source

Author: Mysticial

.gitignore

@@ -52,3 +52,6 @@ opencv_world4110d.dll
 
 # Python cache
 __pycache__
+
+# Jupyter Notebooks
+*.ipynb

SerialPrograms/CMakeLists.txt

@@ -992,13 +992,13 @@ file(GLOB MAIN_SOURCES
     Source/NintendoSwitch/Options/UI/NintendoSwitch_FriendCodeListWidget.h
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip.cpp
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip.h
+    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipBase.h
+    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipTools.cpp
+    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipTools.h
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip_24h.cpp
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip_24h.h
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip_US.cpp
     Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManip_US.h
-    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipBase.h
-    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipTools.cpp
-    Source/NintendoSwitch/Programs/DateManip/NintendoSwitch_DateManipTools.h
     Source/NintendoSwitch/Programs/DateSpam/NintendoSwitch_HomeToDateTime.cpp
     Source/NintendoSwitch/Programs/DateSpam/NintendoSwitch_HomeToDateTime.h
     Source/NintendoSwitch/Programs/DateSpam/NintendoSwitch_NeutralDateSkip.cpp
@@ -1058,6 +1058,8 @@ file(GLOB MAIN_SOURCES
     Source/Pokemon/Inference/Pokemon_TrainPokemonOCR.cpp
     Source/Pokemon/Inference/Pokemon_TrainPokemonOCR.h
     Source/Pokemon/Options/Pokemon_EncounterBotOptions.h
+    Source/Pokemon/Options/Pokemon_HomeSpriteSelectOption.cpp
+    Source/Pokemon/Options/Pokemon_HomeSpriteSelectOption.h
     Source/Pokemon/Options/Pokemon_IvJudgeOption.cpp
     Source/Pokemon/Options/Pokemon_IvJudgeOption.h
     Source/Pokemon/Options/Pokemon_NameSelectOption.cpp
@@ -1093,6 +1095,10 @@ file(GLOB MAIN_SOURCES
     Source/Pokemon/Resources/Pokemon_EggSteps.h
     Source/Pokemon/Resources/Pokemon_PokeballNames.cpp
     Source/Pokemon/Resources/Pokemon_PokeballNames.h
+    Source/Pokemon/Resources/Pokemon_PokemonForms.cpp
+    Source/Pokemon/Resources/Pokemon_PokemonForms.h
+    Source/Pokemon/Resources/Pokemon_PokemonHomeSprites.cpp
+    Source/Pokemon/Resources/Pokemon_PokemonHomeSprites.h
     Source/Pokemon/Resources/Pokemon_PokemonNames.cpp
     Source/Pokemon/Resources/Pokemon_PokemonNames.h
     Source/Pokemon/Resources/Pokemon_PokemonSlugs.cpp

SerialPrograms/Source/CommonTools/Resources/SpriteDatabase.h

@@ -42,10 +42,6 @@ class SpriteDatabase{
     const Sprite& get_throw(const std::string& slug) const;
     const Sprite* get_nothrow(const std::string& slug) const;
 
-    const std::map<std::string, Sprite>& get() const{
-        return m_database;
-    }
-
 public:
     using const_iterator = std::map<std::string, Sprite>::const_iterator;
     using       iterator = std::map<std::string, Sprite>::iterator;

SerialPrograms/Source/ML/Programs/ML_LabelImages.cpp

@@ -180,12 +180,14 @@ LabelImages::LabelImages(const LabelImages_Descriptor& descriptor)
     , Y("<b>Y Coordinate:</b>", LockMode::UNLOCK_WHILE_RUNNING, 0.3, 0.0, 1.0)
     , WIDTH("<b>Width:</b>", LockMode::UNLOCK_WHILE_RUNNING, 0.4, 0.0, 1.0)
     , HEIGHT("<b>Height:</b>", LockMode::UNLOCK_WHILE_RUNNING, 0.4, 0.0, 1.0)
+    , FORM_LABEL("bulbasaur")
     , m_sam_session{RESOURCE_PATH() + "ML/sam_cpu.onnx"}
 {
     ADD_OPTION(X);
     ADD_OPTION(Y);
     ADD_OPTION(WIDTH);
     ADD_OPTION(HEIGHT);
+    ADD_OPTION(FORM_LABEL);
 }
 void LabelImages::from_json(const JsonValue& json){
     const JsonObject* obj = json.to_object();

SerialPrograms/Source/ML/Programs/ML_LabelImages.h

@@ -13,7 +13,7 @@
 #include "CommonFramework/Panels/UI/PanelWidget.h"
 #include "CommonFramework/ImageTypes/ImageViewRGB32.h"
 #include "CommonFramework/ImageTypes/ImageRGB32.h"
-// #include "CommonFramework/VideoPipeline/VideoOverlayTypes.h"
+#include "Pokemon/Options/Pokemon_HomeSpriteSelectOption.h"
 #include "NintendoSwitch/Framework/NintendoSwitch_SwitchSystemOption.h"
 #include "NintendoSwitch/Framework/NintendoSwitch_SwitchSystemSession.h"
 #include "CommonFramework/VideoPipeline/VideoOverlayScopes.h"
@@ -65,6 +65,7 @@ class LabelImages : public PanelInstance{
     FloatingPointOption Y;
     FloatingPointOption WIDTH;
     FloatingPointOption HEIGHT;
+    Pokemon::HomeSpriteSelectCell FORM_LABEL;
 
     size_t source_image_height = 0;
     size_t source_image_width = 0;

SerialPrograms/Source/Pokemon/Options/Pokemon_HomeSpriteSelectOption.cpp

@@ -0,0 +1,57 @@
+/*  HomeSprite Selector, UI component to select multiple berries
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "Common/Cpp/Exceptions.h"
+#include "CommonFramework/Logging/Logger.h"
+#include "Pokemon/Resources/Pokemon_PokemonForms.h"
+#include "Pokemon/Resources/Pokemon_PokemonHomeSprites.h"
+#include "Pokemon_HomeSpriteSelectOption.h"
+
+namespace PokemonAutomation{
+namespace Pokemon{
+
+
+StringSelectDatabase make_all_home_sprites_database(){
+    StringSelectDatabase ret;
+    for(const auto& slug: ALL_POKEMON_FORMS()){
+    // for(const auto& p: ALL_POKEMON_HOME_SPRITES().get()){
+        const SpriteDatabase::Sprite* sprite = ALL_POKEMON_HOME_SPRITES().get_nothrow(slug);
+        const PokemonForm* form_ptr = get_pokemon_form(slug);
+        if (form_ptr == nullptr){
+            throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "A form slug is in ALL_POKEMON_FORMS but not available in get_pokemon_form() : " + slug);
+        }
+        if (sprite == nullptr){
+            // we don't have the sprite. Use a replacement sprite instead:
+            const auto& no_show_sprite = ALL_POKEMON_HOME_SPRITES().get_throw("floette-eternal-flower");
+            ret.add_entry(StringSelectEntry(slug, form_ptr->display_name(), no_show_sprite.icon));
+        } else{
+            ret.add_entry(StringSelectEntry(slug, form_ptr->display_name(), sprite->icon));
+        }
+    }
+    
+    return ret;
+}
+const StringSelectDatabase& ALL_HOME_SPRITES_SELECT_DATABASE(){
+    static StringSelectDatabase database = make_all_home_sprites_database();
+    return database;
+}
+
+
+
+
+HomeSpriteSelectCell::HomeSpriteSelectCell(
+    const std::string& default_slug
+)
+    : StringSelectCell(
+        ALL_HOME_SPRITES_SELECT_DATABASE(),
+        LockMode::LOCK_WHILE_RUNNING,
+        default_slug
+    )
+{}
+
+
+}
+}

SerialPrograms/Source/Pokemon/Options/Pokemon_HomeSpriteSelectOption.h

@@ -0,0 +1,29 @@
+/*  HomeSprite Selector, UI component to select multiple berries
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_PokemonBDSP_HomeSpriteSelectOption_H
+#define PokemonAutomation_PokemonBDSP_HomeSpriteSelectOption_H
+
+#include "CommonTools/Options/StringSelectOption.h"
+
+namespace PokemonAutomation{
+namespace Pokemon{
+
+
+
+// Option to select a pokemon form with a Pokemon Home sprite shown.
+// The forms are all the unique forms including shiny and non-shiny.
+class HomeSpriteSelectCell : public StringSelectCell{
+public:
+    HomeSpriteSelectCell(const std::string& default_slug);
+};
+
+
+
+
+}
+}
+#endif

SerialPrograms/Source/Pokemon/Resources/Pokemon_PokemonForms.cpp

@@ -0,0 +1,137 @@
+/*  Pokemon Forms
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+
+#include <string>
+#include <vector>
+#include <map>
+#include <iostream>
+#include <set>
+#include <fstream>
+#include "Common/Cpp/Json/JsonValue.h"
+#include "Common/Cpp/Json/JsonObject.h"
+#include "Common/Cpp/Json/JsonArray.h"
+#include "CommonFramework/Globals.h"
+#include "Pokemon_PokemonNames.h"
+#include "Pokemon_PokemonForms.h"
+#include "Pokemon_PokemonSlugs.h"
+
+namespace PokemonAutomation{
+namespace Pokemon{
+
+
+struct PokemonFormDatabase{
+    PokemonFormDatabase();
+    static const PokemonFormDatabase& instance(){
+        static PokemonFormDatabase database;
+        return database;
+    }
+
+    std::map<std::string, PokemonForm> m_slug_to_form;
+    std::vector<std::string> m_slugs;
+};
+
+bool is_form_shiny(const std::string& form_slug){
+    const std::string& suffix = "-shiny";
+    if (form_slug.length() < suffix.length()) {
+           return false;
+       }
+    return form_slug.compare(form_slug.length() - suffix.length(), suffix.length(), suffix) == 0;
+}
+
+bool PokemonForm::is_shiny() const {
+    return is_form_shiny(m_slug);
+}
+
+PokemonFormDatabase::PokemonFormDatabase(){
+    // Load form map JSON
+    const std::string form_display_map_path = RESOURCE_PATH() + "Pokemon/AllFormDisplayMap.json";
+    JsonValue json = load_json_file(form_display_map_path);
+    // a map from form slug to list of tuples, where each tuple contains a form slug and a display name
+    JsonObject& form_displays = json.to_object_throw(form_display_map_path);
+
+    const std::string no_shiny_pokemon_path = RESOURCE_PATH() + "Pokemon/SpecialPokemonWithNoShinyForm.txt";
+    std::ifstream fin(no_shiny_pokemon_path);
+    if (!fin.is_open()) {
+        throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "canot open resource file: " + no_shiny_pokemon_path);
+    }
+    std::string line;
+    std::set<std::string> no_shiny_forms;
+    while (std::getline(fin, line)) {
+        fin >> std::ws;
+        no_shiny_forms.emplace(std::move(line));
+    }
+
+    for(const auto& species_slug: NATIONAL_DEX_SLUGS()){
+        const std::string& species_display_name = get_pokemon_name(species_slug).display_name();
+        const JsonArray* form_array = form_displays.get_array(species_slug);
+        if (form_array == nullptr){
+            // there is a single form for this species
+            m_slug_to_form.emplace(species_slug, PokemonForm(species_slug, species_display_name, species_slug));
+            std::string shiny_slug = species_slug + "-shiny";
+            m_slug_to_form.emplace(shiny_slug, PokemonForm(shiny_slug, "Shiny " + species_display_name, species_slug));
+            m_slugs.push_back(species_slug);
+            m_slugs.emplace_back(std::move(shiny_slug));
+            continue;
+        }
+
+        bool has_shiny_form = false;
+        std::vector<std::map<std::string, PokemonForm>::const_iterator> forms;
+        for (const auto& form : *form_array){
+            // form is a list of two elements, first the form slug name, second the display name
+            const JsonArray* form_ptr = form.to_array();
+            if (form_ptr == nullptr){
+                throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "No [form_slug, display_name] format in form display map: " + species_slug);
+            }
+            const JsonArray& form_slug_and_display = *form_ptr;
+            if (form_slug_and_display.size() != 2){
+                throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Wrong [form_slug, display_name] length in form display map: " + species_slug);
+            }
+            const std::string& form_slug = form_slug_and_display[0].to_string_throw();
+            const std::string& display_name = form_slug_and_display[1].to_string_throw();
+            if (form_slug.empty() || display_name.empty()){
+                throw InternalProgramError(nullptr, PA_CURRENT_FUNCTION, "Empty string in [form_slug, display_name] in form display map: " + species_slug);
+            }
+            if (is_form_shiny(form_slug)){
+                has_shiny_form = true;
+            }
+            const auto it = m_slug_to_form.emplace(form_slug, PokemonForm(form_slug, display_name, species_slug)).first;
+            m_slugs.push_back(form_slug);
+            forms.push_back(it);
+        }
+        if (!has_shiny_form){ // if no explict shiny form loaded, we build it our own
+            for (const auto& it: forms){
+                const auto& form = it->second;   
+                if (no_shiny_forms.find(form.m_slug) != no_shiny_forms.end()){
+                    continue; // this form has no shiny
+                }
+                std::string shiny_slug = form.m_slug + "-shiny";
+                m_slug_to_form.emplace(shiny_slug, PokemonForm(
+                    shiny_slug, "Shiny " + form.m_display_name, form.m_species
+                ));
+                m_slugs.emplace_back(std::move(shiny_slug));
+            }
+        }
+    }
+    std::cout << "Loaded " << m_slug_to_form.size() << " form slugs" << std::endl;
+}
+
+const PokemonForm* get_pokemon_form(const std::string& slug){
+    const auto& slug_to_form = PokemonFormDatabase::instance().m_slug_to_form;
+    const auto it = slug_to_form.find(slug);
+    if (it == slug_to_form.end()){
+        return nullptr;
+    }
+    return &it->second;
+}
+
+const std::vector<std::string>& ALL_POKEMON_FORMS(){
+    return PokemonFormDatabase::instance().m_slugs;
+}
+
+
+}
+}

SerialPrograms/Source/Pokemon/Resources/Pokemon_PokemonForms.h

@@ -0,0 +1,51 @@
+/*  Pokemon Forms
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_Pokemon_PokemonForms_H
+#define PokemonAutomation_Pokemon_PokemonForms_H
+
+#include <string>
+#include <vector>
+
+namespace PokemonAutomation{
+namespace Pokemon{
+
+
+// slug and display names related to a pokemon form
+class PokemonForm{
+public:
+    const std::string& slug() const{ return m_slug; }
+    const std::string& display_name() const{ return m_display_name; }
+    bool is_shiny() const;
+    // slug of the base species
+    const std::string& species() const { return m_species; }
+    // const PokemonForm& shiny_form() const;
+    // const PokemonForm& non_shiny_form() const;
+
+private:
+    PokemonForm(std::string slug, std::string display_name, std::string species)
+    : m_slug(std::move(slug)), m_display_name(std::move(display_name)), m_species(std::move(species)) {}
+    friend struct PokemonFormDatabase;
+
+    std::string m_slug;
+    std::string m_display_name;
+    std::string m_species;
+};
+
+
+// Given a slug, find the form related data
+// You can find all form slugs with unique appearance from the map keys of:
+// Pokemon_PokemonHomeSprites.h:ALL_POKEMON_HOME_SPRITES().get()
+// If no such slug is found, return nullptr
+const PokemonForm* get_pokemon_form(const std::string& form_slug);
+
+// Get a vector of form slugs. Each slug is a form with unique appearance
+// that has a unique sprite loaded in Pokemon_PokemonHomeSprites.h:ALL_POKEMON_HOME_SPRITES()
+const std::vector<std::string>& ALL_POKEMON_FORMS();
+
+}
+}
+#endif

SerialPrograms/Source/Pokemon/Resources/Pokemon_PokemonHomeSprites.cpp

@@ -0,0 +1,23 @@
+/*  Pokemon Home Sprites
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "Pokemon_PokemonHomeSprites.h"
+
+namespace PokemonAutomation{
+namespace Pokemon{
+
+
+
+const SpriteDatabase& ALL_POKEMON_HOME_SPRITES(){
+    static const SpriteDatabase database("Pokemon/AllHomeSprites.png", "Pokemon/AllHomeSprites.json");
+    return database;
+}
+
+
+
+
+}
+}