refactor: Improve OverworldEditor File Handling and Code Clarity

- Added file utility header for improved resource path management.
- Enhanced ASM file handling by utilizing GetResourcePath for better compatibility across deployment scenarios.
- Cleaned up code formatting and comments for clarity, ensuring consistent indentation and readability.
- Deprecated feature flag for ZSCustomOverworld ASM application, simplifying the logic for version gating.
This commit is contained in:
scawful
2025-10-05 20:43:29 -04:00
parent f2c773dfea
commit d41fcb22a3

View File

@@ -34,6 +34,7 @@
#include "app/zelda3/overworld/overworld_map.h" #include "app/zelda3/overworld/overworld_map.h"
#include "imgui/imgui.h" #include "imgui/imgui.h"
#include "imgui_memory_editor.h" #include "imgui_memory_editor.h"
#include "util/file_util.h"
#include "util/hex.h" #include "util/hex.h"
#include "util/log.h" #include "util/log.h"
#include "util/macro.h" #include "util/macro.h"
@@ -215,7 +216,7 @@ absl::Status OverworldEditor::Update() {
} }
usage_stats_card.End(); usage_stats_card.End();
} }
// Area Configuration Panel (detailed editing) // Area Configuration Panel (detailed editing)
if (show_map_properties_panel_) { if (show_map_properties_panel_) {
ImGui::SetNextWindowSize(ImVec2(650, 750), ImGuiCond_FirstUseEver); ImGui::SetNextWindowSize(ImVec2(650, 750), ImGuiCond_FirstUseEver);
@@ -1494,13 +1495,13 @@ void OverworldEditor::ProcessDeferredTextures() {
const int max_refreshes_per_frame = 2; const int max_refreshes_per_frame = 2;
for (int i = 0; i < zelda3::kNumOverworldMaps && refresh_count < max_refreshes_per_frame; ++i) { for (int i = 0; i < zelda3::kNumOverworldMaps && refresh_count < max_refreshes_per_frame; ++i) {
if (maps_bmp_[i].modified() && maps_bmp_[i].is_active()) { if (maps_bmp_[i].modified() && maps_bmp_[i].is_active()) {
// Check if this map is in current world (prioritize) // Check if this map is in current world (prioritize)
bool is_current_world = (i / 0x40 == current_world_); bool is_current_world = (i / 0x40 == current_world_);
bool is_current_map = (i == current_map_); bool is_current_map = (i == current_map_);
if (is_current_map || is_current_world) { if (is_current_map || is_current_world) {
RefreshOverworldMapOnDemand(i); RefreshOverworldMapOnDemand(i);
refresh_count++; refresh_count++;
} }
} }
@@ -1883,14 +1884,14 @@ absl::Status OverworldEditor::RefreshMapPalette() {
// SAFETY: Only set palette if bitmap has a valid surface // SAFETY: Only set palette if bitmap has a valid surface
if (maps_bmp_[sibling_index].is_active() && maps_bmp_[sibling_index].surface()) { if (maps_bmp_[sibling_index].is_active() && maps_bmp_[sibling_index].surface()) {
maps_bmp_[sibling_index].SetPalette(current_map_palette); maps_bmp_[sibling_index].SetPalette(current_map_palette);
}
} }
} }
}
// SAFETY: Only set palette if bitmap has a valid surface // SAFETY: Only set palette if bitmap has a valid surface
if (maps_bmp_[current_map_].is_active() && maps_bmp_[current_map_].surface()) { if (maps_bmp_[current_map_].is_active() && maps_bmp_[current_map_].surface()) {
maps_bmp_[current_map_].SetPalette(current_map_palette); maps_bmp_[current_map_].SetPalette(current_map_palette);
} }
} }
@@ -2453,10 +2454,8 @@ absl::Status OverworldEditor::Clear() {
} }
absl::Status OverworldEditor::ApplyZSCustomOverworldASM(int target_version) { absl::Status OverworldEditor::ApplyZSCustomOverworldASM(int target_version) {
if (!core::FeatureFlags::get().overworld.kApplyZSCustomOverworldASM) { // Feature flag deprecated - ROM version gating is sufficient
return absl::FailedPreconditionError( // User explicitly clicked upgrade button, so respect their request
"ZSCustomOverworld ASM application is disabled in feature flags");
}
// Validate target version // Validate target version
if (target_version < 2 || target_version > 3) { if (target_version < 2 || target_version > 3) {
@@ -2483,18 +2482,23 @@ absl::Status OverworldEditor::ApplyZSCustomOverworldASM(int target_version) {
std::vector<uint8_t> working_rom_data = original_rom_data; std::vector<uint8_t> working_rom_data = original_rom_data;
try { try {
// Determine which ASM file to apply // Determine which ASM file to apply and use GetResourcePath for proper resolution
std::string asm_file_path; std::string asm_file_name = (target_version == 3)
if (target_version == 3) { ? "asm/yaze.asm" // Master file with v3
asm_file_path = "assets/asm/yaze.asm"; // Master file with v3 : "asm/ZSCustomOverworld.asm"; // v2 standalone
} else {
asm_file_path = "assets/asm/ZSCustomOverworld.asm"; // v2 standalone // Use GetResourcePath to handle app bundles and various deployment scenarios
} std::string asm_file_path = util::GetResourcePath(asm_file_name);
// Check if ASM file exists LOG_INFO("OverworldEditor", "Using ASM file: %s", asm_file_path.c_str());
// Verify file exists
if (!std::filesystem::exists(asm_file_path)) { if (!std::filesystem::exists(asm_file_path)) {
return absl::NotFoundError( return absl::NotFoundError(absl::StrFormat(
absl::StrFormat("ASM file not found: %s", asm_file_path)); "ASM file not found at: %s\n\n"
"Expected location: assets/%s\n"
"Make sure the assets directory is accessible.",
asm_file_path, asm_file_name));
} }
// Apply the ASM patch // Apply the ASM patch