zelda3_labels.cc

Go to the documentation of this file.

#include "zelda3/zelda3_labels.h"
 
#include <cstddef>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "zelda3/common.h"
#include "zelda3/dungeon/room.h"
#include "zelda3/dungeon/room_object.h"
#include "zelda3/sprite/overlord.h"
#include "zelda3/sprite/sprite.h"
 
namespace yaze::zelda3 {
 
// Source-Origin: USDASM bank_09.asm, AncillaAdd_ItemReceipt.offset_y
// ($09836C-$0983B7). These are receipt IDs; the generic GetItemNames table is
// offset by an extra "None" entry and includes incompatible hack-only items.
const std::vector<std::string>& Zelda3Labels::GetItemReceiptNames() {
  static const std::vector<std::string> names = {
      "Fighter Sword",
      "Master Sword",
      "Tempered Sword",
      "Golden Sword",
      "Fighter Shield",
      "Fire Shield",
      "Mirror Shield",
      "Fire Rod",
      "Ice Rod",
      "Hammer",
      "Hookshot",
      "Bow",
      "Boomerang",
      "Powder",
      "Bottle Refill (Bee)",
      "Bombos Medallion",
      "Ether Medallion",
      "Quake Medallion",
      "Lamp",
      "Shovel",
      "Flute",
      "Cane of Somaria",
      "Bottle",
      "Piece of Heart",
      "Cane of Byrna",
      "Cape",
      "Magic Mirror",
      "Power Glove",
      "Titan's Mitt",
      "Book of Mudora",
      "Flippers",
      "Moon Pearl",
      "Crystal",
      "Bug Net",
      "Blue Mail",
      "Red Mail",
      "Small Key",
      "Compass",
      "Heart Container (Four Pieces)",
      "Bomb",
      "3 Bombs",
      "Mushroom",
      "Red Boomerang",
      "Bottle (Red Potion)",
      "Bottle (Green Potion)",
      "Bottle (Blue Potion)",
      "Red Potion Refill",
      "Green Potion Refill",
      "Blue Potion Refill",
      "10 Bombs",
      "Big Key",
      "Map",
      "1 Rupee",
      "5 Rupees",
      "20 Rupees",
      "Green Pendant",
      "Blue Pendant",
      "Red Pendant",
      "Tossed Bow",
      "Silver Arrows",
      "Bottle (Bee)",
      "Bottle (Fairy)",
      "Heart Container (Boss)",
      "Heart Container (Sanctuary)",
      "100 Rupees",
      "50 Rupees",
      "Heart",
      "1 Arrow",
      "10 Arrows",
      "Small Magic",
      "300 Rupees",
      "20 Rupees (Green)",
      "Bottle (Good Bee)",
      "Tossed Fighter Sword",
      "Flute (Activated)",
      "Pegasus Boots"};
 
  return names;
}
 
// Room names - reuse existing kRoomNames array
const std::vector<std::string>& Zelda3Labels::GetRoomNames() {
  static std::vector<std::string> room_names;
  if (room_names.empty()) {
    for (const auto& name : kRoomNames) {
      room_names.emplace_back(name);
    }
  }
  return room_names;
}
 
// Entrance names - reuse existing kEntranceNames array
const std::vector<std::string>& Zelda3Labels::GetEntranceNames() {
  static std::vector<std::string> entrance_names;
  if (entrance_names.empty()) {
    for (const auto& name : kEntranceNames) {
      entrance_names.emplace_back(name);
    }
  }
  return entrance_names;
}
 
// Sprite names - reuse existing kSpriteDefaultNames array
const std::vector<std::string>& Zelda3Labels::GetSpriteNames() {
  static std::vector<std::string> sprite_names;
  if (sprite_names.empty()) {
    for (const auto& name : kSpriteDefaultNames) {
      sprite_names.push_back(name);
    }
  }
  return sprite_names;
}
 
// Overlord names - reuse existing kOverlordNames array
const std::vector<std::string>& Zelda3Labels::GetOverlordNames() {
  static std::vector<std::string> overlord_names;
  if (overlord_names.empty()) {
    for (const auto& name : kOverlordNames) {
      overlord_names.push_back(name);
    }
  }
  return overlord_names;
}
 
// Overworld map names (64 Light World + 64 Dark World + 32 Special Areas)
const std::vector<std::string>& Zelda3Labels::GetOverworldMapNames() {
  static const std::vector<std::string> map_names = {
      // Light World (0x00-0x3F)
      "Lost Woods", "Master Sword Pedestal", "Castle Courtyard", "Link's House",
      "Eastern Palace", "Desert Palace", "Hyrule Castle", "Witch's Hut",
      "Kakariko Village", "Death Mountain", "Tower of Hera", "Spectacle Rock",
      "Graveyard", "Sanctuary", "Lake Hylia", "Desert of Mystery",
      "Eastern Ruins", "Zora's Domain", "Catfish", "Dam", "Potion Shop",
      "Kakariko Well", "Blacksmith", "Sick Kid", "Library", "Mushroom",
      "Magic Bat", "Fairy Fountain", "Fortune Teller", "Lake Shop", "Bomb Shop",
      "Cave 45", "Checkerboard Cave", "Mini Moldorm Cave", "Ice Rod Cave",
      "Bonk Rocks", "Bottle Merchant", "Sahasrahla's Hut", "Chicken House",
      "Aginah's Cave", "Dam Exterior", "Mimic Cave Exterior", "Waterfall Fairy",
      "Pyramid", "Fat Fairy", "Spike Cave", "Hookshot Cave", "Graveyard Ledge",
      "Dark Lumberjacks", "Bumper Cave", "Skull Woods 1", "Skull Woods 2",
      "Skull Woods 3", "Skull Woods 4", "Skull Woods 5", "Skull Woods 6",
      "Skull Woods 7", "Skull Woods 8", "Ice Palace Exterior",
      "Misery Mire Exterior", "Palace of Darkness Exterior",
      "Swamp Palace Exterior", "Turtle Rock Exterior", "Thieves' Town Exterior",
 
      // Dark World (0x40-0x7F)
      "Dark Woods", "Dark Chapel", "Dark Castle", "Dark Shields", "Dark Palace",
      "Dark Desert", "Dark Castle Gate", "Dark Witch", "Dark Village",
      "Dark Mountain", "Dark Tower", "Dark Rocks", "Dark Graveyard",
      "Dark Sanctuary", "Dark Lake", "Dark Desert South", "Dark Eastern",
      "Dark Zora", "Dark Catfish", "Dark Dam", "Dark Shop", "Dark Well",
      "Dark Blacksmith", "Dark Sick Kid", "Dark Library", "Dark Mushroom",
      "Dark Bat", "Dark Fountain", "Dark Fortune", "Dark Lake Shop",
      "Dark Bomb Shop", "Dark Cave 45", "Dark Checker", "Dark Mini Moldorm",
      "Dark Ice Rod", "Dark Bonk", "Dark Bottle", "Dark Sahasrahla",
      "Dark Chicken", "Dark Aginah", "Dark Dam Exit", "Dark Mimic Exit",
      "Dark Waterfall", "Pyramid Top", "Dark Fat Fairy", "Dark Spike Cave",
      "Dark Hookshot", "Dark Graveyard Ledge", "Lumberjack House",
      "Dark Bumper", "Skull Woods A", "Skull Woods B", "Skull Woods C",
      "Skull Woods D", "Skull Woods E", "Skull Woods F", "Skull Woods G",
      "Skull Woods H", "Ice Palace Entry", "Misery Mire Entry",
      "Palace of Darkness Entry", "Swamp Palace Entry", "Turtle Rock Entry",
      "Thieves' Town Entry",
 
      // Special Areas (0x80-0x9F)
      "Special Area 1", "Special Area 2", "Special Area 3", "Special Area 4",
      "Special Area 5", "Special Area 6", "Special Area 7", "Special Area 8",
      "Special Area 9", "Special Area 10", "Special Area 11", "Special Area 12",
      "Special Area 13", "Special Area 14", "Special Area 15",
      "Special Area 16", "Special Area 17", "Special Area 18",
      "Special Area 19", "Special Area 20", "Special Area 21",
      "Special Area 22", "Special Area 23", "Special Area 24",
      "Special Area 25", "Special Area 26", "Special Area 27",
      "Special Area 28", "Special Area 29", "Special Area 30",
      "Special Area 31", "Special Area 32"};
  return map_names;
}
 
// Item names (complete item list)
const std::vector<std::string>& Zelda3Labels::GetItemNames() {
  static const std::vector<std::string> item_names = {
      "None",
      "Fighter Sword",
      "Master Sword",
      "Tempered Sword",
      "Golden Sword",
      "Fighter Shield",
      "Fire Shield",
      "Mirror Shield",
      "Fire Rod",
      "Ice Rod",
      "Hammer",
      "Hookshot",
      "Bow",
      "Boomerang",
      "Powder",
      "Bee Badge",
      "Bombos Medallion",
      "Ether Medallion",
      "Quake Medallion",
      "Lamp",
      "Shovel",
      "Flute",
      "Somaria Cane",
      "Bottle",
      "Heart Piece",
      "Byrna Cane",
      "Cape",
      "Mirror",
      "Power Glove",
      "Titan Mitt",
      "Book of Mudora",
      "Zora Flippers",
      "Moon Pearl",
      "Crystal",
      "Bug Net",
      "Blue Mail",
      "Red Mail",
      "Key",
      "Compass",
      "Heart Container",
      "Bomb",
      "3 Bombs",
      "Mushroom",
      "Red Boomerang",
      "Red Potion",
      "Green Potion",
      "Blue Potion",
      "Red Potion (Refill)",
      "Green Potion (Refill)",
      "Blue Potion (Refill)",
      "10 Bombs",
      "Big Key",
      "Map",
      "1 Rupee",
      "5 Rupees",
      "20 Rupees",
      "Pendant of Courage",
      "Pendant of Wisdom",
      "Pendant of Power",
      "Bow and Arrows",
      "Silver Arrows Upgrade",
      "Bee",
      "Fairy",
      "Heart Container (Boss)",
      "Heart",
      "1 Arrow",
      "10 Arrows",
      "Magic",
      "Small Magic",
      "300 Rupees",
      "20 Rupees (Green)",
      "100 Rupees",
      "50 Rupees",
      "Heart Container (Sanctuary)",
      "Arrow Refill (5)",
      "Arrow Refill (10)",
      "Bomb Refill (1)",
      "Bomb Refill (4)",
      "Bomb Refill (8)",
      "Blue Shield (Refill)",
      "Magic Upgrade (1/2)",
      "Magic Upgrade (1/4)",
      "Programmable Item 1",
      "Programmable Item 2",
      "Programmable Item 3",
      "Silvers",
      "Rupoor",
      "Null Item",
      "Red Clock",
      "Blue Clock",
      "Green Clock",
      "Progressive Sword",
      "Progressive Shield",
      "Progressive Armor",
      "Progressive Lifting Glove",
      "RNG Item (Single)",
      "RNG Item (Multi)",
      "Progressive Bow",
      "Progressive Bow (Alt)",
      "Aga Pendant",
      "Pendant (Green)",
      "Blue Pendant",
      "Good Bee",
      "Tossed Key"};
  return item_names;
}
 
// Music track names
const std::vector<std::string>& Zelda3Labels::GetMusicTrackNames() {
  static const std::vector<std::string> music_names = {
      "Nothing",
      "Light World",
      "Beginning",
      "Rabbit",
      "Forest",
      "Intro",
      "Town",
      "Warp",
      "Dark World",
      "Master Sword",
      "File Select",
      "Soldier",
      "Boss",
      "Dark World Death Mountain",
      "Minigame",
      "Skull Woods",
      "Indoor",
      "Cave 1",
      "Zelda's Rescue",
      "Crystal",
      "Shop",
      "Cave 2",
      "Game Over",
      "Boss Victory",
      "Sanctuary",
      "Boss Victory (Short)",
      "Dark World Woods",
      "Pendant",
      "Ganon's Message",
      "Hyrule Castle",
      "Light World Death Mountain",
      "Eastern Palace",
      "Desert Palace",
      "Agahnim's Theme",
      "Damp Dungeon",
      "Ganon Reveals",
      "Confrontation",
      "Ganon's Theme",
      "Triforce",
      "Credits",
      "Unused",
      "Unused",
      "Unused",
      "Unused",
      "Unused",
      "Unused",
      "Unused",
      "Unused"};
  return music_names;
}
 
// Graphics sheet names
const std::vector<std::string>& Zelda3Labels::GetGraphicsSheetNames() {
  static const std::vector<std::string> gfx_names = {"Sprite Sheet 0",
                                                     "Sprite Sheet 1",
                                                     "Sprite Sheet 2",
                                                     "Sprite Sheet 3",
                                                     "Sprite Sheet 4",
                                                     "Sprite Sheet 5",
                                                     "Sprite Sheet 6",
                                                     "Sprite Sheet 7",
                                                     "Sprite Sheet 8",
                                                     "Sprite Sheet 9",
                                                     "Sprite Sheet A",
                                                     "Sprite Sheet B",
                                                     "Sprite Sheet C",
                                                     "Sprite Sheet D",
                                                     "Sprite Sheet E",
                                                     "Sprite Sheet F",
                                                     "Link's Sprites",
                                                     "Sword Sprites",
                                                     "Shield Sprites",
                                                     "Common Sprites",
                                                     "Boss Sprites",
                                                     "NPC Sprites",
                                                     "Enemy Sprites 1",
                                                     "Enemy Sprites 2",
                                                     "Item Sprites",
                                                     "Dungeon Objects",
                                                     "Overworld Objects",
                                                     "Interface",
                                                     "Font",
                                                     "Credits",
                                                     "Unused",
                                                     "Unused"};
  return gfx_names;
}
 
// Room object names - these are large, so we'll delegate to a helper
namespace {
template <size_t N>
std::vector<std::string> ConvertArrayToVector(const char* const (&array)[N]) {
  std::vector<std::string> result;
  result.reserve(N);
  for (const char* name : array) {
    result.emplace_back(name);
  }
  return result;
}
}  // namespace
 
const std::vector<std::string>& Zelda3Labels::GetType1RoomObjectNames() {
  static const std::vector<std::string> names =
      ConvertArrayToVector(Type1RoomObjectNames);
  return names;
}
 
const std::vector<std::string>& Zelda3Labels::GetType2RoomObjectNames() {
  static const std::vector<std::string> names =
      ConvertArrayToVector(Type2RoomObjectNames);
  return names;
}
 
const std::vector<std::string>& Zelda3Labels::GetType3RoomObjectNames() {
  static const std::vector<std::string> names =
      ConvertArrayToVector(Type3RoomObjectNames);
  return names;
}
 
// Room effect names - reuse existing RoomEffect array
const std::vector<std::string>& Zelda3Labels::GetRoomEffectNames() {
  static std::vector<std::string> effect_names;
  if (effect_names.empty()) {
    for (const auto& name : RoomEffect) {
      effect_names.push_back(name);
    }
  }
  return effect_names;
}
 
// Room tag names
const std::vector<std::string>& Zelda3Labels::GetRoomTagNames() {
  static const std::vector<std::string> tag_names = {
      "Nothing",                     // 0
      "NW Kill Enemy to Open",       // 1
      "NE Kill Enemy to Open",       // 2
      "SW Kill Enemy to Open",       // 3
      "SE Kill Enemy to Open",       // 4
      "W Kill Enemy to Open",        // 5
      "E Kill Enemy to Open",        // 6
      "N Kill Enemy to Open",        // 7
      "S Kill Enemy to Open",        // 8
      "Clear Quadrant to Open",      // 9
      "Clear Room to Open",          // 10
      "NW Push Block to Open",       // 11
      "NE Push Block to Open",       // 12
      "SW Push Block to Open",       // 13
      "SE Push Block to Open",       // 14
      "W Push Block to Open",        // 15
      "E Push Block to Open",        // 16
      "N Push Block to Open",        // 17
      "S Push Block to Open",        // 18
      "Push Block to Open",          // 19
      "Pull Lever to Open",          // 20
      "Collect Prize to Open",       // 21
      "Hold Switch Open Door",       // 22
      "Toggle Switch to Open Door",  // 23
      "Turn off Water",              // 24
      "Turn on Water",               // 25
      "Water Gate",                  // 26
      "Water Twin",                  // 27
      "Moving Wall Right",           // 28
      "Moving Wall Left",            // 29
      "Crash1",                      // 30
      "Crash2",                      // 31
      "Push Switch Exploding Wall",  // 32
      "Holes 0",                     // 33
      "Open Chest for Holes 0",      // 34
      "Holes 1",                     // 35
      "Holes 2",                     // 36
      "Defeat Boss for Prize",       // 37
      "SE Kill Enemy for Push Blk",  // 38
      "Trigger Switch Chest",        // 39
      "Pull Lever Exploding Wall",   // 40
      "NW Kill Enemy for Chest",     // 41
      "NE Kill Enemy for Chest",     // 42
      "SW Kill Enemy for Chest",     // 43
      "SE Kill Enemy for Chest",     // 44
      "W Kill Enemy for Chest",      // 45
      "E Kill Enemy for Chest",      // 46
      "N Kill Enemy for Chest",      // 47
      "S Kill Enemy for Chest",      // 48
      "Clear Quadrant for Chest",    // 49
      "Clear Room for Chest",        // 50
      "Light Torches to Open",       // 51
      "Holes 3",                     // 52
      "Holes 4",                     // 53
      "Holes 5",                     // 54
      "Holes 6",                     // 55
      "Agahnim Room",                // 56
      "Holes 7",                     // 57
      "Holes 8",                     // 58
      "Open Chest for Holes 8",      // 59
      "Push Block for Chest",        // 60
      "Clear Room for Triforce",     // 61
      "Light Torches for Chest",     // 62
      "Kill Boss Again",             // 63
      "64 (Unused)"                  // 64
  };
  return tag_names;
}
 
// Tile type names
const std::vector<std::string>& Zelda3Labels::GetTileTypeNames() {
  static const std::vector<std::string> tile_names = {
      "Nothing (standard floor)",
      "Nothing (unused?)",
      "Collision",
      "Collision (unknown types)",
      "Collision",
      "Collision (unused?)",
      "Collision",
      "Collision",
      "Deep water",
      "Shallow water",
      "Unknown (near water/pit edges)",
      "Collision (water/pit edges)",
      "Overlay mask",
      "Spike floor",
      "GT ice",
      "Ice palace ice",
      "Slope ◤",
      "Slope ◥",
      "Slope ◣",
      "Slope ◢",
      "Nothing (unused?)",
      "Nothing (unused?)",
      "Nothing (unused?)",
      "Slope ◤",
      "Slope ◥",
      "Slope ◣",
      "Slope ◢",
      "Layer swap",
      "Pit",
      "Manual stairs",
      "Pot switch",
      "Pressure switch",
      "Blocks switch (chest, PoD, walls)",
      "Layer toggle",
      "Layer 2 overlay",
      "North single-layer auto stairs",
      "North layer swap auto stairs",
      "South single-layer auto stairs",
      "South layer swap auto stairs",
      "North/south layer swap auto stairs",
      "North/south single-layer auto stairs",
      "West single-layer auto stairs",
      "West layer swap auto stairs",
      "East single-layer auto stairs",
      "East layer swap auto stairs",
      "East/west layer swap auto stairs",
      "East/west single-layer auto stairs",
      "Nothing (stairs edge)",
      "Straight inter-room stairs south/up",
      "Straight inter-room stairs north/down",
      "Straight inter-room stairs south/down 2",
      "Straight inter-room stairs north/up 2",
      "Star tile (inactive on GBA)",
      "Collision (near stairs)",
      "Warp tile",
      "Square corners ⌜⌝⌞⌟",
      "Thick corner ⌜",
      "Thick corner ⌝",
      "Thick corner ⌞",
      "Thick corner ⌟",
      "Roof/grass tiles?",
      "Spike floor"};
  return tile_names;
}
 
// Convert all labels to structured map for project embedding
std::unordered_map<std::string, std::unordered_map<std::string, std::string>>
Zelda3Labels::ToResourceLabels() {
  std::unordered_map<std::string, std::unordered_map<std::string, std::string>>
      labels;
 
  // Rooms
  const auto& rooms = GetRoomNames();
  for (size_t i = 0; i < rooms.size(); ++i) {
    labels["room"][std::to_string(i)] = rooms[i];
  }
 
  // Entrances
  const auto& entrances = GetEntranceNames();
  for (size_t i = 0; i < entrances.size(); ++i) {
    labels["entrance"][std::to_string(i)] = entrances[i];
  }
 
  // Sprites
  const auto& sprites = GetSpriteNames();
  for (size_t i = 0; i < sprites.size(); ++i) {
    labels["sprite"][std::to_string(i)] = sprites[i];
  }
 
  // Overlords
  const auto& overlords = GetOverlordNames();
  for (size_t i = 0; i < overlords.size(); ++i) {
    labels["overlord"][std::to_string(i)] = overlords[i];
  }
 
  // Overworld maps
  const auto& maps = GetOverworldMapNames();
  for (size_t i = 0; i < maps.size(); ++i) {
    labels["overworld_map"][std::to_string(i)] = maps[i];
  }
 
  // Items
  const auto& items = GetItemNames();
  for (size_t i = 0; i < items.size(); ++i) {
    labels["item"][std::to_string(i)] = items[i];
  }
 
  // Music tracks
  const auto& music = GetMusicTrackNames();
  for (size_t i = 0; i < music.size(); ++i) {
    labels["music"][std::to_string(i)] = music[i];
  }
 
  // Graphics sheets
  const auto& gfx = GetGraphicsSheetNames();
  for (size_t i = 0; i < gfx.size(); ++i) {
    labels["graphics"][std::to_string(i)] = gfx[i];
  }
 
  // Room effects
  const auto& effects = GetRoomEffectNames();
  for (size_t i = 0; i < effects.size(); ++i) {
    labels["room_effect"][std::to_string(i)] = effects[i];
  }
 
  // Room tags
  const auto& tags = GetRoomTagNames();
  for (size_t i = 0; i < tags.size(); ++i) {
    labels["room_tag"][std::to_string(i)] = tags[i];
  }
 
  // Tile types
  const auto& tiles = GetTileTypeNames();
  for (size_t i = 0; i < tiles.size(); ++i) {
    labels["tile_type"][std::to_string(i)] = tiles[i];
  }
 
  // Dungeon room objects
  const auto& type1_objects = GetType1RoomObjectNames();
  for (size_t i = 0; i < type1_objects.size(); ++i) {
    labels["room_object_type1"][std::to_string(i)] = type1_objects[i];
    labels["room_object"][std::to_string(i)] = type1_objects[i];
  }
 
  const auto& type2_objects = GetType2RoomObjectNames();
  for (size_t i = 0; i < type2_objects.size(); ++i) {
    const int object_id = 0x100 + static_cast<int>(i);
    labels["room_object_type2"][std::to_string(i)] = type2_objects[i];
    labels["room_object"][std::to_string(object_id)] = type2_objects[i];
  }
 
  const auto& type3_objects = GetType3RoomObjectNames();
  for (size_t i = 0; i < type3_objects.size(); ++i) {
    const int object_id = 0xF80 + static_cast<int>(i);
    labels["room_object_type3"][std::to_string(i)] = type3_objects[i];
    labels["room_object"][std::to_string(object_id)] = type3_objects[i];
  }
 
  return labels;
}
 
// Get a label by resource type and ID
std::string Zelda3Labels::GetLabel(const std::string& resource_type, int id,
                                   const std::string& default_value) {
  static auto labels = ToResourceLabels();
 
  auto type_it = labels.find(resource_type);
  if (type_it == labels.end()) {
    return default_value.empty() ? resource_type + "_" + std::to_string(id)
                                 : default_value;
  }
 
  auto label_it = type_it->second.find(std::to_string(id));
  if (label_it == type_it->second.end()) {
    return default_value.empty() ? resource_type + "_" + std::to_string(id)
                                 : default_value;
  }
 
  return label_it->second;
}
 
}  // namespace yaze::zelda3