Archipelago/worlds/stardew_valley/options.py

from dataclasses import dataclass
from typing import Dict, Union, Protocol, runtime_checkable, ClassVar

from Options import Option, Range, DeathLink, SpecialRange, Toggle, Choice


@runtime_checkable
class StardewOption(Protocol):
    internal_name: ClassVar[str]


@dataclass
class StardewOptions:
    options: Dict[str, Union[bool, int]]

    def __getitem__(self, item: Union[str, StardewOption]) -> Union[bool, int]:
        if isinstance(item, StardewOption):
            item = item.internal_name

        return self.options.get(item, None)


class Goal(Choice):
    """What's your goal with this play-through?
    Community Center: The world will be completed once you complete the Community Center.
    Grandpa's Evaluation: The world will be completed once 4 candles are lit at Grandpa's Shrine.
    Bottom of the Mines: The world will be completed once you reach level 120 in the mineshaft.
    Cryptic Note: The world will be completed once you complete the quest "Cryptic Note" where Mr Qi asks you to reach floor 100 in the Skull Cavern.
    Master Angler: The world will be completed once you have caught every fish in the game. Pairs well with Fishsanity.
    Complete Collection: The world will be completed once you have completed the museum by donating every possible item. Pairs well with Museumsanity.
    Full House: The world will be completed once you get married and have two kids. Pairs well with Friendsanity.
    """
    internal_name = "goal"
    display_name = "Goal"
    default = 0
    option_community_center = 0
    option_grandpa_evaluation = 1
    option_bottom_of_the_mines = 2
    option_cryptic_note = 3
    option_master_angler = 4
    option_complete_collection = 5
    option_full_house = 6

    @classmethod
    def get_option_name(cls, value) -> str:
        if value == cls.option_grandpa_evaluation:
            return "Grandpa's Evaluation"

        return super().get_option_name(value)


class StartingMoney(SpecialRange):
    """Amount of gold when arriving at the farm.
    Set to -1 or unlimited for infinite money in this playthrough"""
    internal_name = "starting_money"
    display_name = "Starting Gold"
    range_start = -1
    range_end = 50000
    default = 5000

    special_range_names = {
        "unlimited": -1,
        "vanilla": 500,
        "extra": 2000,
        "rich": 5000,
        "very rich": 20000,
        "filthy rich": 50000,
    }


class ResourcePackMultiplier(SpecialRange):
    """How many items will be in the resource packs. A lower setting mean fewer resources in each pack.
    A higher setting means more resources in each pack. Easy (200) doubles the default quantity"""
    internal_name = "resource_pack_multiplier"
    default = 100
    range_start = 0
    range_end = 200
    # step = 25
    display_name = "Resource Pack Multiplier"

    special_range_names = {
        "resource packs disabled": 0,
        "half packs": 50,
        "normal packs": 100,
        "double packs": 200,
    }


class BundleRandomization(Choice):
    """What items are needed for the community center bundles?
    Vanilla: Standard bundles from the vanilla game
    Thematic: Every bundle will require random items compatible with their original theme
    Shuffled: Every bundle will require random items and follow no particular structure"""
    internal_name = "bundle_randomization"
    display_name = "Bundle Randomization"
    default = 1
    option_vanilla = 0
    option_thematic = 1
    option_shuffled = 2


class BundlePrice(Choice):
    """How many items are needed for the community center bundles?
    Very Cheap: Every bundle will require 2 items fewer than usual
    Cheap: Every bundle will require 1 item fewer than usual
    Normal: Every bundle will require the vanilla number of items
    Expensive: Every bundle will require 1 extra item when applicable"""
    internal_name = "bundle_price"
    display_name = "Bundle Price"
    default = 2
    option_very_cheap = 0
    option_cheap = 1
    option_normal = 2
    option_expensive = 3


