zelda.h

Go to the documentation of this file.

#ifndef ZELDA_H
#define ZELDA_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
typedef enum zelda3_version {
  ZELDA3_VERSION_UNKNOWN = 0, 
  ZELDA3_VERSION_US = 1,      
  ZELDA3_VERSION_JP = 2,      
  ZELDA3_VERSION_EU = 3,      
  ZELDA3_VERSION_PROTO = 4,   
  ZELDA3_VERSION_RANDOMIZER = 5, 
  // Legacy aliases for backward compatibility
  US = ZELDA3_VERSION_US,     
  JP = ZELDA3_VERSION_JP,     
  SD = ZELDA3_VERSION_PROTO,  
  RANDO = ZELDA3_VERSION_RANDOMIZER, 
} zelda3_version;
 
zelda3_version zelda3_detect_version(const uint8_t* rom_data, size_t size);
 
const char* zelda3_version_to_string(zelda3_version version);
 
typedef struct zelda3_version_pointers {
  // New Google C++ style names
  uint32_t gfx_animated_pointer;           
  uint32_t overworld_gfx_groups1;          
  uint32_t overworld_gfx_groups2;          
  uint32_t compressed_map32_pointers_high; 
  uint32_t compressed_map32_pointers_low;  
  uint32_t overworld_map_palette_group;    
  uint32_t overlay_pointers;               
  uint32_t overlay_pointers_bank;          
  uint32_t overworld_tiles_type;           
  uint32_t overworld_gfx_ptr1;            
  uint32_t overworld_gfx_ptr2;            
  uint32_t overworld_gfx_ptr3;            
  uint32_t map32_tile_tl;                 
  uint32_t map32_tile_tr;                 
  uint32_t map32_tile_bl;                 
  uint32_t map32_tile_br;                 
  uint32_t sprite_blockset_pointer;        
  uint32_t dungeon_palettes_groups;       
  // Legacy aliases for backward compatibility (deprecated)
  uint32_t kGfxAnimatedPointer;           
  uint32_t kOverworldGfxGroups1;          
  uint32_t kOverworldGfxGroups2;          
  uint32_t kCompressedAllMap32PointersHigh; 
  uint32_t kCompressedAllMap32PointersLow;  
  uint32_t kOverworldMapPaletteGroup;    
  uint32_t kOverlayPointers;             
  uint32_t kOverlayPointersBank;         
  uint32_t kOverworldTilesType;          
  uint32_t kOverworldGfxPtr1;            
  uint32_t kOverworldGfxPtr2;            
  uint32_t kOverworldGfxPtr3;            
  uint32_t kMap32TileTL;                 
  uint32_t kMap32TileTR;                 
  uint32_t kMap32TileBL;                 
  uint32_t kMap32TileBR;                 
  uint32_t kSpriteBlocksetPointer;       
  uint32_t kDungeonPalettesGroups;       
} zelda3_version_pointers;
 
const zelda3_version_pointers* zelda3_get_version_pointers(zelda3_version version);
 
