dockipelago/worlds/apeescape3/AE3_Options.py

from dataclasses import dataclass
from typing import Iterable, Any

from Options import OptionGroup, Toggle, DefaultOnToggle, Choice, PerGameCommonOptions, DeathLink, Visibility, \
    Range, OptionList, OptionSet, NamedRange
from .data.Strings import APHelper
from .data.Stages import LEVELS_BY_ORDER


class ProgressionMode(Choice):
    """
    Choose how the progression of the randomizer should be.
    Default: Group

    > Singles - Each Stage will be unlocked one by one, as long as you find the Channel Key.
    > Group - Alternate between unlocking groups of stages and the bosses in between.
    > World - Progression is similar to Group, but the bosses are unlocked along with their preceding stages.
    > Quadruples - Each set of Levels will have 4 channels each!
    > Open* - All levels except the final two are immediately unlocked, but a certain number amount of keys is needed
    to access the next level. The default required is 10 Channel Keys.
    > Randomize* - How many levels are unlocked in a set is all up to chance!

    * These options can be customized with their respective options below.
    """
    display_name : str = "Progression Mode"
    default = 1

    option_singles : int = 0
    option_group : int = 1
    option_world : int = 2
    option_quadruples : int = 3
    option_open : int = 4
    option_randomize : int = 5

class OpenProgressionKeys(Range):
    """
    If the chosen Progression Mode is `open`, this option allows the amount of keys required to unlock the endgame
    channel to be customized.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name : str = "Open Progression Mode Required Keys"
    default = 10

    range_start = 5
    range_end = 30


class RandomizeProgressionSetCount(Range):
    """
    If the chosen Progression mode is `randomize`, this option allows you to control the amount of channel sets
    that will be generated, and by extension, the minimum amount of keys to reach the end (but not post) game.
    Leave this at 0 for a more freeform Channel Randomization, or leave it to generation to decide for you.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name : str = "Randomize Progression Set Count"
    default = 0

    range_start = 3
    range_end = 28

    def __init__(self, value):
        if value == 0:
           self.value = value
           return

        super().__init__(value)


class RandomizeProgressionChannelRange(OptionList):
    """
    If the chosen mode is `randomize`, this option allows you to control the amount of possible channels that can
    be included in a set. Leave this empty to let generation decide for you, or specify a maximum and minimum
    value for generation to use to randomize for each set. A set value can also be used if only one value is specified.

    If a Set Count has been specified, it will be prioritized over this option,
    but generation will still attempt to respect this option as much as possible.

    <!> WARNING: This option expects *a list of one or two integers*
    Format (Range): [min, max]
    Format (Set): [value]

    Absolute Minimum : 1
    Absolute Maximum : 28
    """
    display_name : str = "Randomize Progression Channel Range"
    default = []

    def __init__(self, value: Iterable[Any]) -> None:
        super().__init__(value)

        if len(self.value) == 0:
            return

        if not all(isinstance(_, int) for _ in self.value):
            raise TypeError("AE3 > RandomizeProgressionChannelCount: One or more item(s) is not an integer.")

        # Treat as default if both values are 0
        if sum(self.value) == 0:
            self.value.clear()
            return

        # Truncate if needed
        if len(self.value) == 1:
            self.value = value
        elif len(self.value) > 2:
            self.value = self.value[:2]

        # Swap if needed
        if self.value[0] > self.value[1]:
            self.value[0], self.value[1] = self.value[1], self.value[0]

        self.value[0] = max(min(self.value[0], 28), 1)
        self.value[1] = 28 if self.value[1] == 0 else max(min(self.value[1], 28), self.value[0])

class LogicPreference(Choice):
    """
    Choose a certain logic preset that determines how difficult the game will be and how much expertise is asked from
    the player.

    > casual - Gadgets and Morphs are attempted to be given as early as possible
    > normal - Gadgets and Morphs are given as needed by a normal playthrough of the game
    > hard - Gadgets and Morphs are given as late as possible, where certain occasions may arise
    where an unintuitive solution must be used, while still not requiring glitches
    > expert - Glitches may often need to be exploited to progress

    Default: normal
    """
    display_name : str = "Logic Preference"
    default = 1

    option_casual : int = 0
    option_normal : int = 1
    option_hard : int = 2
    option_expert: int = 3

