334 lines
12 KiB
Python
334 lines
12 KiB
Python
from dataclasses import dataclass
|
|
|
|
from schema import Schema, And, Optional
|
|
|
|
from Options import Toggle, DefaultOnToggle, Range, Choice, PerGameCommonOptions, OptionDict
|
|
|
|
from .static_logic import WeightedItemDefinition, ItemCategory, StaticWitnessLogic
|
|
|
|
|
|
class DisableNonRandomizedPuzzles(Toggle):
|
|
"""
|
|
Disables puzzles that cannot be randomized.
|
|
This includes many puzzles that heavily involve the environment, such as Shadows, Monastery or Orchard.
|
|
|
|
The lasers for those areas will activate as you solve optional puzzles, such as Discarded Panels.
|
|
Additionally, the panel activating the Jungle Popup Wall will be on from the start.
|
|
"""
|
|
display_name = "Disable non randomized puzzles"
|
|
|
|
|
|
class EarlyCaves(Choice):
|
|
"""
|
|
Adds an item that opens the Caves Shortcuts to Swamp and Mountain, allowing early access to the Caves even if you are not playing a remote Door Shuffle mode.
|
|
You can either add this item to the pool to be found in the multiworld, or you can outright start with it and have immediate access to the Caves.
|
|
|
|
If you choose "Add To Pool" and you are already playing a remote Door Shuffle mode, this option will do nothing.
|
|
"""
|
|
display_name = "Early Caves"
|
|
option_off = 0
|
|
alias_false = 0
|
|
option_add_to_pool = 1
|
|
option_starting_inventory = 2
|
|
alias_true = 2
|
|
alias_on = 2
|
|
|
|
|
|
class ShuffleSymbols(DefaultOnToggle):
|
|
"""
|
|
If on, you will need to unlock puzzle symbols as items to be able to solve the panels that contain those symbols.
|
|
|
|
Please note that there is no minimum set of progression items in this randomizer.
|
|
If you turn this option off and don't turn on door shuffle or obelisk keys, there will be no progression items, which will disallow you from adding your yaml to a multiworld generation.
|
|
"""
|
|
display_name = "Shuffle Symbols"
|
|
|
|
|
|
class ShuffleLasers(Choice):
|
|
"""
|
|
If on, the 11 lasers are turned into items and will activate on their own upon receiving them.
|
|
"""
|
|
display_name = "Shuffle Lasers"
|
|
option_off = 0
|
|
alias_false = 0
|
|
option_local = 1
|
|
option_anywhere = 2
|
|
alias_true = 2
|
|
alias_on = 2
|
|
|
|
|
|
class ShuffleDoors(Choice):
|
|
"""
|
|
If on, opening doors, moving bridges etc. will require a "key".
|
|
If set to "panels", the panel on the door will be locked until receiving its corresponding key.
|
|
If set to "doors", the door will open immediately upon receiving its key. Door panels are added as location checks.
|
|
"Mixed" includes all doors from "doors", and all control panels (bridges, elevators etc.) from "panels".
|
|
"""
|
|
display_name = "Shuffle Doors"
|
|
option_off = 0
|
|
option_panels = 1
|
|
option_doors = 2
|
|
option_mixed = 3
|
|
|
|
|
|
class DoorGroupings(Choice):
|
|
"""
|
|
If set to "none", there will be one key for each door, potentially resulting in upwards of 120 keys being added to the item pool.
|
|
If set to "regional", all doors in the same general region will open at once with a single key, reducing the amount of door items and complexity.
|
|
"""
|
|
display_name = "Door Groupings"
|
|
option_off = 0
|
|
option_regional = 1
|
|
|
|
|
|
class ShuffleBoat(DefaultOnToggle):
|
|
"""
|
|
If on, adds a "Boat" item to the item pool. Before receiving this item, you will not be able to use the boat.
|
|
"""
|
|
display_name = "Shuffle Boat"
|
|
|
|
|
|
class ShuffleDiscardedPanels(Toggle):
|
|
"""
|
|
Adds Discarded Panels into the location pool.
|
|
|
|
Even if this is off, solving certain Discarded Panels may still be necessary to beat the game - The main example of this being the alternate activation triggers in "Disable non randomized puzzles".
|
|
"""
|
|
display_name = "Shuffle Discarded Panels"
|
|
|
|
|
|
class ShuffleVaultBoxes(Toggle):
|
|
"""
|
|
Adds Vault Boxes to the location pool.
|
|
"""
|
|
display_name = "Shuffle Vault Boxes"
|
|
|
|
|
|
class ShuffleEnvironmentalPuzzles(Choice):
|
|
"""
|
|
Adds Environmental/Obelisk Puzzles into the location pool.
|
|
If set to "individual", every Environmental Puzzle sends an item.
|
|
If set to "Obelisk Sides", completing every puzzle on one side of an Obelisk sends an item.
|
|
|
|
Note: In Obelisk Sides, any EPs excluded through another option will be pre-completed on their Obelisk.
|
|
"""
|
|
display_name = "Shuffle Environmental Puzzles"
|
|
option_off = 0
|
|
option_individual = 1
|
|
option_obelisk_sides = 2
|
|
|
|
|
|
class ShuffleDog(Toggle):
|
|
"""
|
|
Adds petting the Town dog into the location pool.
|
|
"""
|
|
display_name = "Pet the Dog"
|
|
|
|
|
|
class EnvironmentalPuzzlesDifficulty(Choice):
|
|
"""
|
|
When "Shuffle Environmental Puzzles" is on, this setting governs which EPs are eligible for the location pool.
|
|
If set to "eclipse", every EP in the game is eligible, including the 1-hour-long "Theater Eclipse EP".
|
|
If set to "tedious", Theater Eclipse EP is excluded from the location pool.
|
|
If set to "normal", several other difficult or long EPs are excluded as well.
|
|
"""
|
|
display_name = "Environmental Puzzles Difficulty"
|
|
option_normal = 0
|
|
option_tedious = 1
|
|
option_eclipse = 2
|
|
|
|
|
|
class ObeliskKeys(DefaultOnToggle):
|
|
"""
|
|
Add one Obelisk Key item per Obelisk, locking you out of solving any of the associated Environmental Puzzles.
|
|
|
|
Does nothing if "Shuffle Environmental Puzzles" is set to "off".
|
|
"""
|
|
display_name = "Obelisk Keys"
|
|
|
|
|
|
class ShufflePostgame(Toggle):
|
|
"""
|
|
Adds locations into the pool that are guaranteed to become accessible after or at the same time as your goal.
|
|
Use this if you don't play with release on victory.
|
|
"""
|
|
display_name = "Shuffle Postgame"
|
|
|
|
|
|
class VictoryCondition(Choice):
|
|
"""
|
|
Set the victory condition for this world.
|
|
Elevator: Start the elevator at the bottom of the mountain (requires Mountain Lasers).
|
|
Challenge: Beat the secret Challenge (requires Challenge Lasers).
|
|
Mountain Box Short: Input the short solution to the Mountaintop Box (requires Mountain Lasers).
|
|
Mountain Box Long: Input the long solution to the Mountaintop Box (requires Challenge Lasers).
|
|
|
|
It is important to note that while the Mountain Box requires Desert Laser to be redirected in Town for that laser
|
|
to count, the laser locks on the Elevator and Challenge Timer panels do not.
|
|
"""
|
|
display_name = "Victory Condition"
|
|
option_elevator = 0
|
|
option_challenge = 1
|
|
option_mountain_box_short = 2
|
|
option_mountain_box_long = 3
|
|
|
|
|
|
class PuzzleRandomization(Choice):
|
|
"""
|
|
Puzzles in this randomizer are randomly generated. This option changes the difficulty/types of puzzles.
|
|
"""
|
|
display_name = "Puzzle Randomization"
|
|
option_sigma_normal = 0
|
|
option_sigma_expert = 1
|
|
option_none = 2
|
|
|
|
|
|
class MountainLasers(Range):
|
|
"""
|
|
Sets the number of lasers required to enter the Mountain.
|
|
If set to a higher number than 7, the mountaintop box will be slightly rotated to make it possible to solve without the hatch being opened.
|
|
This change will also be applied logically to the long solution ("Challenge Lasers" option).
|
|
"""
|
|
display_name = "Required Lasers for Mountain Entry"
|
|
range_start = 1
|
|
range_end = 11
|
|
default = 7
|
|
|
|
|
|
class ChallengeLasers(Range):
|
|
"""
|
|
Sets the number of lasers required to enter the Caves through the Mountain Bottom Floor Discard and to unlock the Challenge Timer Panel.
|
|
"""
|
|
display_name = "Required Lasers for Challenge"
|
|
range_start = 1
|
|
range_end = 11
|
|
default = 11
|
|
|
|
|
|
class ElevatorsComeToYou(Toggle):
|
|
"""
|
|
If on, the Quarry Elevator, Bunker Elevator and Swamp Long Bridge will "come to you" if you approach them.
|
|
This does actually affect logic as it allows unintended backwards / early access into these areas.
|
|
"""
|
|
display_name = "All Bridges & Elevators come to you"
|
|
|
|
|
|
class TrapPercentage(Range):
|
|
"""
|
|
Replaces junk items with traps, at the specified rate.
|
|
"""
|
|
display_name = "Trap Percentage"
|
|
range_start = 0
|
|
range_end = 100
|
|
default = 20
|
|
|
|
|
|
class TrapWeights(OptionDict):
|
|
"""
|
|
Specify the weights determining how many copies of each trap item will be in your itempool.
|
|
If you don't want a specific type of trap, you can set the weight for it to 0 (Do not delete the entry outright!).
|
|
If you set all trap weights to 0, you will get no traps, bypassing the "Trap Percentage" option.
|
|
"""
|
|
display_name = "Trap Weights"
|
|
schema = Schema({
|
|
trap_name: And(int, lambda n: n >= 0)
|
|
for trap_name, item_definition in StaticWitnessLogic.all_items.items()
|
|
if isinstance(item_definition, WeightedItemDefinition) and item_definition.category is ItemCategory.TRAP
|
|
})
|
|
default = {
|
|
trap_name: item_definition.weight
|
|
for trap_name, item_definition in StaticWitnessLogic.all_items.items()
|
|
if isinstance(item_definition, WeightedItemDefinition) and item_definition.category is ItemCategory.TRAP
|
|
}
|
|
|
|
|
|
class PuzzleSkipAmount(Range):
|
|
"""
|
|
Adds this many Puzzle Skips into the pool, if there is room. Puzzle Skips let you skip one panel.
|
|
"""
|
|
display_name = "Puzzle Skips"
|
|
range_start = 0
|
|
range_end = 30
|
|
default = 10
|
|
|
|
|
|
class HintAmount(Range):
|
|
"""
|
|
Adds hints to Audio Logs. If set to a low amount, up to 2 additional duplicates of each hint will be added.
|
|
Remaining Audio Logs will have junk hints.
|
|
"""
|
|
display_name = "Hints on Audio Logs"
|
|
range_start = 0
|
|
range_end = 49
|
|
default = 12
|
|
|
|
|
|
class AreaHintPercentage(Range):
|
|
"""
|
|
There are two types of hints for The Witness.
|
|
"Location hints" hint one location in your world or one location containing an item for your world.
|
|
"Area hints" tell you some general info about the items you can find in one of the main geographic areas on the island.
|
|
Use this option to specify how many of your hints you want to be area hints. The rest will be location hints.
|
|
"""
|
|
display_name = "Area Hint Percentage"
|
|
range_start = 0
|
|
range_end = 100
|
|
default = 33
|
|
|
|
|
|
class LaserHints(Toggle):
|
|
"""
|
|
If on, lasers will tell you where their items are if you walk close to them in-game.
|
|
Only applies if Laser Shuffle is enabled.
|
|
"""
|
|
display_name = "Laser Hints"
|
|
|
|
|
|
class DeathLink(Toggle):
|
|
"""
|
|
If on, whenever you fail a puzzle (with some exceptions), you and everyone who is also on Death Link dies.
|
|
The effect of a "death" in The Witness is a Bonk Trap.
|
|
"""
|
|
display_name = "Death Link"
|
|
|
|
|
|
class DeathLinkAmnesty(Range):
|
|
"""
|
|
The number of panel fails to allow before sending a death through Death Link.
|
|
0 means every panel fail will send a death, 1 means every other panel fail will send a death, etc.
|
|
"""
|
|
display_name = "Death Link Amnesty"
|
|
range_start = 0
|
|
range_end = 5
|
|
default = 1
|
|
|
|
|
|
@dataclass
|
|
class TheWitnessOptions(PerGameCommonOptions):
|
|
puzzle_randomization: PuzzleRandomization
|
|
shuffle_symbols: ShuffleSymbols
|
|
shuffle_doors: ShuffleDoors
|
|
door_groupings: DoorGroupings
|
|
shuffle_boat: ShuffleBoat
|
|
shuffle_lasers: ShuffleLasers
|
|
disable_non_randomized_puzzles: DisableNonRandomizedPuzzles
|
|
shuffle_discarded_panels: ShuffleDiscardedPanels
|
|
shuffle_vault_boxes: ShuffleVaultBoxes
|
|
obelisk_keys: ObeliskKeys
|
|
shuffle_EPs: ShuffleEnvironmentalPuzzles
|
|
EP_difficulty: EnvironmentalPuzzlesDifficulty
|
|
shuffle_postgame: ShufflePostgame
|
|
victory_condition: VictoryCondition
|
|
mountain_lasers: MountainLasers
|
|
challenge_lasers: ChallengeLasers
|
|
early_caves: EarlyCaves
|
|
elevators_come_to_you: ElevatorsComeToYou
|
|
trap_percentage: TrapPercentage
|
|
trap_weights: TrapWeights
|
|
puzzle_skip_amount: PuzzleSkipAmount
|
|
hint_amount: HintAmount
|
|
area_hint_percentage: AreaHintPercentage
|
|
laser_hints: LaserHints
|
|
death_link: DeathLink
|
|
death_link_amnesty: DeathLinkAmnesty
|