diggable_tiles_patch.h

Go to the documentation of this file.

#ifndef YAZE_ZELDA3_OVERWORLD_DIGGABLE_TILES_PATCH_H
#define YAZE_ZELDA3_OVERWORLD_DIGGABLE_TILES_PATCH_H
 
#include <cstdint>
#include <string>
 
#include "absl/status/status.h"
#include "rom/rom.h"
#include "zelda3/overworld/diggable_tiles.h"
 
namespace yaze::zelda3 {
 
struct DiggableTilesPatchConfig {
  // Hook location - default is vanilla, but ZS may move this
  uint32_t hook_address = 0x1BBDF4;        // Where to insert JSL
  uint32_t diggable_handler = 0x1BBE3E;    // OverworldTileAction_Diggable
  uint32_t exit_address = 0x1BBE3B;        // .not_digging exit point
 
  // Table location in expanded ROM space
  uint32_t table_address = 0x140980;       // 64 bytes for bitfield
 
  // ZS feature detection
  bool detect_zs_hooks = true;             // Auto-detect if ZS modified this area
  bool use_zs_compatible_mode = false;     // Use alternate hook strategy for ZS ROMs
 
  // Code placement
  uint32_t freespace_address = 0x1BF000;   // Where to put new lookup routine
};
 
class DiggableTilesPatch {
 public:
  static std::string GeneratePatch(
      const DiggableTiles& diggable_tiles,
      const DiggableTilesPatchConfig& config = {});
 
  static absl::Status ExportPatchFile(
      const DiggableTiles& diggable_tiles,
      const std::string& output_path,
      const DiggableTilesPatchConfig& config = {});
 
  static bool DetectZSDiggingHooks(const Rom& rom);
 
  static DiggableTilesPatchConfig GetRecommendedConfig(const Rom& rom);
 
 private:
  static std::string GenerateVanillaRoutine(
      const DiggableTiles& diggable_tiles,
      const DiggableTilesPatchConfig& config);
 
  static std::string GenerateZSCompatibleRoutine(
      const DiggableTiles& diggable_tiles,
      const DiggableTilesPatchConfig& config);
 
  static std::string GenerateDataTable(const DiggableTiles& diggable_tiles,
                                       uint32_t table_address);
};
 
}  // namespace yaze::zelda3
 
#endif  // YAZE_ZELDA3_OVERWORLD_DIGGABLE_TILES_PATCH_H