class HipDropStorageLogic(Toggle):
    """
    Determine if Hip Drop Storage should be considered for Logic.
    """
    display_name : str = "Hip Drop Storage Logic"

class ProlongedQuadJumpLogic(Toggle):
    """
    Determine if using Quad Jumps for extended periods of time should be considered for Logic.
    """
    display_name : str = "Prolonged Quad Jump Logic"


class GoalTarget(Choice):
    """
    Choose what will count as winning the game.
    Default: specter

    > specter - Clear Specter's Battle (Vanilla End Game)
    > specter_final - Clear Specter's Final Battle (Vanilla Post Game)
    > triple_threat - Clear 3 Boss stages
    > play_spike - Capture 204 Monkeys
    > play_jimmy - Capture 300 Monkeys
    > directors_cut - Capture all 20 Monkey Films (Forces Camerasanity to "enabled" if disabled)
    > phone_check - Activate all 53 Cellphones (Forces Cellphonesanity to be set to "enabled" if disabled)
    > bonus_collector - Buy all 267 of the bonus items in the Shopping Area!
    (Forces Shoppingsanity to be set to "enabled" if disabled)
    """
    display_name : str = "Goal Target"
    default = 0

    option_specter : int = 0
    option_specter_final : int = 1
    option_triple_threat : int = 2
    option_play_spike : int = 3
    option_play_jimmy : int = 4
    option_directors_cut : int = 5
    option_phone_check : int = 6
    option_bonus_collector : int = 7
    # option_scavenger_hunt : int = 10

class GoalTargetOverride(NamedRange):
    """
    Override the amount of checks required by Goal Target by a percent amount.
    This does not affect the "specter" and "specter_final" goals.
    Default: 0 (No Override)

    Maximum possible counts for each category:
    (Use this as basis for what percentage value to enter for this option)
    Bosses (Triple Threat): 8
    Pipo Monkeys (Play Spike/Play Jimmy): 434, 354 (No Break Room Monkeys)
    Pipo Cameras (Director's Cut): 20
    Cellphones (Phone Check): 53
    Shop Items (Collector): 267
    """
    display_name : str = "Goal Target Override"
    default = 0

    range_start = 0
    range_end = 100
    special_range_names = {
        "disabled": 0
    }


class PostGameConditionMonkeys(NamedRange):
    """
    Specify the amount of monkeys required to unlock the final set of channels (Post-Game). This will be reduced
    as necessary depending on the channels placed in the post game.
    Default: vanilla

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    > disabled - This category will not count towards unlocking the Post-Game Channels
    > active - Only enabled Monkeys will count towards unlocking the Post-Game Channels
    > vanilla - Monkeysanity Break Rooms will be forced to be set as "enabled" and all monkeys will count towards
    unlocking the Post-Game Channels

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    __doc__ += "Maximum Value (No Break Room Monkeys): 360"

    display_name : str = "Post-Game Condition: Pipo Monkeys"
    default = -2

    range_start = 0
    range_end = 441
    special_range_names = {
        "disabled" : 0,
        "vanilla": -2,
        "active" : -1,
    }

class PostGameConditionBosses(Range):
    """
    Specify  the amount of bosses required to unlock the final set of channels (Post-Game). This will be reduced
    as necessary depending on the channels placed in the post game.
    Default: 0

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    display_name : str = "Post-Game Condition: Bosses"
    default = 0

    range_start = 0
    range_end = 8

class PostGameConditionCameras(Range):
    """
    Specify the amount of Pipo Cameras required to unlock the final set of channels (Post-Game).
    This will be reduced as necessary depending on the channels placed in the post game. This will also force
    Camerasanity to be set as "enabled" if it is disabled, but will respect its other options otherwise.
    Default: 0

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    display_name : str = "Post-Game Condition: Pipo Cameras"
    default = 0

    range_start = 0
    range_end = 20


class PostGameConditionCellphones(Range):
    """
    Specify the amount of Cellphones required to unlock the final set of channels (Post-Game).
    This will be reduced as necessary depending on the channels placed in the post game. This will also force
    Cellphonesanity to be set as "enabled"
    Default: 0

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    display_name: str = "Post-Game Condition: Cellphones"
    default = 0

    range_start = 0
    range_end = 53


