about summary refs log tree commit diff stats
path: root/apworld/options.py
diff options
context:
space:
mode:
Diffstat (limited to 'apworld/options.py')
-rw-r--r--apworld/options.py77
1 files changed, 74 insertions, 3 deletions
diff --git a/apworld/options.py b/apworld/options.py index f7dc5bd..52d2034 100644 --- a/apworld/options.py +++ b/apworld/options.py
@@ -1,13 +1,26 @@
1from dataclasses import dataclass 1from dataclasses import dataclass
2 2
3from Options import PerGameCommonOptions, Toggle, Choice 3from Options import PerGameCommonOptions, Toggle, Choice, DefaultOnToggle, Range
4 4
5 5
6class ShuffleDoors(Toggle): 6class ShuffleDoors(DefaultOnToggle):
7 """If enabled, most doors will open from receiving an item rather than fulfilling the in-game requirements.""" 7 """If enabled, most doors will open from receiving an item rather than fulfilling the in-game requirements."""
8 display_name = "Shuffle Doors" 8 display_name = "Shuffle Doors"
9 9
10 10
11class ShuffleControlCenterColors(Toggle):
12 """
13 Some doors open after solving the COLOR panel in the Control Center. If this option is enabled, these doors will
14 instead open upon receiving an item.
15 """
16 display_name = "Shuffle Control Center Colors"
17
18
19class 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
11class ShuffleLetters(Choice): 24class ShuffleLetters(Choice):
12 """ 25 """
13 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
@@ -31,6 +44,14 @@ class ShuffleLetters(Choice):
31 option_item_cyan = 4 44 option_item_cyan = 4
32 45
33 46
47class ShuffleSymbols(Toggle):
48 """
49 If enabled, 19 items will be added to the pool, representing the different symbols that can appear on a panel.
50 Players will be prevented from solving puzzles with symbols on them until all of the required symbols are unlocked.
51 """
52 display_name = "Shuffle Symbols"
53
54
34class KeyholderSanity(Toggle): 55class KeyholderSanity(Toggle):
35 """ 56 """
36 If enabled, 26 locations will be created for placing each key into its respective Green Ending keyholder. 57 If enabled, 26 locations will be created for placing each key into its respective Green Ending keyholder.
@@ -40,6 +61,27 @@ class KeyholderSanity(Toggle):
40 display_name = "Keyholder Sanity" 61 display_name = "Keyholder Sanity"
41 62
42 63
64class CyanDoorBehavior(Choice):
65 """
66 Cyan-colored doors usually only open upon unlocking double letters. Some panels also only appear upon unlocking
67 double letters. This option determines how these unlocks should behave.
68
69 - **Collect H2**: In the base game, H2 is the first double letter you are intended to collect, so cyan doors only
70 open when you collect the H2 pickup in The Repetitive. Collecting the actual pickup is still required even with
71 remote letter shuffle enabled.
72 - **Any Double Letter**: Cyan doors will open when you have unlocked any cyan letter on your keyboard. In letter
73 shuffle, this means receiving a cyan letter, not picking up a cyan letter collectable.
74 - **Item**: Cyan doors will be grouped together in a single item.
75
76 Note that some cyan doors are impacted by door shuffle (e.g. the entrance to The Tower). When door shuffle is
77 enabled, these doors won't be affected by the value of this option.
78 """
79 display_name = "Cyan Door Behavior"
80 option_collect_h2 = 0
81 option_any_double_letter = 1
82 option_item = 2
83
84
43class DaedalusRoofAccess(Toggle): 85class DaedalusRoofAccess(Toggle):
44 """ 86 """
45 If enabled, the player will be logically expected to be able to go from the castle entrance to any part of Daedalus 87 If enabled, the player will be logically expected to be able to go from the castle entrance to any part of Daedalus
@@ -51,7 +93,23 @@ class DaedalusRoofAccess(Toggle):
51 93
52 94
53class VictoryCondition(Choice): 95class VictoryCondition(Choice):
54 """Victory condition.""" 96 """
97 This option determines what your goal is.
98
99 - **Gray Ending** (The Colorful)
100 - **Purple Ending** (The Sun Temple). This ordinarily requires all level 1 (purple) letters.
101 - **Mint Ending** (typing EXIT into the keyholders in Control Center)
102 - **Black Ending** (The Graveyard)
103 - **Blue Ending** (The Words)
104 - **Cyan Ending** (The Parthenon). This ordinarily requires almost all level 2 (cyan) letters.
105 - **Red Ending** (The Tower)
106 - **Plum Ending** (The Wondrous / The Door)
107 - **Orange Ending** (the castle in Daedalus)
108 - **Gold Ending** (The Gold). This involves going through the color rooms in Daedalus.
109 - **Yellow Ending** (The Gallery). This requires unlocking all gallery paintings.
110 - **Green Ending** (The Ancient). This requires filling all keyholders with specific letters.
111 - **White Ending** (Control Center). This combines every other ending.
112 """
55 display_name = "Victory Condition" 113 display_name = "Victory Condition"
56 option_gray_ending = 0 114 option_gray_ending = 0
57 option_purple_ending = 1 115 option_purple_ending = 1
@@ -68,10 +126,23 @@ class VictoryCondition(Choice):
68 option_white_ending = 12 126 option_white_ending = 12
69 127
70 128
129class TrapPercentage(Range):
130 """Replaces junk items with traps, at the specified rate."""
131 display_name = "Trap Percentage"
132 range_start = 0
133 range_end = 100
134 default = 0
135
136
71@dataclass 137@dataclass
72class Lingo2Options(PerGameCommonOptions): 138class Lingo2Options(PerGameCommonOptions):
73 shuffle_doors: ShuffleDoors 139 shuffle_doors: ShuffleDoors
140 shuffle_control_center_colors: ShuffleControlCenterColors
141 shuffle_gallery_paintings: ShuffleGalleryPaintings
74 shuffle_letters: ShuffleLetters 142 shuffle_letters: ShuffleLetters
143 shuffle_symbols: ShuffleSymbols
75 keyholder_sanity: KeyholderSanity 144 keyholder_sanity: KeyholderSanity
145 cyan_door_behavior: CyanDoorBehavior
76 daedalus_roof_access: DaedalusRoofAccess 146 daedalus_roof_access: DaedalusRoofAccess
77 victory_condition: VictoryCondition 147 victory_condition: VictoryCondition
148 trap_percentage: TrapPercentage