class EntranceRandomization(Choice):
    """Should area entrances be randomized?
    Disabled: No entrance randomization is done
    Pelican Town: Only buildings in the main town area are randomized among each other
    Non Progression: Only buildings that are always available are randomized with each other
    """
    # Buildings: All buildings in the world are randomized with each other
    # Everything: All buildings and areas are randomized with each other
    # Chaos, same as everything: but the buildings are shuffled again every in-game day. You can't learn it!
    # Buildings One-way: Entrance pairs are disconnected, they aren't two-way!
    # Everything One-way: Entrance pairs are disconnected, and every entrance is in the shuffle
    # Chaos One-way: Entrance pairs are disconnected, and they change every day!

    internal_name = "entrance_randomization"
    display_name = "Entrance Randomization"
    default = 0
    option_disabled = 0
    option_pelican_town = 1
    option_non_progression = 2
    # option_buildings = 3
    # option_everything = 4
    # option_chaos = 4
    # option_buildings_one_way = 5
    # option_everything_one_way = 6
    # option_chaos_one_way = 7


class SeasonRandomization(Choice):
    """Should seasons be randomized?
    All settings allow you to choose which season you want to play next (from those unlocked) at the end of a season.
    Disabled: You will start in Spring with all seasons unlocked.
    Randomized: The seasons will be unlocked randomly as Archipelago items.
    Randomized Not Winter: The seasons are randomized, but you're guaranteed not to start with winter.
    Progressive: You will start in Spring and unlock the seasons in their original order.
    """
    internal_name = "season_randomization"
    display_name = "Season Randomization"
    default = 1
    option_disabled = 0
    option_randomized = 1
    option_randomized_not_winter = 2
    option_progressive = 3


class SeedShuffle(Choice):
    """Should seeds be randomized?
    Pierre now sells a random amount of seasonal seeds and Joja sells them without season requirements, but only in huge packs.
    Disabled: All the seeds will be unlocked from the start.
    Shuffled: The seeds will be unlocked as Archipelago items
    """
    internal_name = "seed_shuffle"
    display_name = "Seed Shuffle"
    default = 1
    option_disabled = 0
    option_shuffled = 1


class BackpackProgression(Choice):
    """How is the backpack progression handled?
    Vanilla: You can buy them at Pierre's General Store.
    Progressive: You will randomly find Progressive Backpack upgrades.
    Early Progressive: You can expect your first Backpack in sphere 1.
    """
    internal_name = "backpack_progression"
    display_name = "Backpack Progression"
    default = 2
    option_vanilla = 0
    option_progressive = 1
    option_early_progressive = 2


class ToolProgression(Choice):
    """How is the tool progression handled?
    Vanilla: Clint will upgrade your tools with ore.
    Progressive: You will randomly find Progressive Tool upgrades."""
    internal_name = "tool_progression"
    display_name = "Tool Progression"
    default = 1
    option_vanilla = 0
    option_progressive = 1


class TheMinesElevatorsProgression(Choice):
    """How is The Mines' Elevator progression handled?
    Vanilla: You will unlock a new elevator floor every 5 floor in the mine.
    Progressive: You will randomly find Progressive Mine Elevator to go deeper. Location are sent for reaching
        every level multiple of 5.
    Progressive from previous floor: Locations are sent for taking the ladder or stairs to every 5
        levels, taking the elevator does not count."""
    internal_name = "elevator_progression"
    display_name = "Elevator Progression"
    default = 2
    option_vanilla = 0
    option_progressive = 1
    option_progressive_from_previous_floor = 2


class SkillProgression(Choice):
    """How is the skill progression handled?
    Vanilla: You will level up and get the normal reward at each level.
    Progressive: The xp will be earned internally, locations will be sent when you earn a level. Your real
        levels will be scattered around the multiworld."""
    internal_name = "skill_progression"
    display_name = "Skill Progression"
    default = 1
    option_vanilla = 0
    option_progressive = 1


class BuildingProgression(Choice):
    """How is the building progression handled?
    Vanilla: You will buy each building normally.
    Progressive: You will receive the buildings and will be able to build the first one of each type for free,
        once it is received. If you want more of the same building, it will cost the vanilla price.
    Progressive early shipping bin: You can expect your shipping bin in sphere 1.
    """
    internal_name = "building_progression"
    display_name = "Building Progression"
    default = 2
    option_vanilla = 0
    option_progressive = 1
    option_progressive_early_shipping_bin = 2


