#include #include #include #include #include #include #include #include namespace hex::plugin::builtin { namespace { class AchievementStartingOut : public Achievement { public: explicit AchievementStartingOut(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.starting_out", std::move(unlocalizedName)) { } }; class AchievementHexEditor : public Achievement { public: explicit AchievementHexEditor(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.hex_editor", std::move(unlocalizedName)) { } }; class AchievementPatterns : public Achievement { public: explicit AchievementPatterns(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.patterns", std::move(unlocalizedName)) { } }; class AchievementDataProcessor : public Achievement { public: explicit AchievementDataProcessor(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.data_processor", std::move(unlocalizedName)) { } }; class AchievementFind : public Achievement { public: explicit AchievementFind(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.find", std::move(unlocalizedName)) { } }; class AchievementMisc : public Achievement { public: explicit AchievementMisc(UnlocalizedString unlocalizedName) : Achievement("hex.builtin.achievement.misc", std::move(unlocalizedName)) { } }; void registerGettingStartedAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.starting_out.docs.name") .setDescription("hex.builtin.achievement.starting_out.docs.desc") .setIcon(romfs::get("assets/achievements/open-book.png").span()); AchievementManager::addAchievement("hex.builtin.achievement.starting_out.open_file.name") .setDescription("hex.builtin.achievement.starting_out.open_file.desc") .setIcon(romfs::get("assets/achievements/page-facing-up.png").span()); AchievementManager::addAchievement("hex.builtin.achievement.starting_out.save_project.name") .setDescription("hex.builtin.achievement.starting_out.save_project.desc") .setIcon(romfs::get("assets/achievements/card-index-dividers.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.starting_out.crash.name") .setDescription("hex.builtin.achievement.starting_out.crash.desc") .setIcon(romfs::get("assets/achievements/collision-symbol.png").span()) .setInvisible(); } void registerHexEditorAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.select_byte.name") .setDescription("hex.builtin.achievement.hex_editor.select_byte.desc") .setIcon(romfs::get("assets/achievements/bookmark-tabs.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.open_new_view.name") .setDescription("hex.builtin.achievement.hex_editor.open_new_view.desc") .setIcon(romfs::get("assets/achievements/frame-with-picture.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.create_bookmark.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.modify_byte.name") .setDescription("hex.builtin.achievement.hex_editor.modify_byte.desc") .setIcon(romfs::get("assets/achievements/pencil.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.select_byte.name") .addVisibilityRequirement("hex.builtin.achievement.hex_editor.select_byte.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.copy_as.name") .setDescription("hex.builtin.achievement.hex_editor.copy_as.desc") .setIcon(romfs::get("assets/achievements/copy.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.modify_byte.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.create_patch.name") .setDescription("hex.builtin.achievement.hex_editor.create_patch.desc") .setIcon(romfs::get("assets/achievements/adhesive-bandage.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.modify_byte.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.fill.name") .setDescription("hex.builtin.achievement.hex_editor.fill.desc") .setIcon(romfs::get("assets/achievements/water-wave.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.select_byte.name") .addVisibilityRequirement("hex.builtin.achievement.hex_editor.select_byte.name"); AchievementManager::addAchievement("hex.builtin.achievement.hex_editor.create_bookmark.name") .setDescription("hex.builtin.achievement.hex_editor.create_bookmark.desc") .setIcon(romfs::get("assets/achievements/bookmark.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.select_byte.name") .addVisibilityRequirement("hex.builtin.achievement.hex_editor.select_byte.name"); } void registerPatternsAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.patterns.place_menu.name") .setDescription("hex.builtin.achievement.patterns.place_menu.desc") .setIcon(romfs::get("assets/achievements/clipboard.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.select_byte.name"); AchievementManager::addAchievement("hex.builtin.achievement.patterns.load_existing.name") .setDescription("hex.builtin.achievement.patterns.load_existing.desc") .setIcon(romfs::get("assets/achievements/hourglass.png").span()) .addRequirement("hex.builtin.achievement.patterns.place_menu.name"); AchievementManager::addAchievement("hex.builtin.achievement.patterns.modify_data.name") .setDescription("hex.builtin.achievement.patterns.modify_data.desc") .setIcon(romfs::get("assets/achievements/hammer.png").span()) .addRequirement("hex.builtin.achievement.patterns.place_menu.name"); AchievementManager::addAchievement("hex.builtin.achievement.patterns.data_inspector.name") .setDescription("hex.builtin.achievement.patterns.data_inspector.desc") .setIcon(romfs::get("assets/achievements/eye-in-speech-bubble.png").span()) .addRequirement("hex.builtin.achievement.hex_editor.select_byte.name"); } void registerFindAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.find.find_strings.name") .setDescription("hex.builtin.achievement.find.find_strings.desc") .setIcon(romfs::get("assets/achievements/ring.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.find.find_specific_string.name") .setDescription("hex.builtin.achievement.find.find_specific_string.desc") .setIcon(romfs::get("assets/achievements/right-pointing-magnifying-glass.png").span()) .addRequirement("hex.builtin.achievement.find.find_strings.name"); AchievementManager::addAchievement("hex.builtin.achievement.find.find_numeric.name") .setDescription("hex.builtin.achievement.find.find_numeric.desc") .setIcon(romfs::get("assets/achievements/abacus.png").span()) .addRequirement("hex.builtin.achievement.find.find_strings.name"); } void registerDataProcessorAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.data_processor.place_node.name") .setDescription("hex.builtin.achievement.data_processor.place_node.desc") .setIcon(romfs::get("assets/achievements/cloud.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.data_processor.create_connection.name") .setDescription("hex.builtin.achievement.data_processor.create_connection.desc") .setIcon(romfs::get("assets/achievements/linked-paperclips.png").span()) .addRequirement("hex.builtin.achievement.data_processor.place_node.name"); AchievementManager::addAchievement("hex.builtin.achievement.data_processor.modify_data.name") .setDescription("hex.builtin.achievement.data_processor.modify_data.desc") .setIcon(romfs::get("assets/achievements/hammer-and-pick.png").span()) .addRequirement("hex.builtin.achievement.data_processor.create_connection.name"); AchievementManager::addAchievement("hex.builtin.achievement.data_processor.custom_node.name") .setDescription("hex.builtin.achievement.data_processor.custom_node.desc") .setIcon(romfs::get("assets/achievements/wrench.png").span()) .addRequirement("hex.builtin.achievement.data_processor.create_connection.name"); } void registerMiscAchievements() { AchievementManager::addAchievement("hex.builtin.achievement.misc.analyze_file.name") .setDescription("hex.builtin.achievement.misc.analyze_file.desc") .setIcon(romfs::get("assets/achievements/brain.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.misc.download_from_store.name") .setDescription("hex.builtin.achievement.misc.download_from_store.desc") .setIcon(romfs::get("assets/achievements/package.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); AchievementManager::addAchievement("hex.builtin.achievement.misc.create_hash.name") .setDescription("hex.builtin.achievement.misc.create_hash.desc") .setIcon(romfs::get("assets/achievements/fortune-cookie.png").span()) .addRequirement("hex.builtin.achievement.starting_out.open_file.name"); } void registerEvents() { EventRegionSelected::subscribe([](const auto ®ion) { if (region.getSize() > 1) AchievementManager::unlockAchievement("hex.builtin.achievement.hex_editor", "hex.builtin.achievement.hex_editor.select_byte.name"); }); EventBookmarkCreated::subscribe([](const auto&) { AchievementManager::unlockAchievement("hex.builtin.achievement.hex_editor", "hex.builtin.achievement.hex_editor.create_bookmark.name"); }); EventPatchCreated::subscribe([](u64, u8, u8) { AchievementManager::unlockAchievement("hex.builtin.achievement.hex_editor", "hex.builtin.achievement.hex_editor.modify_byte.name"); }); EventImHexStartupFinished::subscribe(AchievementManager::loadProgress); EventAchievementUnlocked::subscribe([](const Achievement &) { AchievementManager::storeProgress(); }); // Clear temporary achievements when the last provider is closed EventProviderChanged::subscribe([](hex::prv::Provider *oldProvider, const hex::prv::Provider *newProvider) { hex::unused(oldProvider); if (newProvider == nullptr) { AchievementManager::clearTemporary(); } }); } void registerChallengeAchievementHandlers() { static std::string challengeAchievement; static std::string challengeDescription; static std::map> icons; ProjectFile::registerHandler({ .basePath = "challenge", .required = false, .load = [](const std::fs::path &basePath, Tar &tar) { if (!tar.contains(basePath / "achievements.json") || !tar.contains(basePath / "description.txt")) return true; challengeAchievement = tar.readString(basePath / "achievements.json"); challengeDescription = tar.readString(basePath / "description.txt"); nlohmann::json unlockedJson; if (tar.contains(basePath / "unlocked.json")) { unlockedJson = nlohmann::json::parse(tar.readString(basePath / "unlocked.json")); } try { auto json = nlohmann::json::parse(challengeAchievement); if (json.contains("achievements")) { for (const auto &achievement : json["achievements"]) { auto &newAchievement = AchievementManager::addTemporaryAchievement("hex.builtin.achievement.challenge", achievement["name"]) .setDescription(achievement["description"]); if (achievement.contains("icon")) { if (const auto &icon = achievement["icon"]; icon.is_string() && !icon.is_null()) { auto iconPath = icon.get(); auto data = tar.readVector(basePath / iconPath); newAchievement.setIcon(data); icons[iconPath] = std::move(data); } } if (achievement.contains("requirements")) { if (const auto &requirements = achievement["requirements"]; requirements.is_array()) { for (const auto &requirement : requirements) { newAchievement.addRequirement(requirement.get()); } } } if (achievement.contains("visibility_requirements")) { if (const auto &requirements = achievement["visibility_requirements"]; requirements.is_array()) { for (const auto &requirement : requirements) { newAchievement.addVisibilityRequirement(requirement.get()); } } } if (achievement.contains("password")) { if (const auto &password = achievement["password"]; password.is_string() && !password.is_null()) { newAchievement.setClickCallback([password = password.get()](Achievement &achievement) { if (password.empty()) achievement.setUnlocked(true); else PopupTextInput::open("Enter Password", "Enter the password to unlock this achievement", [password, &achievement](const std::string &input) { if (input == password) achievement.setUnlocked(true); else PopupInfo::open("The password you entered was incorrect."); }); }); if (unlockedJson.contains("achievements") && unlockedJson["achievements"].is_array()) { for (const auto &unlockedAchievement : unlockedJson["achievements"]) { if (unlockedAchievement.is_string() && unlockedAchievement.get() == achievement["name"].get()) { newAchievement.setUnlocked(true); break; } } } } } } } } catch (const nlohmann::json::exception &e) { log::error("Failed to load challenge project: {}", e.what()); return false; } PopupInfo::open(challengeDescription); return true; }, .store = [](const std::fs::path &basePath, Tar &tar) { if (!challengeAchievement.empty()) tar.writeString(basePath / "achievements.json", challengeAchievement); if (!challengeDescription.empty()) tar.writeString(basePath / "description.txt", challengeDescription); for (const auto &[iconPath, data] : icons) { tar.writeVector(basePath / iconPath, data); } nlohmann::json unlockedJson; unlockedJson["achievements"] = nlohmann::json::array(); for (const auto &[categoryName, achievements] : AchievementManager::getAchievements()) { for (const auto &[achievementName, achievement] : achievements) { if (achievement->isTemporary() && achievement->isUnlocked()) { unlockedJson["achievements"].push_back(achievementName); } } } tar.writeString(basePath / "unlocked.json", unlockedJson.dump(4)); return true; } }); } } void registerAchievements() { registerGettingStartedAchievements(); registerHexEditorAchievements(); registerPatternsAchievements(); registerFindAchievements(); registerDataProcessorAchievements(); registerMiscAchievements(); registerEvents(); registerChallengeAchievementHandlers(); } }