class PostGameConditionShopItems(Range):
    """
    Specify the amount of Shop Items required to unlock the final set of channels (Post-Game).
    This will be reduced as necessary depending on the channels placed in the post game. This will also force
    Shoppingsanity to be set as "enabled" if it is disabled, but will respect other options otherwise.
    Default: 0

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    display_name: str = "Post-Game Condition: Shop Items"
    default = 0

    range_start = 0
    range_end = 267


class PostGameConditionChannelKeys(Range):
    """
    Specify the amount of additional Channel Keys required to unlock the final set of channels (Post-Game).
    Default: 0

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    <!> WARNING: Please make sure at least ONE Post-Game Condition Option is enabled (not 0/disabled).
    The multiworld WILL refuse to generate otherwise.
    """
    display_name: str = "Post-Game Condition: Channel Keys"
    default = 0

    range_start = 0
    range_end = 30

class ShuffleChannel(Choice):
    """
    Choose if Channel Order should be randomized.
    Default: disabled

    > disabled - Channel Order will not be shuffled
    > type_shuffle - Normal channels will only be shuffled with other normal levels, same for boss channels.
    This preserves the slots of the bosses, but the order of the bosses themselves will still be shuffled.
    > full_shuffle - All channels will be shuffled regardless
    """
    display_name : str = "Shuffle Channels"
    default = 0

    option_disabled : int = 0
    option_type_shuffle : int = 1
    option_full_shuffle : int = 2


class SpectersGoalTargetAsPost(DefaultOnToggle):
    """
    If either Specter or Specter Final is chosen as the goal, determine if they should be forced behind PGC,
    requiring PGC Conditions to be met before they can be accessed. This will automatically add them to the Post Channel
    option. If Post Channel exceeds its limit and this is enabled, Generation will refuse to initiate and fail.

    This option takes precedence over the Push/Post/Blacklist Channels, and will modify them as necessary.
    """
    display_name : str = "Specters Goal Target As Post"


class BlacklistBosses(Choice):
    """
    Determine if bosses should be blacklisted from the Channel selection pool. If enabled,
    bosses will be automatically added to the Blacklist Channel option. If the Blacklist Channel option
    exceeds its limit because of this option, generation will refuse to continue and fail.

    If Specters Goal Target As Post option is enabled and relevant, and this option is also set to enabled,
    generation will refuse to continue and abort.

    This option takes precedence over the Push/Post/Blacklist Channels, and will modify them as necessary.
    Default: disabled

    > disabled - Bosses will be part of the Channel Selection pool
    > enabled - Bosses will automatically be added to the Blacklist Channel option
    > keep_specters - The Freaky Monkey Five and Dr. Tomoki Bosses will be removed from the Channel Selection pool,
    but Specter and Specter Final channels will remain available.
    """
    display_name : str = "Blacklist Bosses"
    default = 0

    option_disabled : int = 0
    option_enabled : int = 1
    option_keep_specters : int = 2

class PreserveChannel(OptionSet):
    """
    If Channel Order is not disabled, choose which channel should preserve their number.

    Format: ["item_a", "item_b", "item_c", ...]

    """
    __doc__ += "Available Channels:\n# - "
    __doc__ += "\n# - ".join(f"\"{channel}\"" for channel in LEVELS_BY_ORDER)

    display_name : str = "Channel Shuffle Preserve"
    default = []

    valid_keys = [*LEVELS_BY_ORDER]

class PushChannel(OptionSet):
    """
    Specify which channels should be pushed to the End Game (Penultimate set of channels).

    By default, this will replace and swap the specified channels with the channels already present in the End Game,
    but this can be changed to add without swapping by specifying "ADDITIVE" anywhere into the list.

    Format: ["item_a", "item_b", "item_c", ..., (optional)"ADDITIVE"]
    """
    display_name : str = "Channel Shuffle Push"
    default = []

    valid_keys = [*LEVELS_BY_ORDER, APHelper.additive.value]

class PostChannel(OptionSet):
    """
    Specify which channels should be placed to the Post Game
    (Ultimate set of channels locked behind Post Game Condition).

    By default, this will replace and swap the specified channels with the channels already present in the Post Game,
    but this can be changed to add without swapping by specifying "ADDITIVE" anywhere into the list.

    Format: ["item_a", "item_b", "item_c", ..., (optional)"ADDITIVE"]
    Maximum Items: 8 (excluding "ADDITIVE")
    """
    display_name : str = "Channel Shuffle Post"
    default = []

    valid_keys = [*LEVELS_BY_ORDER, APHelper.additive.value]


class BlacklistChannel(OptionSet):
    """
    Specify which channels whose locations should be excluded from generation, and then placed at the end of the
    channel order.

    Format: ["item_a", "item_b", "item_c", ...]
    Maximum Items: 8
    """
    display_name : str = "Channel Shuffle Blacklist"
    default = []

    valid_keys = [*LEVELS_BY_ORDER]


class Monkeysanity(DefaultOnToggle):
    """
    Choose if Pipo Monkeys (and Dr. Tomoki) should count as Locations.
    Default: Enabled

    <!> WARNING <!>
    If this option is disabled, and other checks such as Camerasanity or Cellphonesanity are still also disabled,
    this option will be re-enabled.
    """
    visibility = Visibility.none
    display_name : str = "Pipo Monkeysanity"


class MonkeysanityBreakRooms(Choice):
    """
    Choose if Break Room monkeys should count as locations, and if so, if the Super Monkey morph must first be
    obtained before the game allows them to spawn.
    Default: disabled

    > disabled - Break Room monkeys will not spawn
    > enabled - Break Room monkeys will spawn, but only when the Super Monkey morph is obtained
    > early - Break Room monkeys will spawn, regardless of if the player has obtained the Super Monkey morph
    """
    display_name : str = "Pipo Monkeysanity - Break Rooms"
    default = 0

    option_disabled : int = 0
    option_enabled : int = 1
    option_early : int = 2


class MonkeysanityPasswords(Choice):
    """
    Choose if Password monkeys should count as locations, and if so, how they should be unlocked.
    Default: disabled

    > disabled - Password monkeys will not spawn
    > enabled - Password monkeys will be unlocked from the start and spawn in their rooms.
    > hunt - Password monkeys will be unlocked when certain conditions are met, and only then will they spawn.
    """
    visibility = Visibility.none
    display_name: str = "Pipo Monkeysanity - Passwords"
    default = 0

    option_disabled: int = 0
    option_enabled: int = 1
    option_hunt: int = 2


class Camerasanity(Choice):
    """
    Choose if Pipo Cameras should count as Locations.
    Default: Disabled

    > disabled - Pipo Cameras will not count as locations
    > enabled - Pipo Cameras will count as locations, and is counted when a Monkey Film is recorded.
    This means that the Pipo Monkey actors MUST BE PRESENT to acquire the item, or it will be missable until
    Free Play mode is unlocked for the channel upon clearing it.
    > no_actors - Pipo Cameras will count as locations, regardless if the Pipo Monkey Actors are present
    """
    display_name = "Pipo Camerasanity"
    default = 0

    option_disabled : int = 0
    option_enabled : int = 1
    option_no_actors : int = 2


class Cellphonesanity(Toggle):
    """
    Choose if Cellphones should count as locations
    default: Disabled
    """
    display_name = "Cellphonesanity"

class Shoppingsanity(Choice):
    """
    Choose if items from the Book Shop, Hobby Shop, and Music Shop, and the Morph Stocks from Monkey Mart
    should count as locations.
    Default: Disabled

    > disabled - Shop Items will not count as locations
    > enabled - Shop Items will count as locations
    > collection - Shop Items will count as locations where they are counted by the amount of its category obtained
    instead of being uniquely identified
    > progressive - Shop Items will become available as you unlock more channels
    > restock - Shop Items will become available as you find more Shop Stocks
    """
    display_name = "Shoppingsanity"
    default = 0

    option_disabled : int = 0
    option_enabled : int = 1
    option_collection : int = 2
    option_progressive : int = 3
    option_restock : int = 4

class RestockProgression(Range):
    """
    If the chosen Shoppingsanity option is "Restock", this option determines the amount of Shop Stocks
    that will be available. The amount of Shop Items that becomes available from collecting one Shop Stock
    increases the less Shop Stocks exists.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name: str = "Restock Progression"
    default = 28

    range_start = 4
    range_end = 28