class ArcadeMachineLocations(Choice):
    """How are the Arcade Machines handled?
    Vanilla: The arcade machines are not included in the Archipelago shuffling.
    Victories: Each Arcade Machine will contain one check on victory
    Victories Easy: The arcade machines are both made considerably easier to be more accessible for the average
        player.
    Full Shuffling: The arcade machines will contain multiple checks each, and different buffs that make the game
        easier are in the item pool. Junimo Kart has one check at the end of each level.
        Journey of the Prairie King has one check after each boss, plus one check for each vendor equipment.
    """
    internal_name = "arcade_machine_locations"
    display_name = "Arcade Machine Locations"
    default = 3
    option_disabled = 0
    option_victories = 1
    option_victories_easy = 2
    option_full_shuffling = 3


class HelpWantedLocations(SpecialRange):
    """How many "Help Wanted" quests need to be completed as Archipelago Locations
    Out of every 7 quests, 4 will be item deliveries, and then 1 of each for: Fishing, Gathering and Slaying Monsters.
    Choosing a multiple of 7 is recommended."""
    internal_name = "help_wanted_locations"
    default = 7
    range_start = 0
    range_end = 56
    # step = 7
    display_name = "Number of Help Wanted locations"

    special_range_names = {
        "none": 0,
        "minimum": 7,
        "normal": 14,
        "lots": 28,
        "maximum": 56,
    }


class Fishsanity(Choice):
    """Locations for catching fish?
    None: There are no locations for catching fish
    Legendaries: Each of the 5 legendary fish are checks
    Special: A curated selection of strong fish are checks
    Randomized: A random selection of fish are checks
    All: Every single fish in the game is a location that contains an item. Pairs well with the Master Angler Goal
    """
    internal_name = "fishsanity"
    display_name = "Fishsanity"
    default = 0
    option_none = 0
    option_legendaries = 1
    option_special = 2
    option_randomized = 3
    alias_random_selection = option_randomized
    option_all = 4


class Museumsanity(Choice):
    """Locations for museum donations?
    None: There are no locations for donating artifacts and minerals to the museum
    Milestones: The donation milestones from the vanilla game are checks
    Randomized: A random selection of minerals and artifacts are checks
    All: Every single donation will be a check
    """
    internal_name = "museumsanity"
    display_name = "Museumsanity"
    default = 1
    option_none = 0
    option_milestones = 1
    option_randomized = 2
    option_all = 3


class Friendsanity(Choice):
    """Locations for friendships?
    None: There are no checks for befriending villagers
    Bachelors: Each heart of a bachelor is a check
    Starting NPCs: Each heart for npcs that are immediately available is a check
    All: Every heart with every NPC is a check, including Leo, Kent, Sandy, etc
    All With Marriage: Marriage candidates must also be dated, married, and befriended up to 14 hearts.
    """
    internal_name = "friendsanity"
    display_name = "Friendsanity"
    default = 0
    option_none = 0
    # option_marry_one_person = 1
    option_bachelors = 2
    option_starting_npcs = 3
    option_all = 4
    option_all_with_marriage = 5


class NumberOfPlayerBuffs(Range):
    """Number of buffs to the player of each type that exist as items in the pool.
    Buffs include movement speed (+25% multiplier, stacks additively)
    and daily luck bonus (0.025 flat value per buff)"""
    internal_name = "player_buff_number"
    display_name = "Number of Player Buffs"
    range_start = 0
    range_end = 12
    default = 4
    # step = 1


class MultipleDaySleepEnabled(Toggle):
    """Enable the ability to sleep automatically for multiple days straight?"""
    internal_name = "multiple_day_sleep_enabled"
    display_name = "Multiple Day Sleep Enabled"
    default = 1


class MultipleDaySleepCost(SpecialRange):
    """How much gold it will cost to use MultiSleep. You will have to pay that amount for each day skipped."""
    internal_name = "multiple_day_sleep_cost"
    display_name = "Multiple Day Sleep Cost"
    range_start = 0
    range_end = 200
    # step = 25

    special_range_names = {
        "free": 0,
        "cheap": 25,
        "medium": 50,
        "expensive": 100,
    }