const static zelda3_version_pointers zelda3_us_pointers = {
    // New style names
    0x10275,  // gfx_animated_pointer
    0x5D97,   // overworld_gfx_groups1
    0x6073,   // overworld_gfx_groups2
    0x1794D,  // compressed_map32_pointers_high
    0x17B2D,  // compressed_map32_pointers_low
    0x75504,  // overworld_map_palette_group
    0x77664,  // overlay_pointers
    0x0E,     // overlay_pointers_bank
    0x71459,  // overworld_tiles_type
    0x4F80,   // overworld_gfx_ptr1
    0x505F,   // overworld_gfx_ptr2
    0x513E,   // overworld_gfx_ptr3
    0x18000,  // map32_tile_tl
    0x1B400,  // map32_tile_tr
    0x20000,  // map32_tile_bl
    0x23400,  // map32_tile_br
    0x5B57,   // sprite_blockset_pointer
    0x75460,  // dungeon_palettes_groups
    
    // Legacy k-prefixed names (same values for backward compatibility)
    0x10275,  // kGfxAnimatedPointer
    0x5D97,   // kOverworldGfxGroups1
    0x6073,   // kOverworldGfxGroups2
    0x1794D,  // kCompressedAllMap32PointersHigh
    0x17B2D,  // kCompressedAllMap32PointersLow
    0x75504,  // kOverworldMapPaletteGroup
    0x77664,  // kOverlayPointers
    0x0E,     // kOverlayPointersBank
    0x71459,  // kOverworldTilesType
    0x4F80,   // kOverworldGfxPtr1
    0x505F,   // kOverworldGfxPtr2
    0x513E,   // kOverworldGfxPtr3
    0x18000,  // kMap32TileTL
    0x1B400,  // kMap32TileTR
    0x20000,  // kMap32TileBL
    0x23400,  // kMap32TileBR
    0x5B57,   // kSpriteBlocksetPointer
    0x75460,  // kDungeonPalettesGroups
};
 
const static zelda3_version_pointers zelda3_jp_pointers = {
    // New style names
    0x10624,  // gfx_animated_pointer
    0x5DD7,   // overworld_gfx_groups1
    0x60B3,   // overworld_gfx_groups2
    0x176B1,  // compressed_map32_pointers_high
    0x17891,  // compressed_map32_pointers_low
    0x67E74,  // overworld_map_palette_group
    0x3FAF4,  // overlay_pointers
    0x07,     // overlay_pointers_bank
    0x7FD94,  // overworld_tiles_type
    0x4FC0,   // overworld_gfx_ptr1
    0x509F,   // overworld_gfx_ptr2
    0x517E,   // overworld_gfx_ptr3
    0x18000,  // map32_tile_tl
    0x1B3C0,  // map32_tile_tr
    0x20000,  // map32_tile_bl
    0x233C0,  // map32_tile_br
    0x5B97,   // sprite_blockset_pointer
    0x67DD0,  // dungeon_palettes_groups
    
    // Legacy k-prefixed names (same values for backward compatibility)
    0x10624,  // kGfxAnimatedPointer
    0x5DD7,   // kOverworldGfxGroups1
    0x60B3,   // kOverworldGfxGroups2
    0x176B1,  // kCompressedAllMap32PointersHigh
    0x17891,  // kCompressedAllMap32PointersLow
    0x67E74,  // kOverworldMapPaletteGroup
    0x3FAF4,  // kOverlayPointers
    0x07,     // kOverlayPointersBank
    0x7FD94,  // kOverworldTilesType
    0x4FC0,   // kOverworldGfxPtr1
    0x509F,   // kOverworldGfxPtr2
    0x517E,   // kOverworldGfxPtr3
    0x18000,  // kMap32TileTL
    0x1B3C0,  // kMap32TileTR
    0x20000,  // kMap32TileBL
    0x233C0,  // kMap32TileBR
    0x5B97,   // kSpriteBlocksetPointer
    0x67DD0,  // kDungeonPalettesGroups
};
 
typedef struct zelda3_rom {
  const char* filename;    
  uint8_t* data;          
  uint64_t size;          
  zelda3_version version; 
  bool is_modified;       
  void* impl;            
} zelda3_rom;
 
zelda3_rom* yaze_load_rom(const char* filename);
 
void yaze_unload_rom(zelda3_rom* rom);
 
int yaze_save_rom(zelda3_rom* rom, const char* filename);
 
zelda3_rom* yaze_copy_rom(const zelda3_rom* rom);
 
typedef struct zelda3_message {
  uint16_t id;                
  uint32_t rom_address;       
  uint16_t length;            
  uint8_t* raw_data;          
  char* parsed_text;          
  bool is_compressed;         
  uint8_t encoding_type;      
} zelda3_message;
 