class CheapItemsMinimumRequirement(NamedRange):
    """
    If the chosen Shoppingsanity option is "Collection", "Progressive", or "Restock", this option will define
    the minimum Channel progression required before any cheap items become in-logic, assuming no farmable area
    becomes accessible beforehand.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    Special Values:
    > disabled (0) - Cheap Items will only become in-logic if a farmable area becomes accessible
    > post-game (100) - Cheap Items will become in-logic at the latest when meeting the Post-Game Condition.
    Regardless of this option, all Shopping Items will become in-logic if a farmable area becomes accessible.
    """
    display_name: str = "Cheap Shop Items Minimum Requirement"
    default = 0

    range_start = 0
    range_end = 100
    special_range_names = {
        "disabled": 0,
        "post-game": 100
    }

class CheapItemsEarlyAmount(Range):
    """
    If the chosen Shoppingsanity option is "Collection", "Progressive", or "Restock", this option will define
    a minimum amount of Cheap Shop Items per Shop Item Category that will become in-logic from the very beginning.

    If the option "Cheap Items Minimum Requirement" option is not disabled, this option is completely ignored.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name: str = "Cheap Shop Items Early Amount"
    default = 3

    range_start = 0
    range_end = 20

class FarmLogicSneakyBorgs(Toggle):
    """
    Determines if access to areas with Sneaky-borgs should count as access to reasonably farmable gotcha coins.
    """
    display_name = "Farm Logic Sneaky Borgs"


class StartingGadget(Choice):
    """
    Choose a Gadget to start the game with along with the Monkey Net. Choose None if you want to start with
    only the Monkey Net.
    Default: Stun Club (Vanilla)
    """
    display_name : str = "Starting Gadget"
    default = 1

    option_none : int = 0
    option_stun_club : int = 1
    option_monkey_radar : int = 2
    option_super_hoop : int = 3
    option_slingback_shooter : int = 4
    option_water_net : int = 5
    option_rc_car : int = 6
    option_sky_flyer : int = 7


class StartingMorph(Choice):
    """
    Choose a Morph to Start the game with.
    Default: None (Vanilla)
    """

    display_name : str = "Starting Morph"
    default = 0

    option_none : int = 0
    option_fantasy_knight : int = 1
    option_wild_west_kid : int = 2
    option_miracle_ninja : int = 3
    option_genie_dancer : int = 4
    option_dragon_kung_fu_fighter : int = 5
    option_cyber_ace : int = 6
    option_super_monkey : int = 7


class BaseMorphDuration(Choice):
    """
    Choose the base duration of morphs. This does not affect recharge durations.
    Default: 30s (Vanilla)
    """
    display_name : str = "Base Morph Duration"
    default = 30

    option_10s : int = 10
    option_15s : int = 15
    option_30s : int = 30
    option_40s : int = 40
    option_60s : int = 60


class ShuffleMonkeyNet(Toggle):
    """
    Choose if the Monkey Net should also be shuffled. This will skip the tutorial level immediately.
    Default: Disabled
    """
    visibility = Visibility.none
    display_name : str = "Shuffle Monkey Net"


class ShuffleRCCarChassis(Toggle):
    """
    Choose if the various RC Car Chassis should also be included in the pool. Unlocking any chassis will
    automatically unlock the RC Car Gadget if it hasn't yet. This does not automatically equip the chassis.
    Default: Disabled
    """
    display_name : str = "Shuffle RC Car Chassis"


class ShuffleMorphStocks(Toggle):
    """
    Choose if Morph Stocks should also be included in the pool. This does not affect the Monkey Mart.
    Default: Disabled
    """
    display_name : str = "Shuffle Morph Stocks"


class AddMorphExtensions(Toggle):
    """
    Choose if Morph Extensions should also be included in the pool. Each Morph Extension adds 2 seconds to your morph
    duration, up to a maximum of an additional 20 seconds added to your base morph duration.
    Default: Disabled
    """
    display_name : str = "Add Morph Extensions"

class ExtraKeys(Range):
    """
    Determine if extra Channel Keys should be generated in addition to the minimum required to unlock all the channels.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name : str = "Extra Channel Keys"
    default = 0

    range_start = 0
    range_end = 15