class ExperienceMultiplier(SpecialRange):
    """How fast you want to earn skill experience. A lower setting mean less experience.
    A higher setting means more experience."""
    internal_name = "experience_multiplier"
    display_name = "Experience Multiplier"
    range_start = 25
    range_end = 400
    # step = 25
    default = 200

    special_range_names = {
        "half": 50,
        "vanilla": 100,
        "double": 200,
        "triple": 300,
        "quadruple": 400,
    }


class FriendshipMultiplier(SpecialRange):
    """How fast you want to earn friendship points with villagers.
    A lower setting mean less friendship per action.
    A higher setting means more friendship per action."""
    internal_name = "friendship_multiplier"
    display_name = "Friendship Multiplier"
    range_start = 25
    range_end = 400
    # step = 25
    default = 200

    special_range_names = {
        "half": 50,
        "vanilla": 100,
        "double": 200,
        "triple": 300,
        "quadruple": 400,
    }


class DebrisMultiplier(Choice):
    """How much debris will spawn on the player's farm?
    Vanilla: debris spawns normally
    Half: debris will spawn at half the normal rate
    Quarter: debris will spawn at one quarter of the normal rate
    None: No debris will spawn on the farm, ever
    Start Clear: debris will spawn at the normal rate, but the farm will be completely clear when starting the game
    """
    internal_name = "debris_multiplier"
    display_name = "Debris Multiplier"
    default = 1
    option_vanilla = 0
    option_half = 1
    option_quarter = 2
    option_none = 3
    option_start_clear = 4


class QuickStart(Toggle):
    """Do you want the quick start package? You will get a few items to help early game automation,
    so you can use the multiple day sleep at its maximum."""
    internal_name = "quick_start"
    display_name = "Quick Start"
    default = 1


class Gifting(Toggle):
    """Do you want to enable gifting items to and from other Stardew Valley worlds?"""
    internal_name = "gifting"
    display_name = "Gifting"
    default = 1


class GiftTax(SpecialRange):
    """Joja Prime will deliver gifts within one business day, for a price!
    Sending a gift will cost a percentage of the item's monetary value as a tax on the sender"""
    internal_name = "gift_tax"
    display_name = "Gift Tax"
    range_start = 0
    range_end = 400
    # step = 20
    default = 20

    special_range_names = {
        "no tax": 0,
        "soft tax": 20,
        "rough tax": 40,
        "full tax": 100,
        "oppressive tax": 200,
        "nightmare tax": 400,
    }


stardew_valley_option_classes = [
    Goal,
    StartingMoney,
    ResourcePackMultiplier,
    BundleRandomization,
    BundlePrice,
    EntranceRandomization,
    SeasonRandomization,
    SeedShuffle,
    BackpackProgression,
    ToolProgression,
    SkillProgression,
    BuildingProgression,
    TheMinesElevatorsProgression,
    ArcadeMachineLocations,
    HelpWantedLocations,
    Fishsanity,
    Museumsanity,
    Friendsanity,
    NumberOfPlayerBuffs,
    MultipleDaySleepEnabled,
    MultipleDaySleepCost,
    ExperienceMultiplier,
    FriendshipMultiplier,
    DebrisMultiplier,
    QuickStart,
    Gifting,
    GiftTax,
]
stardew_valley_options: Dict[str, type(Option)] = {option.internal_name: option for option in
                                                   stardew_valley_option_classes}
default_options = {option.internal_name: option.default for option in stardew_valley_options.values()}
stardew_valley_options["death_link"] = DeathLink


def fetch_options(world, player: int) -> StardewOptions:
    return StardewOptions({option: get_option_value(world, player, option) for option in stardew_valley_options})


def get_option_value(world, player: int, name: str) -> Union[bool, int]:
    assert name in stardew_valley_options, f"{name} is not a valid option for Stardew Valley."

    value = getattr(world, name)

    if issubclass(stardew_valley_options[name], Toggle):
        return bool(value[player].value)
    return value[player].value