diff options
Diffstat (limited to 'apworld/options.py')
| -rw-r--r-- | apworld/options.py | 99 |
1 files changed, 98 insertions, 1 deletions
| diff --git a/apworld/options.py b/apworld/options.py index 240f8af..f687434 100644 --- a/apworld/options.py +++ b/apworld/options.py | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | from dataclasses import dataclass | 1 | from dataclasses import dataclass |
| 2 | 2 | ||
| 3 | from Options import PerGameCommonOptions, Toggle, Choice, DefaultOnToggle | 3 | from Options import PerGameCommonOptions, Toggle, Choice, DefaultOnToggle, Range, OptionSet |
| 4 | 4 | ||
| 5 | 5 | ||
| 6 | class ShuffleDoors(DefaultOnToggle): | 6 | class ShuffleDoors(DefaultOnToggle): |
| @@ -16,6 +16,11 @@ class ShuffleControlCenterColors(Toggle): | |||
| 16 | display_name = "Shuffle Control Center Colors" | 16 | display_name = "Shuffle Control Center Colors" |
| 17 | 17 | ||
| 18 | 18 | ||
| 19 | class ShuffleGalleryPaintings(Toggle): | ||
| 20 | """If enabled, gallery paintings will appear from receiving an item rather than by triggering them normally.""" | ||
| 21 | display_name = "Shuffle Gallery Paintings" | ||
| 22 | |||
| 23 | |||
| 19 | class ShuffleLetters(Choice): | 24 | class ShuffleLetters(Choice): |
| 20 | """ | 25 | """ |
| 21 | Controls how letter unlocks are handled. Note that H1, I1, N1, and T1 will always be present at their vanilla | 26 | Controls how letter unlocks are handled. Note that H1, I1, N1, and T1 will always be present at their vanilla |
| @@ -47,6 +52,15 @@ class ShuffleSymbols(Toggle): | |||
| 47 | display_name = "Shuffle Symbols" | 52 | display_name = "Shuffle Symbols" |
| 48 | 53 | ||
| 49 | 54 | ||
| 55 | class ShuffleWorldports(Toggle): | ||
| 56 | """ | ||
| 57 | Randomizes the connections between maps. This affects worldports only, which are the loading zones you walk into in | ||
| 58 | order to change maps. This does not affect paintings, panels that teleport you, or certain other special connections | ||
| 59 | like the one between The Shop and Control Center. | ||
| 60 | """ | ||
| 61 | display_name = "Shuffle Worldports" | ||
| 62 | |||
| 63 | |||
| 50 | class KeyholderSanity(Toggle): | 64 | class KeyholderSanity(Toggle): |
| 51 | """ | 65 | """ |
| 52 | If enabled, 26 locations will be created for placing each key into its respective Green Ending keyholder. | 66 | If enabled, 26 locations will be created for placing each key into its respective Green Ending keyholder. |
| @@ -77,6 +91,36 @@ class CyanDoorBehavior(Choice): | |||
| 77 | option_item = 2 | 91 | option_item = 2 |
| 78 | 92 | ||
| 79 | 93 | ||
| 94 | class EnableIcarus(Toggle): | ||
| 95 | """ | ||
| 96 | Controls whether Icarus is randomized. If disabled, which is the default, no locations or items will be created for | ||
| 97 | it, and its worldport will not be shuffled when worldport shuffle is on. | ||
| 98 | """ | ||
| 99 | display_name = "Enable Icarus" | ||
| 100 | |||
| 101 | |||
| 102 | class EnableGiftMaps(OptionSet): | ||
| 103 | """ | ||
| 104 | Controls whether the beta tester gift maps are randomized. By default, these are not accessible at all from within | ||
| 105 | the randomizer. This option allows you to enter the maps, and creates items and locations for them. If worldport | ||
| 106 | shuffle is on, their worldports will be included in the randomization. | ||
| 107 | |||
| 108 | The gift maps are accessed via a panel in The Entry's Starting Room, which only appears if at least one gift map is | ||
| 109 | enabled. It is also treated like a cyan door, and will not appear until the condition specified in the Cyan Door | ||
| 110 | Behavior option is satisfied. Solving this panel with the name of one of the beta testers will teleport you to their | ||
| 111 | corresponding gift map. | ||
| 112 | |||
| 113 | In the base game, nothing happens once you complete a gift map. Masteries have been added to the gift maps in the | ||
| 114 | randomizer so that the player can be rewarded for completing them. | ||
| 115 | |||
| 116 | Note that the gift maps were originally only intended to be played by specific people, and as a result may be | ||
| 117 | frustrating or require knowledge of inside jokes. The Crystalline is particularly difficult as it requires | ||
| 118 | completing a parkour course. | ||
| 119 | """ | ||
| 120 | display_name = "Enable Gift Maps" | ||
| 121 | valid_keys = ["The Advanced", "The Charismatic", "The Crystalline", "The Fuzzy", "The Stellar"] | ||
| 122 | |||
| 123 | |||
| 80 | class DaedalusRoofAccess(Toggle): | 124 | class DaedalusRoofAccess(Toggle): |
| 81 | """ | 125 | """ |
| 82 | If enabled, the player will be logically expected to be able to go from the castle entrance to any part of Daedalus | 126 | If enabled, the player will be logically expected to be able to go from the castle entrance to any part of Daedalus |
| @@ -87,6 +131,22 @@ class DaedalusRoofAccess(Toggle): | |||
| 87 | display_name = "Allow Daedalus Roof Access" | 131 | display_name = "Allow Daedalus Roof Access" |
| 88 | 132 | ||
| 89 | 133 | ||
| 134 | class StrictPurpleEnding(DefaultOnToggle): | ||
| 135 | """ | ||
| 136 | If enabled, the player will be required to have all purple (level 1) letters in order to get Purple Ending. | ||
| 137 | Otherwise, some of the letters may be skippable depending on the other options. | ||
| 138 | """ | ||
| 139 | display_name = "Strict Purple Ending" | ||
| 140 | |||
| 141 | |||
| 142 | class StrictCyanEnding(DefaultOnToggle): | ||
| 143 | """ | ||
| 144 | If enabled, the player will be required to have all cyan (level 2) letters in order to get Cyan Ending. Otherwise, | ||
| 145 | at least J2, Q2, and V2 are skippable. Others may also be skippable depending on the options chosen. | ||
| 146 | """ | ||
| 147 | display_name = "Strict Cyan Ending" | ||
| 148 | |||
| 149 | |||
| 90 | class VictoryCondition(Choice): | 150 | class VictoryCondition(Choice): |
| 91 | """ | 151 | """ |
| 92 | This option determines what your goal is. | 152 | This option determines what your goal is. |
| @@ -121,13 +181,50 @@ class VictoryCondition(Choice): | |||
| 121 | option_white_ending = 12 | 181 | option_white_ending = 12 |
| 122 | 182 | ||
| 123 | 183 | ||
| 184 | class EndingsRequirement(Range): | ||
| 185 | """The number of endings required to unlock White Ending.""" | ||
| 186 | display_name = "Endings Requirement" | ||
| 187 | range_start = 0 | ||
| 188 | range_end = 12 | ||
| 189 | default = 12 | ||
| 190 | |||
| 191 | |||
| 192 | class MasteriesRequirement(Range): | ||
| 193 | """The number of masteries required to unlock White Ending. | ||
| 194 | |||
| 195 | There are only 13 masteries in the base game, but some of the other slot options may add more masteries to the | ||
| 196 | world. If the chosen number of masteries is higher than the total in your world, it will be automatically lowered to | ||
| 197 | the maximum.""" | ||
| 198 | display_name = "Masteries Requirement" | ||
| 199 | range_start = 0 | ||
| 200 | range_end = 19 | ||
| 201 | default = 0 | ||
| 202 | |||
| 203 | |||
| 204 | class TrapPercentage(Range): | ||
| 205 | """Replaces junk items with traps, at the specified rate.""" | ||
| 206 | display_name = "Trap Percentage" | ||
| 207 | range_start = 0 | ||
| 208 | range_end = 100 | ||
| 209 | default = 0 | ||
| 210 | |||
| 211 | |||
| 124 | @dataclass | 212 | @dataclass |
| 125 | class Lingo2Options(PerGameCommonOptions): | 213 | class Lingo2Options(PerGameCommonOptions): |
| 126 | shuffle_doors: ShuffleDoors | 214 | shuffle_doors: ShuffleDoors |
| 127 | shuffle_control_center_colors: ShuffleControlCenterColors | 215 | shuffle_control_center_colors: ShuffleControlCenterColors |
| 216 | shuffle_gallery_paintings: ShuffleGalleryPaintings | ||
| 128 | shuffle_letters: ShuffleLetters | 217 | shuffle_letters: ShuffleLetters |
| 129 | shuffle_symbols: ShuffleSymbols | 218 | shuffle_symbols: ShuffleSymbols |
| 219 | shuffle_worldports: ShuffleWorldports | ||
| 130 | keyholder_sanity: KeyholderSanity | 220 | keyholder_sanity: KeyholderSanity |
| 131 | cyan_door_behavior: CyanDoorBehavior | 221 | cyan_door_behavior: CyanDoorBehavior |
| 222 | enable_icarus: EnableIcarus | ||
| 223 | enable_gift_maps: EnableGiftMaps | ||
| 132 | daedalus_roof_access: DaedalusRoofAccess | 224 | daedalus_roof_access: DaedalusRoofAccess |
| 225 | strict_purple_ending: StrictPurpleEnding | ||
| 226 | strict_cyan_ending: StrictCyanEnding | ||
| 133 | victory_condition: VictoryCondition | 227 | victory_condition: VictoryCondition |
| 228 | endings_requirement: EndingsRequirement | ||
| 229 | masteries_requirement: MasteriesRequirement | ||
| 230 | trap_percentage: TrapPercentage | ||