class ExtraShopStocks(Range):
    """
    If the chosen Shoppingsanity option is "Restock", this option determines if extra Shop Stocks should be generated
    in addition to the minimum required to unlock all the Shop Items. This option will not have any effect otherwise.

    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name : str = "Extra Shop Stocks"
    default = 0

    range_start = 0
    range_end = 10

class EarlyFreePlay(DefaultOnToggle):
    """
    Allows Free Play mode to be available without needing to fully clear a channel. Useful when wanting Camerasanity
    enabled without needing to worry about Pipo Monkey actors.
    default: Enabled.
    """
    display_name : str = "Early Free Play"


class EnableMonkeyMart(DefaultOnToggle):
    """
    Choose if Monkey Mart should be able to sell cookies, energy and pellets. Morph Stock and Lucky Ticket will
    remain available

    Default: Enabled
    """
    display_name : str = "Enable Monkey Mart"

class HintsFromHintBooks(Toggle):
    """
    Choose if the Hint Book shop items will provide hints instead of items. Shoppingsanity must be at least enabled.

    Default: Disabled
    """
    display_name : str = "Hints from Hint Books"

class LuckyTicketConsolationEffects(Toggle):
    """
    Choose if Lucky Ticket Consolation Effects should be enabled. When you get a consolation prize, get a chance to
    activate a special effect that can affect the Archipelago experience.
    """
    display_name : str = "Lucky Ticket Consolation Effects"

class ConsolationEffectsWhitelist(OptionList):
    """
    When `Lucky Ticket Consolation` is enabled, this option allows you to disable certain effects from being chosen.

    Highly destructive effects have override values in host.yaml that will lead to options here being ignored.
    If you wish to enable these effects, please refer to the settings in your host.yaml, or contact your game host
    in charge of generating the game.
    """
    display_name : str = "Lucky Ticket Consolation Effects Blacklist"
    default = [APHelper.hint_filler.value,
               APHelper.hint_progressive.value,
               APHelper.check_filler.value,
               APHelper.check_progressive.value,
               APHelper.check_pgc.value,
               APHelper.check_gt.value,]

class AutoSaveStateSlot(NamedRange):
    """
    Choose which slot this slot session should be saved on. Useful when playing multiple instances of this game within
    the same multiworld. Slots 1 - 10 are used by the PCSX2 for quick use and will not be used for this purpose.

    Please refer to your host.yaml file for more AutoSave/AutoLoad State settings.

    <!> WARNING: It is highly recommended to not weight this option and explicitly specify a custom value.
    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight

    Default: 0
    """
    display_name : str = "Auto Save State Slot"
    default = 0

    range_start = 11
    range_end = 255
    special_range_names = {
        "default": 0
    }


class EmulatorPreferredSlot(Range):
    """
    Specify the preferred slot to use when connecting the Archipelago Client with PCSX2
    upon connection to an Archipelago Room. This should be the same slot that is specified in PCSX2
    under Settings > Advanced > PINE Settings > Slot. More details about connecting the client to PCSX2
    can be found in this apworld's setup guide.
    Connection details can be changed anytime during play by using the client command `/pine_slot <port>`.

    <!> WARNING: It is highly recommended to not weight this option and explicitly specify a custom value.
    To specify custom values, add it alongside the pre-existing options, copying their format.
    Format: value : weight
    """
    display_name : str = "Emulator Preferred Port"
    default = 28011

    range_start = 0
    range_end = 65535


class EmulatorLinuxPreferredPlatform(Choice):
    """
    *For Linux Players only
    Specify which PCSX2 installation to prioritize searching and connecting to upon connection to an Archipelago Room.
    Connection details can be changed anytime during play by using the client command `/pine_platform <option>`.

    <!> WARNING: It is highly recommended to not weight this option.

    > auto - Automatically search for any running PCSX2 installation and connect to the first one detected.
    > standard - Prioritize connecting to a normal installation of PCSX2, either from a traditional package manager,
    the official appimage, or others. Even if multiple sources of this type are present,
    they are all detected as a singular instance, and cannot be individually connected to.
    > flatpak - Prioritize connecting to the Flatpak installation of PCSX2.
    """
    display_name : str = "Emulator Linux Preferred Platform"
    default = 0

    option_auto = 0
    option_standard = 1
    option_flatpak = 2


ae3_option_groups : dict[str, list] = {
    "Randomizer Options"        : [ProgressionMode,
                                   OpenProgressionKeys,
                                   RandomizeProgressionSetCount,
                                   RandomizeProgressionChannelRange,
                                   LogicPreference,
                                   HipDropStorageLogic,
                                   ProlongedQuadJumpLogic,
                                   GoalTarget,
                                   GoalTargetOverride,
                                   PostGameConditionMonkeys,
                                   PostGameConditionBosses,
                                   PostGameConditionCameras,
                                   PostGameConditionCellphones,
                                   PostGameConditionShopItems,
                                   PostGameConditionChannelKeys],
    "Map Options"               : [ShuffleChannel,
                                   SpectersGoalTargetAsPost,
                                   BlacklistBosses,
                                   PreserveChannel,
                                   PushChannel,
                                   PostChannel,
                                   BlacklistChannel],
    "Location Options"          : [Monkeysanity,
                                   MonkeysanityBreakRooms,
                                   MonkeysanityPasswords,
                                   Camerasanity,
                                   Cellphonesanity,
                                   Shoppingsanity,
                                   RestockProgression,
                                   CheapItemsMinimumRequirement,
                                   CheapItemsEarlyAmount,
                                   FarmLogicSneakyBorgs],
    "Item Options"              : [StartingGadget,
                                   StartingMorph,
                                   BaseMorphDuration,
                                   ShuffleMonkeyNet,
                                   ShuffleRCCarChassis,
                                   ShuffleMorphStocks,
                                   AddMorphExtensions,
                                   ExtraKeys,
                                   ExtraShopStocks],
    "Preferences"               : [EarlyFreePlay,
                                   EnableMonkeyMart,
                                   HintsFromHintBooks,
                                   LuckyTicketConsolationEffects,
                                   ConsolationEffectsWhitelist],
    "Sync Options"              : [DeathLink],
    "Session Options"           : [AutoSaveStateSlot,
                                   EmulatorPreferredSlot,
                                   EmulatorLinuxPreferredPlatform, ]
}

@dataclass
class AE3Options(PerGameCommonOptions):
    progression_mode                        : ProgressionMode
    open_progression_keys                   : OpenProgressionKeys
    randomize_progression_set_count         : RandomizeProgressionSetCount
    randomize_progression_channel_range     : RandomizeProgressionChannelRange
    logic_preference                        : LogicPreference
    hip_drop_storage_logic                  : HipDropStorageLogic
    prolonged_quad_jump_logic               : ProlongedQuadJumpLogic
    goal_target                             : GoalTarget
    goal_target_override                    : GoalTargetOverride
    post_game_condition_monkeys             : PostGameConditionMonkeys
    post_game_condition_bosses              : PostGameConditionBosses
    post_game_condition_cameras             : PostGameConditionCameras
    post_game_condition_cellphones          : PostGameConditionCellphones
    post_game_condition_shop                : PostGameConditionShopItems
    post_game_condition_keys                : PostGameConditionChannelKeys
    shuffle_channel                         : ShuffleChannel
    specters_goal_target_as_post            : SpectersGoalTargetAsPost
    blacklist_bosses                        : BlacklistBosses
    preserve_channel                        : PreserveChannel
    push_channel                            : PushChannel
    post_channel                            : PostChannel
    blacklist_channel                       : BlacklistChannel
    monkeysanity                            : Monkeysanity
    monkeysanity_break_rooms                : MonkeysanityBreakRooms
    monkeysanity_passwords                  : MonkeysanityPasswords
    camerasanity                            : Camerasanity
    cellphonesanity                         : Cellphonesanity
    shoppingsanity                          : Shoppingsanity
    restock_progression                     : RestockProgression
    cheap_items_minimum_requirement         : CheapItemsMinimumRequirement
    cheap_items_early_amount                : CheapItemsEarlyAmount
    farm_logic_sneaky_borgs                 : FarmLogicSneakyBorgs

    starting_gadget                         : StartingGadget
    starting_morph                          : StartingMorph
    base_morph_duration                     : BaseMorphDuration

    shuffle_net                             : ShuffleMonkeyNet
    shuffle_chassis                         : ShuffleRCCarChassis
    shuffle_morph_stocks                    : ShuffleMorphStocks
    add_morph_extensions                    : AddMorphExtensions
    extra_keys                              : ExtraKeys
    extra_shop_stocks                       : ExtraShopStocks

    early_free_play                         : EarlyFreePlay
    enable_monkey_mart                      : EnableMonkeyMart
    hints_from_hintbooks                    : HintsFromHintBooks
    lucky_ticket_consolation_effects        : LuckyTicketConsolationEffects
    consolation_effects_whitelist           : ConsolationEffectsWhitelist

    death_link                              : DeathLink

    auto_save_state_slot                    : AutoSaveStateSlot
    emulator_preferred_slot                 : EmulatorPreferredSlot
    emulator_linux_preferred_platform       : EmulatorLinuxPreferredPlatform

def create_option_groups() -> list[OptionGroup]:
    groups : list[OptionGroup] = []
    for group, options in ae3_option_groups.items():
        groups.append(OptionGroup(group, options))

    return groups

def slot_data_options() -> list[str]:
    return [
        APHelper.progression_mode.value,
        APHelper.open_required.value,
        APHelper.randomize_set_count.value,
        APHelper.randomize_channel_range.value,
        APHelper.logic_preference.value,
        APHelper.hds_logic.value,
        APHelper.pqj_logic.value,
        APHelper.goal_target.value,
        APHelper.goal_target_ovr.value,
        APHelper.pgc_monkeys.value,
        APHelper.pgc_bosses.value,
        APHelper.pgc_cameras.value,
        APHelper.pgc_cellphones.value,
        APHelper.pgc_shop.value,
        APHelper.pgc_keys.value,

        APHelper.shuffle_channel.value,
        APHelper.specters_goal_target_as_post.value,
        APHelper.blacklist_bosses.value,
        APHelper.preserve_channel.value,
        APHelper.push_channel.value,
        APHelper.post_channel.value,
        APHelper.blacklist_channel.value,

        APHelper.monkeysanity.value,
        APHelper.monkeysanitybr.value,
        APHelper.monkeysanitypw.value,
        APHelper.camerasanity.value,
        APHelper.cellphonesanity.value,
        APHelper.shoppingsanity.value,
        APHelper.restock_progression.value,
        APHelper.cheap_items_min.value,
        APHelper.cheap_items_early_amount.value,
        APHelper.farm_logic_sneaky_borgs.value,

        APHelper.starting_gadget.value,
        APHelper.starting_morph.value,
        APHelper.base_morph_duration.value,

        APHelper.shuffle_net.value,
        APHelper.shuffle_chassis.value,
        APHelper.shuffle_morph_stocks.value,
        APHelper.add_morph_extensions.value,
        APHelper.extra_keys.value,
        APHelper.extra_shop_stocks.value,

        APHelper.early_free_play.value,
        APHelper.enable_monkey_mart.value,
        APHelper.hint_book_hints.value,
        APHelper.ticket_consolation.value,
        APHelper.consolation_whitelist.value,

        APHelper.death_link.value,

        APHelper.auto_save_slot.value,
        APHelper.emulator_slot.value,
        APHelper.emu_linux_platform.value,
    ]