# world/dark_souls_3/__init__.py from typing import Dict from .Items import DarkSouls3Item from .Locations import DarkSouls3Location from .Options import dark_souls_options from .data.items_data import weapons_upgrade_5_table, weapons_upgrade_10_table, item_dictionary, key_items_list, \ dlc_weapons_upgrade_5_table, dlc_weapons_upgrade_10_table from .data.locations_data import location_dictionary, fire_link_shrine_table, \ high_wall_of_lothric, \ undead_settlement_table, road_of_sacrifice_table, consumed_king_garden_table, cathedral_of_the_deep_table, \ farron_keep_table, catacombs_of_carthus_table, smouldering_lake_table, irithyll_of_the_boreal_valley_table, \ irithyll_dungeon_table, profaned_capital_table, anor_londo_table, lothric_castle_table, grand_archives_table, \ untended_graves_table, archdragon_peak_table, firelink_shrine_bell_tower_table, progressive_locations, \ progressive_locations_2, progressive_locations_3, painted_world_table, dreg_heap_table, ringed_city_table, dlc_progressive_locations from ..AutoWorld import World, WebWorld from BaseClasses import MultiWorld, Region, Item, Entrance, Tutorial, ItemClassification from ..generic.Rules import set_rule, add_item_rule class DarkSouls3Web(WebWorld): bug_report_page = "https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/issues" setup_en = Tutorial( "Multiworld Setup Tutorial", "A guide to setting up the Archipelago Dark Souls III randomizer on your computer.", "English", "setup_en.md", "setup/en", ["Marech"] ) setup_fr = Tutorial( setup_en.tutorial_name, setup_en.description, "Français", "setup_fr.md", "setup/fr", ["Marech"] ) tutorials = [setup_en, setup_fr] class DarkSouls3World(World): """ Dark souls III is an Action role-playing game and is part of the Souls series developed by FromSoftware. Played in a third-person perspective, players have access to various weapons, armour, magic, and consumables that they can use to fight their enemies. """ game: str = "Dark Souls III" option_definitions = dark_souls_options topology_present: bool = True web = DarkSouls3Web() data_version = 5 base_id = 100000 required_client_version = (0, 3, 7) item_name_to_id = DarkSouls3Item.get_name_to_id() location_name_to_id = DarkSouls3Location.get_name_to_id() def __init__(self, world: MultiWorld, player: int): super().__init__(world, player) self.locked_items = [] self.locked_locations = [] self.main_path_locations = [] def create_item(self, name: str) -> Item: data = self.item_name_to_id[name] if name in key_items_list: item_classification = ItemClassification.progression elif name in weapons_upgrade_5_table or name in weapons_upgrade_10_table: item_classification = ItemClassification.useful else: item_classification = ItemClassification.filler return DarkSouls3Item(name, item_classification, data, self.player) def create_regions(self): if self.multiworld.enable_progressive_locations[self.player].value and self.multiworld.enable_dlc[self.player].value: menu_region = self.create_region("Menu", {**progressive_locations, **progressive_locations_2, **progressive_locations_3, **dlc_progressive_locations}) elif self.multiworld.enable_progressive_locations[self.player].value: menu_region = self.create_region("Menu", {**progressive_locations, **progressive_locations_2, **progressive_locations_3}) else: menu_region = self.create_region("Menu", None) # Create all Vanilla regions of Dark Souls III firelink_shrine_region = self.create_region("Firelink Shrine", fire_link_shrine_table) firelink_shrine_bell_tower_region = self.create_region("Firelink Shrine Bell Tower", firelink_shrine_bell_tower_table) high_wall_of_lothric_region = self.create_region("High Wall of Lothric", high_wall_of_lothric) undead_settlement_region = self.create_region("Undead Settlement", undead_settlement_table) road_of_sacrifices_region = self.create_region("Road of Sacrifices", road_of_sacrifice_table) consumed_king_garden_region = self.create_region("Consumed King's Garden", consumed_king_garden_table) cathedral_of_the_deep_region = self.create_region("Cathedral of the Deep", cathedral_of_the_deep_table) farron_keep_region = self.create_region("Farron Keep", farron_keep_table) catacombs_of_carthus_region = self.create_region("Catacombs of Carthus", catacombs_of_carthus_table) smouldering_lake_region = self.create_region("Smouldering Lake", smouldering_lake_table) irithyll_of_the_boreal_valley_region = self.create_region("Irithyll of the Boreal Valley", irithyll_of_the_boreal_valley_table) irithyll_dungeon_region = self.create_region("Irithyll Dungeon", irithyll_dungeon_table) profaned_capital_region = self.create_region("Profaned Capital", profaned_capital_table) anor_londo_region = self.create_region("Anor Londo", anor_londo_table) lothric_castle_region = self.create_region("Lothric Castle", lothric_castle_table) grand_archives_region = self.create_region("Grand Archives", grand_archives_table) untended_graves_region = self.create_region("Untended Graves", untended_graves_table) archdragon_peak_region = self.create_region("Archdragon Peak", archdragon_peak_table) kiln_of_the_first_flame_region = self.create_region("Kiln Of The First Flame", None) # DLC Down here if self.multiworld.enable_dlc[self.player]: painted_world_of_ariandel_region = self.create_region("Painted World of Ariandel", painted_world_table) dreg_heap_region = self.create_region("Dreg Heap", dreg_heap_table) ringed_city_region = self.create_region("Ringed City", ringed_city_table) # Create the entrance to connect those regions menu_region.exits.append(Entrance(self.player, "New Game", menu_region)) self.multiworld.get_entrance("New Game", self.player).connect(firelink_shrine_region) firelink_shrine_region.exits.append(Entrance(self.player, "Goto High Wall of Lothric", firelink_shrine_region)) firelink_shrine_region.exits.append(Entrance(self.player, "Goto Kiln Of The First Flame", firelink_shrine_region)) firelink_shrine_region.exits.append(Entrance(self.player, "Goto Bell Tower", firelink_shrine_region)) self.multiworld.get_entrance("Goto High Wall of Lothric", self.player).connect(high_wall_of_lothric_region) self.multiworld.get_entrance("Goto Kiln Of The First Flame", self.player).connect( kiln_of_the_first_flame_region) self.multiworld.get_entrance("Goto Bell Tower", self.player).connect(firelink_shrine_bell_tower_region) high_wall_of_lothric_region.exits.append(Entrance(self.player, "Goto Undead Settlement", high_wall_of_lothric_region)) high_wall_of_lothric_region.exits.append(Entrance(self.player, "Goto Lothric Castle", high_wall_of_lothric_region)) self.multiworld.get_entrance("Goto Undead Settlement", self.player).connect(undead_settlement_region) self.multiworld.get_entrance("Goto Lothric Castle", self.player).connect(lothric_castle_region) undead_settlement_region.exits.append(Entrance(self.player, "Goto Road Of Sacrifices", undead_settlement_region)) self.multiworld.get_entrance("Goto Road Of Sacrifices", self.player).connect(road_of_sacrifices_region) road_of_sacrifices_region.exits.append(Entrance(self.player, "Goto Cathedral", road_of_sacrifices_region)) road_of_sacrifices_region.exits.append(Entrance(self.player, "Goto Farron keep", road_of_sacrifices_region)) self.multiworld.get_entrance("Goto Cathedral", self.player).connect(cathedral_of_the_deep_region) self.multiworld.get_entrance("Goto Farron keep", self.player).connect(farron_keep_region) farron_keep_region.exits.append(Entrance(self.player, "Goto Carthus catacombs", farron_keep_region)) self.multiworld.get_entrance("Goto Carthus catacombs", self.player).connect(catacombs_of_carthus_region) catacombs_of_carthus_region.exits.append(Entrance(self.player, "Goto Irithyll of the boreal", catacombs_of_carthus_region)) catacombs_of_carthus_region.exits.append(Entrance(self.player, "Goto Smouldering Lake", catacombs_of_carthus_region)) self.multiworld.get_entrance("Goto Irithyll of the boreal", self.player). \ connect(irithyll_of_the_boreal_valley_region) self.multiworld.get_entrance("Goto Smouldering Lake", self.player).connect(smouldering_lake_region) irithyll_of_the_boreal_valley_region.exits.append(Entrance(self.player, "Goto Irithyll dungeon", irithyll_of_the_boreal_valley_region)) irithyll_of_the_boreal_valley_region.exits.append(Entrance(self.player, "Goto Anor Londo", irithyll_of_the_boreal_valley_region)) self.multiworld.get_entrance("Goto Irithyll dungeon", self.player).connect(irithyll_dungeon_region) self.multiworld.get_entrance("Goto Anor Londo", self.player).connect(anor_londo_region) irithyll_dungeon_region.exits.append(Entrance(self.player, "Goto Archdragon peak", irithyll_dungeon_region)) irithyll_dungeon_region.exits.append(Entrance(self.player, "Goto Profaned capital", irithyll_dungeon_region)) self.multiworld.get_entrance("Goto Archdragon peak", self.player).connect(archdragon_peak_region) self.multiworld.get_entrance("Goto Profaned capital", self.player).connect(profaned_capital_region) lothric_castle_region.exits.append(Entrance(self.player, "Goto Consumed King Garden", lothric_castle_region)) lothric_castle_region.exits.append(Entrance(self.player, "Goto Grand Archives", lothric_castle_region)) self.multiworld.get_entrance("Goto Consumed King Garden", self.player).connect(consumed_king_garden_region) self.multiworld.get_entrance("Goto Grand Archives", self.player).connect(grand_archives_region) consumed_king_garden_region.exits.append(Entrance(self.player, "Goto Untended Graves", consumed_king_garden_region)) self.multiworld.get_entrance("Goto Untended Graves", self.player).connect(untended_graves_region) # DLC Connectors Below if self.multiworld.enable_dlc[self.player]: cathedral_of_the_deep_region.exits.append(Entrance(self.player, "Goto Painted World of Ariandel", cathedral_of_the_deep_region)) self.multiworld.get_entrance("Goto Painted World of Ariandel", self.player).connect(painted_world_of_ariandel_region) painted_world_of_ariandel_region.exits.append(Entrance(self.player, "Goto Dreg Heap", painted_world_of_ariandel_region)) self.multiworld.get_entrance("Goto Dreg Heap", self.player).connect(dreg_heap_region) dreg_heap_region.exits.append(Entrance(self.player, "Goto Ringed City", dreg_heap_region)) self.multiworld.get_entrance("Goto Ringed City", self.player).connect(ringed_city_region) # For each region, add the associated locations retrieved from the corresponding location_table def create_region(self, region_name, location_table) -> Region: new_region = Region(region_name, self.player, self.multiworld) if location_table: for name, address in location_table.items(): location = DarkSouls3Location(self.player, name, self.location_name_to_id[name], new_region) if region_name == "Menu": add_item_rule(location, lambda item: not item.advancement) new_region.locations.append(location) self.multiworld.regions.append(new_region) return new_region def create_items(self): for name, address in self.item_name_to_id.items(): # Specific items will be included in the item pool under certain conditions. See generate_basic if name == "Basin of Vows": continue # Do not add progressive_items ( containing "#" ) to the itempool if the option is disabled if (not self.multiworld.enable_progressive_locations[self.player]) and "#" in name: continue # Do not add DLC items if the option is disabled if (not self.multiworld.enable_dlc[self.player]) and DarkSouls3Item.is_dlc_item(name): continue # Do not add DLC Progressives if both options are disabled if ((not self.multiworld.enable_progressive_locations[self.player]) or (not self.multiworld.enable_dlc[self.player])) and DarkSouls3Item.is_dlc_progressive(name): continue self.multiworld.itempool += [self.create_item(name)] def generate_early(self): pass def set_rules(self) -> None: # Define the access rules to the entrances set_rule(self.multiworld.get_entrance("Goto Bell Tower", self.player), lambda state: state.has("Tower Key", self.player)) set_rule(self.multiworld.get_entrance("Goto Undead Settlement", self.player), lambda state: state.has("Small Lothric Banner", self.player)) set_rule(self.multiworld.get_entrance("Goto Lothric Castle", self.player), lambda state: state.has("Basin of Vows", self.player)) set_rule(self.multiworld.get_entrance("Goto Irithyll of the boreal", self.player), lambda state: state.has("Small Doll", self.player)) set_rule(self.multiworld.get_entrance("Goto Archdragon peak", self.player), lambda state: state.can_reach("CKG: Soul of Consumed Oceiros", "Location", self.player)) set_rule(self.multiworld.get_entrance("Goto Profaned capital", self.player), lambda state: state.has("Storm Ruler", self.player)) set_rule(self.multiworld.get_entrance("Goto Grand Archives", self.player), lambda state: state.has("Grand Archives Key", self.player)) set_rule(self.multiworld.get_entrance("Goto Kiln Of The First Flame", self.player), lambda state: state.has("Cinders of a Lord - Abyss Watcher", self.player) and state.has("Cinders of a Lord - Yhorm the Giant", self.player) and state.has("Cinders of a Lord - Aldrich", self.player) and state.has("Cinders of a Lord - Lothric Prince", self.player)) # DLC Access Rules Below if self.multiworld.enable_dlc[self.player]: set_rule(self.multiworld.get_entrance("Goto Painted World of Ariandel", self.player), lambda state: state.has("Contraption Key", self.player)) set_rule(self.multiworld.get_entrance("Goto Ringed City", self.player), lambda state: state.has("Small Envoy Banner", self.player)) # Define the access rules to some specific locations set_rule(self.multiworld.get_location("HWL: Soul of the Dancer", self.player), lambda state: state.has("Basin of Vows", self.player)) set_rule(self.multiworld.get_location("HWL: Greirat's Ashes", self.player), lambda state: state.has("Cell Key", self.player)) set_rule(self.multiworld.get_location("HWL: Blue Tearstone Ring", self.player), lambda state: state.has("Cell Key", self.player)) set_rule(self.multiworld.get_location("ID: Bellowing Dragoncrest Ring", self.player), lambda state: state.has("Jailbreaker's Key", self.player)) set_rule(self.multiworld.get_location("ID: Prisoner Chief's Ashes", self.player), lambda state: state.has("Jailer's Key Ring", self.player)) set_rule(self.multiworld.get_location("ID: Covetous Gold Serpent Ring", self.player), lambda state: state.has("Old Cell Key", self.player)) set_rule(self.multiworld.get_location("ID: Karla's Ashes", self.player), lambda state: state.has("Jailer's Key Ring", self.player)) black_hand_gotthard_corpse_rule = lambda state: \ (state.can_reach("AL: Cinders of a Lord - Aldrich", "Location", self.player) and state.can_reach("PC: Cinders of a Lord - Yhorm the Giant", "Location", self.player)) set_rule(self.multiworld.get_location("LC: Grand Archives Key", self.player), black_hand_gotthard_corpse_rule) set_rule(self.multiworld.get_location("LC: Gotthard Twinswords", self.player), black_hand_gotthard_corpse_rule) self.multiworld.completion_condition[self.player] = lambda state: \ state.has("Cinders of a Lord - Abyss Watcher", self.player) and \ state.has("Cinders of a Lord - Yhorm the Giant", self.player) and \ state.has("Cinders of a Lord - Aldrich", self.player) and \ state.has("Cinders of a Lord - Lothric Prince", self.player) def generate_basic(self): # Depending on the specified option, add the Basin of Vows to a specific location or to the item pool item = self.create_item("Basin of Vows") if self.multiworld.late_basin_of_vows[self.player]: self.multiworld.get_location("IBV: Soul of Pontiff Sulyvahn", self.player).place_locked_item(item) else: self.multiworld.itempool += [item] # Fill item pool with additional items item_pool_len = self.item_name_to_id.__len__() total_required_locations = self.location_name_to_id.__len__() for i in range(item_pool_len, total_required_locations): self.multiworld.itempool += [self.create_item("Soul of an Intrepid Hero")] def fill_slot_data(self) -> Dict[str, object]: slot_data: Dict[str, object] = {} # Depending on the specified option, modify items hexadecimal value to add an upgrade level item_dictionary_copy = item_dictionary.copy() if self.multiworld.randomize_weapons_level[self.player] > 0: # if the user made an error and set a min higher than the max we default to the max max_5 = self.multiworld.max_levels_in_5[self.player] min_5 = min(self.multiworld.min_levels_in_5[self.player], max_5) max_10 = self.multiworld.max_levels_in_10[self.player] min_10 = min(self.multiworld.min_levels_in_10[self.player], max_10) weapons_percentage = self.multiworld.randomize_weapons_percentage[self.player] # Randomize some weapons upgrades if self.multiworld.randomize_weapons_level[self.player] in [1, 3]: # Options are either all or +5 for name in weapons_upgrade_5_table.keys(): if self.multiworld.per_slot_randoms[self.player].randint(1, 100) < weapons_percentage: value = self.multiworld.per_slot_randoms[self.player].randint(min_5, max_5) item_dictionary_copy[name] += value if self.multiworld.randomize_weapons_level[self.player] in [1, 2]: # Options are either all or +10 for name in weapons_upgrade_10_table.keys(): if self.multiworld.per_slot_randoms[self.player].randint(1, 100) < weapons_percentage: value = self.multiworld.per_slot_randoms[self.player].randint(min_10, max_10) item_dictionary_copy[name] += value if self.multiworld.randomize_weapons_level[self.player] in [1, 3]: for name in dlc_weapons_upgrade_5_table.keys(): if self.multiworld.per_slot_randoms[self.player].randint(1, 100) < weapons_percentage: value = self.multiworld.per_slot_randoms[self.player].randint(min_5, max_5) item_dictionary_copy[name] += value if self.multiworld.randomize_weapons_level[self.player] in [1, 2]: for name in dlc_weapons_upgrade_10_table.keys(): if self.multiworld.per_slot_randoms[self.player].randint(1, 100) < weapons_percentage: value = self.multiworld.per_slot_randoms[self.player].randint(min_10, max_10) item_dictionary_copy[name] += value # Create the mandatory lists to generate the player's output file items_id = [] items_address = [] locations_id = [] locations_address = [] locations_target = [] for location in self.multiworld.get_filled_locations(): if location.item.player == self.player: items_id.append(location.item.code) items_address.append(item_dictionary_copy[location.item.name]) if location.player == self.player: locations_address.append(location_dictionary[location.name]) locations_id.append(location.address) if location.item.player == self.player: locations_target.append(item_dictionary_copy[location.item.name]) else: locations_target.append(0) slot_data = { "options": { "auto_equip": self.multiworld.auto_equip[self.player].value, "lock_equip": self.multiworld.lock_equip[self.player].value, "no_weapon_requirements": self.multiworld.no_weapon_requirements[self.player].value, "death_link": self.multiworld.death_link[self.player].value, "no_spell_requirements": self.multiworld.no_spell_requirements[self.player].value, "no_equip_load": self.multiworld.no_equip_load[self.player].value, "enable_dlc": self.multiworld.enable_dlc[self.player].value }, "seed": self.multiworld.seed_name, # to verify the server's multiworld "slot": self.multiworld.player_name[self.player], # to connect to server "base_id": self.base_id, # to merge location and items lists "locationsId": locations_id, "locationsAddress": locations_address, "locationsTarget": locations_target, "itemsId": items_id, "itemsAddress": items_address } return slot_data