Archipelago/worlds/messenger/__init__.py

import logging
from typing import Dict, Any, Optional

from BaseClasses import Tutorial, ItemClassification, CollectionState, Item, MultiWorld
from worlds.AutoWorld import World, WebWorld
from .Constants import NOTES, PHOBEKINS, ALL_ITEMS, ALWAYS_LOCATIONS, BOSS_LOCATIONS, FILLER
from .Options import messenger_options, NotesNeeded, Goal, PowerSeals, Logic
from .Regions import REGIONS, REGION_CONNECTIONS, SEALS, MEGA_SHARDS
from .Shop import SHOP_ITEMS, shuffle_shop_prices, FIGURINES
from .SubClasses import MessengerRegion, MessengerItem
from . import Rules


class MessengerWeb(WebWorld):
    theme = "ocean"

    bug_report_page = "https://github.com/alwaysintreble/TheMessengerRandomizerModAP/issues"

    tut_en = Tutorial(
        "Multiworld Setup Tutorial",
        "A guide to setting up The Messenger randomizer on your computer.",
        "English",
        "setup_en.md",
        "setup/en",
        ["alwaysintreble"],
    )

    tutorials = [tut_en]


class MessengerWorld(World):
    """
    As a demon army besieges his village, a young ninja ventures through a cursed world, to deliver a scroll paramount
    to his clan’s survival. What begins as a classic action platformer soon unravels into an expansive time-traveling
    adventure full of thrills, surprises, and humor.
    """
    game = "The Messenger"

    item_name_groups = {
        "Notes": set(NOTES),
        "Keys": set(NOTES),
        "Crest": {"Sun Crest", "Moon Crest"},
        "Phobe": set(PHOBEKINS),
        "Phobekin": set(PHOBEKINS),
    }

    option_definitions = messenger_options

    base_offset = 0xADD_000
    item_name_to_id = {item: item_id
                       for item_id, item in enumerate(ALL_ITEMS, base_offset)}
    location_name_to_id = {location: location_id
                           for location_id, location in
                           enumerate([
                               *ALWAYS_LOCATIONS,
                               *[seal for seals in SEALS.values() for seal in seals],
                               *[shard for shards in MEGA_SHARDS.values() for shard in shards],
                               *BOSS_LOCATIONS,
                               *[f"The Shop - {shop_loc}" for shop_loc in SHOP_ITEMS],
                               *FIGURINES,
                               "Money Wrench",
                           ], base_offset)}

    data_version = 3
    required_client_version = (0, 4, 0)

    web = MessengerWeb()

    total_seals: int = 0
    required_seals: int = 0
    total_shards: int
    shop_prices: Dict[str, int]
    figurine_prices: Dict[str, int]

    def __init__(self, multiworld: MultiWorld, player: int):
        super().__init__(multiworld, player)
        self.total_shards = 0

    def generate_early(self) -> None:
        if self.multiworld.goal[self.player] == Goal.option_power_seal_hunt:
            self.multiworld.shuffle_seals[self.player].value = PowerSeals.option_true
            self.total_seals = self.multiworld.total_seals[self.player].value

        self.shop_prices, self.figurine_prices = shuffle_shop_prices(self)

    def create_regions(self) -> None:
        for region in [MessengerRegion(reg_name, self) for reg_name in REGIONS]:
            if region.name in REGION_CONNECTIONS:
                region.add_exits(REGION_CONNECTIONS[region.name])

    def create_items(self) -> None:
        # create items that are always in the item pool
        itempool = [
            self.create_item(item)
            for item in self.item_name_to_id
            if item not in
            {
                "Power Seal", *NOTES, *FIGURINES,
                *{collected_item.name for collected_item in self.multiworld.precollected_items[self.player]},
            } and "Time Shard" not in item
        ]

        if self.multiworld.goal[self.player] == Goal.option_open_music_box:
            # make a list of all notes except those in the player's defined starting inventory, and adjust the
            # amount we need to put in the itempool and precollect based on that
            notes = [note for note in NOTES if note not in self.multiworld.precollected_items[self.player]]
            self.random.shuffle(notes)
            precollected_notes_amount = NotesNeeded.range_end - \
                self.multiworld.notes_needed[self.player] - \
                (len(NOTES) - len(notes))
            if precollected_notes_amount:
                for note in notes[:precollected_notes_amount]:
                    self.multiworld.push_precollected(self.create_item(note))
                notes = notes[precollected_notes_amount:]
            itempool += [self.create_item(note) for note in notes]

        elif self.multiworld.goal[self.player] == Goal.option_power_seal_hunt:
            total_seals = min(len(self.multiworld.get_unfilled_locations(self.player)) - len(itempool),
                              self.multiworld.total_seals[self.player].value)
            if total_seals < self.total_seals:
                logging.warning(f"Not enough locations for total seals setting "
                                f"({self.multiworld.total_seals[self.player].value}). Adjusting to {total_seals}")
                self.total_seals = total_seals
            self.required_seals =\
                int(self.multiworld.percent_seals_required[self.player].value / 100 * self.total_seals)

            seals = [self.create_item("Power Seal") for _ in range(self.total_seals)]
            for i in range(self.required_seals):
                seals[i].classification = ItemClassification.progression_skip_balancing
            itempool += seals

        remaining_fill = len(self.multiworld.get_unfilled_locations(self.player)) - len(itempool)
        filler_pool = dict(list(FILLER.items())[2:]) if remaining_fill < 10 else FILLER
        itempool += [self.create_item(filler_item)
                     for filler_item in
                     self.random.choices(
                         list(filler_pool),
                         weights=list(filler_pool.values()),
                         k=remaining_fill
                     )]

        self.multiworld.itempool += itempool

    def set_rules(self) -> None:
        logic = self.multiworld.logic_level[self.player]
        if logic == Logic.option_normal:
            Rules.MessengerRules(self).set_messenger_rules()
        elif logic == Logic.option_hard:
            Rules.MessengerHardRules(self).set_messenger_rules()
        else:
            Rules.MessengerOOBRules(self).set_messenger_rules()

    def fill_slot_data(self) -> Dict[str, Any]:
        shop_prices = {SHOP_ITEMS[item].internal_name: price for item, price in self.shop_prices.items()}
        figure_prices = {FIGURINES[item].internal_name: price for item, price in self.figurine_prices.items()}

        return {
            "deathlink": self.multiworld.death_link[self.player].value,
            "goal": self.multiworld.goal[self.player].current_key,
            "music_box": self.multiworld.music_box[self.player].value,
            "required_seals": self.required_seals,
            "mega_shards": self.multiworld.shuffle_shards[self.player].value,
            "logic": self.multiworld.logic_level[self.player].current_key,
            "shop": shop_prices,
            "figures": figure_prices,
            "max_price": self.total_shards,
        }

    def get_filler_item_name(self) -> str:
        return "Time Shard"

    def create_item(self, name: str) -> MessengerItem:
        item_id: Optional[int] = self.item_name_to_id.get(name, None)
        override_prog = getattr(self, "multiworld") is not None and \
            name in {"Windmill Shuriken"} and \
            self.multiworld.logic_level[self.player] > Logic.option_normal
        count = 0
        if "Time Shard " in name:
            count = int(name.strip("Time Shard ()"))
            count = count if count >= 100 else 0
            self.total_shards += count
        return MessengerItem(name, self.player, item_id, override_prog, count)

    def collect_item(self, state: "CollectionState", item: "Item", remove: bool = False) -> Optional[str]:
        if item.advancement and "Time Shard" in item.name:
            shard_count = int(item.name.strip("Time Shard ()"))
            if remove:
                shard_count = -shard_count
            state.prog_items["Shards", self.player] += shard_count

        return super().collect_item(state, item, remove)