Sonic Adventure 2: Battle Implementation (ArchipelagoMW#501)

README.md

@@ -24,6 +24,7 @@ Currently, the following games are supported:
 * ArchipIDLE
 * Hollow Knight
 * The Witness
+* Sonic Adventure 2: Battle
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

worlds/sa2b/Items.py

@@ -0,0 +1,76 @@
+import typing
+
+from BaseClasses import Item
+from .Names import ItemName
+
+
+class ItemData(typing.NamedTuple):
+    code: typing.Optional[int]
+    progression: bool
+    quantity: int = 1
+    event: bool = False
+
+
+class SA2BItem(Item):
+    game: str = "Sonic Adventure 2: Battle"
+
+    def __init__(self, name, advancement: bool = False, code: int = None, player: int = None):
+        super(SA2BItem, self).__init__(name, advancement, code, player)
+
+        if self.name == ItemName.sonic_light_shoes or self.name == ItemName.shadow_air_shoes:
+            self.pedestal_credit_text = "and the Soap Shoes"
+
+
+# Separate tables for each type of item.
+emblems_table = {
+    ItemName.emblem:  ItemData(0xFF0000, True),
+}
+
+upgrades_table = {
+    ItemName.sonic_gloves:          ItemData(0xFF0001, False),
+    ItemName.sonic_light_shoes:     ItemData(0xFF0002, True),
+    ItemName.sonic_ancient_light:   ItemData(0xFF0003, False),
+    ItemName.sonic_bounce_bracelet: ItemData(0xFF0004, True),
+    ItemName.sonic_flame_ring:      ItemData(0xFF0005, True),
+    ItemName.sonic_mystic_melody:   ItemData(0xFF0006, True),
+
+    ItemName.tails_laser_blaster: ItemData(0xFF0007, False),
+    ItemName.tails_booster:       ItemData(0xFF0008, True),
+    ItemName.tails_mystic_melody: ItemData(0xFF0009, True),
+    ItemName.tails_bazooka:       ItemData(0xFF000A, True),
+
+    ItemName.knuckles_mystic_melody: ItemData(0xFF000B, True),
+    ItemName.knuckles_shovel_claws:  ItemData(0xFF000C, True),
+    ItemName.knuckles_air_necklace:  ItemData(0xFF000D, True),
+    ItemName.knuckles_hammer_gloves: ItemData(0xFF000E, True),
+    ItemName.knuckles_sunglasses:    ItemData(0xFF000F, True),
+
+    ItemName.shadow_flame_ring:    ItemData(0xFF0010, True),
+    ItemName.shadow_air_shoes:     ItemData(0xFF0011, True),
+    ItemName.shadow_ancient_light: ItemData(0xFF0012, False),
+    ItemName.shadow_mystic_melody: ItemData(0xFF0013, True),
+
+    ItemName.eggman_laser_blaster:    ItemData(0xFF0014, False),
+    ItemName.eggman_mystic_melody:    ItemData(0xFF0015, True),
+    ItemName.eggman_jet_engine:       ItemData(0xFF0016, True),
+    ItemName.eggman_large_cannon:     ItemData(0xFF0017, True),
+    ItemName.eggman_protective_armor: ItemData(0xFF0018, False),
+
+    ItemName.rouge_mystic_melody:  ItemData(0xFF0019, True),
+    ItemName.rouge_pick_nails:     ItemData(0xFF001A, True),
+    ItemName.rouge_treasure_scope: ItemData(0xFF001B, True),
+    ItemName.rouge_iron_boots:     ItemData(0xFF001C, True),
+}
+
+event_table = {
+    ItemName.maria: ItemData(0xFF001D, True),
+}
+
+# Complete item table.
+item_table = {
+    **emblems_table,
+    **upgrades_table,
+    **event_table,
+}
+
+lookup_id_to_name: typing.Dict[int, str] = {data.code: item_name for item_name, data in item_table.items() if data.code}

worlds/sa2b/Locations.py

@@ -0,0 +1,277 @@
+import typing
+
+from BaseClasses import Location
+from .Names import LocationName
+
+
+class SA2BLocation(Location):
+    game: str = "Sonic Adventure 2: Battle"
+
+
+first_mission_location_table = {
+    LocationName.city_escape_1: 0xFF0000,
+    LocationName.wild_canyon_1: 0xFF0001,
+    LocationName.prison_lane_1: 0xFF0002,
+    LocationName.metal_harbor_1: 0xFF0003,
+    LocationName.green_forest_1: 0xFF0004,
+    LocationName.pumpkin_hill_1: 0xFF0005,
+    LocationName.mission_street_1: 0xFF0006,
+    LocationName.aquatic_mine_1: 0xFF0007,
+    LocationName.route_101_1: 0xFF0008,
+    LocationName.hidden_base_1: 0xFF0009,
+    LocationName.pyramid_cave_1: 0xFF000A,
+    LocationName.death_chamber_1: 0xFF000B,
+    LocationName.eternal_engine_1: 0xFF000C,
+    LocationName.meteor_herd_1: 0xFF000D,
+    LocationName.crazy_gadget_1: 0xFF000E,
+    LocationName.final_rush_1: 0xFF000F,
+
+    LocationName.iron_gate_1: 0xFF0010,
+    LocationName.dry_lagoon_1: 0xFF0011,
+    LocationName.sand_ocean_1: 0xFF0012,
+    LocationName.radical_highway_1: 0xFF0013,
+    LocationName.egg_quarters_1: 0xFF0014,
+    LocationName.lost_colony_1: 0xFF0015,
+    LocationName.weapons_bed_1: 0xFF0016,
+    LocationName.security_hall_1: 0xFF0017,
+    LocationName.white_jungle_1: 0xFF0018,
+    LocationName.route_280_1: 0xFF0019,
+    LocationName.sky_rail_1: 0xFF001A,
+    LocationName.mad_space_1: 0xFF001B,
+    LocationName.cosmic_wall_1: 0xFF001C,
+    LocationName.final_chase_1: 0xFF001D,
+
+    LocationName.cannon_core_1: 0xFF001E,
+}
+
+second_mission_location_table = {
+    LocationName.city_escape_2: 0xFF0020,
+    LocationName.wild_canyon_2: 0xFF0021,
+    LocationName.prison_lane_2: 0xFF0022,
+    LocationName.metal_harbor_2: 0xFF0023,
+    LocationName.green_forest_2: 0xFF0024,
+    LocationName.pumpkin_hill_2: 0xFF0025,
+    LocationName.mission_street_2: 0xFF0026,
+    LocationName.aquatic_mine_2: 0xFF0027,
+    LocationName.route_101_2: 0xFF0028,
+    LocationName.hidden_base_2: 0xFF0029,
+    LocationName.pyramid_cave_2: 0xFF002A,
+    LocationName.death_chamber_2: 0xFF002B,
+    LocationName.eternal_engine_2: 0xFF002C,
+    LocationName.meteor_herd_2: 0xFF002D,
+    LocationName.crazy_gadget_2: 0xFF002E,
+    LocationName.final_rush_2: 0xFF002F,
+
+    LocationName.iron_gate_2: 0xFF0030,
+    LocationName.dry_lagoon_2: 0xFF0031,
+    LocationName.sand_ocean_2: 0xFF0032,
+    LocationName.radical_highway_2: 0xFF0033,
+    LocationName.egg_quarters_2: 0xFF0034,
+    LocationName.lost_colony_2: 0xFF0035,
+    LocationName.weapons_bed_2: 0xFF0036,
+    LocationName.security_hall_2: 0xFF0037,
+    LocationName.white_jungle_2: 0xFF0038,
+    LocationName.route_280_2: 0xFF0039,
+    LocationName.sky_rail_2: 0xFF003A,
+    LocationName.mad_space_2: 0xFF003B,
+    LocationName.cosmic_wall_2: 0xFF003C,
+    LocationName.final_chase_2: 0xFF003D,
+
+    LocationName.cannon_core_2: 0xFF003E,
+}
+
+third_mission_location_table = {
+    LocationName.city_escape_3: 0xFF0040,
+    LocationName.wild_canyon_3: 0xFF0041,
+    LocationName.prison_lane_3: 0xFF0042,
+    LocationName.metal_harbor_3: 0xFF0043,
+    LocationName.green_forest_3: 0xFF0044,
+    LocationName.pumpkin_hill_3: 0xFF0045,
+    LocationName.mission_street_3: 0xFF0046,
+    LocationName.aquatic_mine_3: 0xFF0047,
+    LocationName.route_101_3: 0xFF0048,
+    LocationName.hidden_base_3: 0xFF0049,
+    LocationName.pyramid_cave_3: 0xFF004A,
+    LocationName.death_chamber_3: 0xFF004B,
+    LocationName.eternal_engine_3: 0xFF004C,
+    LocationName.meteor_herd_3: 0xFF004D,
+    LocationName.crazy_gadget_3: 0xFF004E,
+    LocationName.final_rush_3: 0xFF004F,
+
+    LocationName.iron_gate_3: 0xFF0050,
+    LocationName.dry_lagoon_3: 0xFF0051,
+    LocationName.sand_ocean_3: 0xFF0052,
+    LocationName.radical_highway_3: 0xFF0053,
+    LocationName.egg_quarters_3: 0xFF0054,
+    LocationName.lost_colony_3: 0xFF0055,
+    LocationName.weapons_bed_3: 0xFF0056,
+    LocationName.security_hall_3: 0xFF0057,
+    LocationName.white_jungle_3: 0xFF0058,
+    LocationName.route_280_3: 0xFF0059,
+    LocationName.sky_rail_3: 0xFF005A,
+    LocationName.mad_space_3: 0xFF005B,
+    LocationName.cosmic_wall_3: 0xFF005C,
+    LocationName.final_chase_3: 0xFF005D,
+
+    LocationName.cannon_core_3: 0xFF005E,
+}
+
+fourth_mission_location_table = {
+    LocationName.city_escape_4: 0xFF0060,
+    LocationName.wild_canyon_4: 0xFF0061,
+    LocationName.prison_lane_4: 0xFF0062,
+    LocationName.metal_harbor_4: 0xFF0063,
+    LocationName.green_forest_4: 0xFF0064,
+    LocationName.pumpkin_hill_4: 0xFF0065,
+    LocationName.mission_street_4: 0xFF0066,
+    LocationName.aquatic_mine_4: 0xFF0067,
+    LocationName.route_101_4: 0xFF0068,
+    LocationName.hidden_base_4: 0xFF0069,
+    LocationName.pyramid_cave_4: 0xFF006A,
+    LocationName.death_chamber_4: 0xFF006B,
+    LocationName.eternal_engine_4: 0xFF006C,
+    LocationName.meteor_herd_4: 0xFF006D,
+    LocationName.crazy_gadget_4: 0xFF006E,
+    LocationName.final_rush_4: 0xFF006F,
+
+    LocationName.iron_gate_4: 0xFF0070,
+    LocationName.dry_lagoon_4: 0xFF0071,
+    LocationName.sand_ocean_4: 0xFF0072,
+    LocationName.radical_highway_4: 0xFF0073,
+    LocationName.egg_quarters_4: 0xFF0074,
+    LocationName.lost_colony_4: 0xFF0075,
+    LocationName.weapons_bed_4: 0xFF0076,
+    LocationName.security_hall_4: 0xFF0077,
+    LocationName.white_jungle_4: 0xFF0078,
+    LocationName.route_280_4: 0xFF0079,
+    LocationName.sky_rail_4: 0xFF007A,
+    LocationName.mad_space_4: 0xFF007B,
+    LocationName.cosmic_wall_4: 0xFF007C,
+    LocationName.final_chase_4: 0xFF007D,
+
+    LocationName.cannon_core_4: 0xFF007E,
+}
+
+fifth_mission_location_table = {
+    LocationName.city_escape_5: 0xFF0080,
+    LocationName.wild_canyon_5: 0xFF0081,
+    LocationName.prison_lane_5: 0xFF0082,
+    LocationName.metal_harbor_5: 0xFF0083,
+    LocationName.green_forest_5: 0xFF0084,
+    LocationName.pumpkin_hill_5: 0xFF0085,
+    LocationName.mission_street_5: 0xFF0086,
+    LocationName.aquatic_mine_5: 0xFF0087,
+    LocationName.route_101_5: 0xFF0088,
+    LocationName.hidden_base_5: 0xFF0089,
+    LocationName.pyramid_cave_5: 0xFF008A,
+    LocationName.death_chamber_5: 0xFF008B,
+    LocationName.eternal_engine_5: 0xFF008C,
+    LocationName.meteor_herd_5: 0xFF008D,
+    LocationName.crazy_gadget_5: 0xFF008E,
+    LocationName.final_rush_5: 0xFF008F,
+
+    LocationName.iron_gate_5: 0xFF0090,
+    LocationName.dry_lagoon_5: 0xFF0091,
+    LocationName.sand_ocean_5: 0xFF0092,
+    LocationName.radical_highway_5: 0xFF0093,
+    LocationName.egg_quarters_5: 0xFF0094,
+    LocationName.lost_colony_5: 0xFF0095,
+    LocationName.weapons_bed_5: 0xFF0096,
+    LocationName.security_hall_5: 0xFF0097,
+    LocationName.white_jungle_5: 0xFF0098,
+    LocationName.route_280_5: 0xFF0099,
+    LocationName.sky_rail_5: 0xFF009A,
+    LocationName.mad_space_5: 0xFF009B,
+    LocationName.cosmic_wall_5: 0xFF009C,
+    LocationName.final_chase_5: 0xFF009D,
+
+    LocationName.cannon_core_5: 0xFF009E,
+}
+
+upgrade_location_table = {
+    LocationName.city_escape_upgrade: 0xFF00A0,
+    LocationName.wild_canyon_upgrade: 0xFF00A1,
+    LocationName.prison_lane_upgrade: 0xFF00A2,
+    LocationName.metal_harbor_upgrade: 0xFF00A3,
+    LocationName.green_forest_upgrade: 0xFF00A4,
+    LocationName.pumpkin_hill_upgrade: 0xFF00A5,
+    LocationName.mission_street_upgrade: 0xFF00A6,
+    LocationName.aquatic_mine_upgrade: 0xFF00A7,
+    LocationName.hidden_base_upgrade: 0xFF00A9,
+    LocationName.pyramid_cave_upgrade: 0xFF00AA,
+    LocationName.death_chamber_upgrade: 0xFF00AB,
+    LocationName.eternal_engine_upgrade: 0xFF00AC,
+    LocationName.meteor_herd_upgrade: 0xFF00AD,
+    LocationName.crazy_gadget_upgrade: 0xFF00AE,
+    LocationName.final_rush_upgrade: 0xFF00AF,
+
+    LocationName.iron_gate_upgrade: 0xFF00B0,
+    LocationName.dry_lagoon_upgrade: 0xFF00B1,
+    LocationName.sand_ocean_upgrade: 0xFF00B2,
+    LocationName.radical_highway_upgrade: 0xFF00B3,
+    LocationName.egg_quarters_upgrade: 0xFF00B4,
+    LocationName.lost_colony_upgrade: 0xFF00B5,
+    LocationName.weapons_bed_upgrade: 0xFF00B6,
+    LocationName.security_hall_upgrade: 0xFF00B7,
+    LocationName.white_jungle_upgrade: 0xFF00B8,
+    LocationName.sky_rail_upgrade: 0xFF00BA,
+    LocationName.mad_space_upgrade: 0xFF00BB,
+    LocationName.cosmic_wall_upgrade: 0xFF00BC,
+    LocationName.final_chase_upgrade: 0xFF00BD,
+}
+
+chao_garden_location_table = {
+    LocationName.chao_beginner_race: 0xFF00C0,
+    LocationName.chao_jewel_race: 0xFF00C1,
+    LocationName.chao_challenge_race: 0xFF00C2,
+    LocationName.chao_hero_race: 0xFF00C3,
+    LocationName.chao_dark_race: 0xFF00C4,
+
+    LocationName.chao_beginner_karate: 0xFF00C5,
+    LocationName.chao_standard_karate: 0xFF00C6,
+    LocationName.chao_expert_karate: 0xFF00C7,
+    LocationName.chao_super_karate: 0xFF00C8,
+}
+
+other_location_table = {
+    # LocationName.green_hill: 0xFF001F,
+    LocationName.biolizard: 0xFF003F,
+}
+
+all_locations = {
+    **first_mission_location_table,
+    **second_mission_location_table,
+    **third_mission_location_table,
+    **fourth_mission_location_table,
+    **fifth_mission_location_table,
+    **upgrade_location_table,
+    **chao_garden_location_table,
+    **other_location_table,
+}
+
+location_table = {}
+
+
+def setup_locations(world, player: int):
+    location_table = {**first_mission_location_table}
+
+    if world.IncludeMissions[player].value >= 2:
+        location_table.update({**second_mission_location_table})
+
+    if world.IncludeMissions[player].value >= 3:
+        location_table.update({**third_mission_location_table})
+
+    if world.IncludeMissions[player].value >= 4:
+        location_table.update({**fourth_mission_location_table})
+
+    if world.IncludeMissions[player].value >= 5:
+        location_table.update({**fifth_mission_location_table})
+
+    location_table.update({**upgrade_location_table})
+    # location_table.update(**chao_garden_location_table})
+    location_table.update({**other_location_table})
+
+    return location_table
+
+
+lookup_id_to_name: typing.Dict[int, str] = {id: name for name, _ in all_locations.items()}