typedef struct zelda3_overworld_map {
  uint16_t id;                    
  uint8_t parent_id;              
  uint8_t quadrant_id;            
  uint8_t world_id;               
  uint8_t game_state;             
  /* Graphics and Visual Properties */
  uint8_t area_graphics;          
  uint8_t area_palette;           
  uint8_t main_palette;           
  uint8_t animated_gfx;           
  /* Sprite Configuration */
  uint8_t sprite_graphics[3];     
  uint8_t sprite_palette[3];      
  /* Audio Configuration */
  uint8_t area_music[4];          
  /* Extended Graphics (ZSCustomOverworld) */
  uint8_t static_graphics[16];    
  uint8_t custom_tileset[8];      
  /* Screen Properties */
  uint16_t area_specific_bg_color; 
  uint16_t subscreen_overlay;     
  /* Flags and Metadata */
  bool is_large_map;              
  bool has_special_gfx;           
} zelda3_overworld_map;
 
typedef struct zelda3_overworld {
  void* impl;                     
  zelda3_overworld_map** maps;    
  int map_count;                  
  zelda3_version rom_version;     
  bool has_zsco_features;         
} zelda3_overworld;
 
typedef struct dungeon_sprite {
  const char* name;     
  uint8_t id;          
  uint8_t subtype;     
  uint8_t x;           
  uint8_t y;           
  uint8_t layer;       
  uint16_t properties; 
} dungeon_sprite;
 
typedef enum zelda3_bg2_effect {
  ZELDA3_BG2_OFF = 0,        
  ZELDA3_BG2_PARALLAX = 1,   
  ZELDA3_BG2_DARK = 2,       
  ZELDA3_BG2_ON_TOP = 3,     
  ZELDA3_BG2_TRANSLUCENT = 4, 
  ZELDA3_BG2_ADDITION = 5,   
  ZELDA3_BG2_NORMAL = 6,     
  ZELDA3_BG2_TRANSPARENT = 7, 
  ZELDA3_BG2_DARK_ROOM = 8   
} zelda3_bg2_effect;
 
// Legacy aliases for backward compatibility  
typedef zelda3_bg2_effect background2;
#define Off ZELDA3_BG2_OFF
#define Parallax ZELDA3_BG2_PARALLAX
#define Dark ZELDA3_BG2_DARK
#define OnTop ZELDA3_BG2_ON_TOP
#define Translucent ZELDA3_BG2_TRANSLUCENT
#define Addition ZELDA3_BG2_ADDITION
#define Normal ZELDA3_BG2_NORMAL
#define Transparent ZELDA3_BG2_TRANSPARENT
#define DarkRoom ZELDA3_BG2_DARK_ROOM
 
typedef struct object_door {
  uint16_t id;        
  uint8_t x;          
  uint8_t y;          
  uint8_t size;       
  uint8_t type;       
  uint8_t layer;      
  uint8_t key_type;   
  bool is_locked;     
} object_door;
 
typedef struct staircase {
  uint8_t id;               
  uint8_t room;             
  const char* label;        
} staircase;
 
typedef struct chest {
  uint8_t x;            
  uint8_t y;            
  uint8_t item;         
  bool picker;          
  bool big_chest;       
} chest;
 
typedef struct chest_data {
  uint8_t id;   
  bool size;    
} chest_data;
 
typedef struct destination {
  uint8_t index;          
  uint8_t target;         
  uint8_t target_layer;   
} destination;
 
typedef struct zelda3_dungeon_room {
  uint16_t id;                    
  background2 bg2;                
  /* Room Contents */
  dungeon_sprite* sprites;        
  int sprite_count;               
  object_door* doors;             
  int door_count;                 
  staircase* staircases;          
  int staircase_count;            
  chest* chests;                  
  int chest_count;                
  /* Room Connections */
  destination pits;               
  destination stairs[4];          
  /* Room Properties */
  uint8_t floor_type;             
  uint8_t wall_type;              
  uint8_t palette_id;             
  uint8_t music_track;            
  /* Flags */
  bool is_dark;                   
  bool has_water;                 
  bool blocks_items;              
} zelda3_dungeon_room;
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZELDA_H