Give docstrings and display names to Minecraft options

worlds/minecraft/Options.py

@@ -3,37 +3,77 @@ from Options import Choice, Option, Toggle, Range
 
 
 class AdvancementGoal(Range):
+    """Number of advancements required to spawn the Ender Dragon."""
+    displayname = "Advancement Goal"
     range_start = 0
     range_end = 87
     default = 50
 
 
+class EggShardsRequired(EggShards):
+    """Number of dragon egg shards to collect before the Ender Dragon will spawn."""
+    displayname = "Egg Shards Required"
+    range_start = 0
+    range_end = 30
+
+
+class EggShardsAvailable(EggShards):
+    """Number of dragon egg shards available to collect."""
+    displayname = "Egg Shards Available"
+    range_start = 0
+    range_end = 30
+
+
+class ShuffleStructures(Toggle):
+    """Enables shuffling of villages, outposts, fortresses, bastions, and end cities."""
+    displayname = "Shuffle Structures"
+
+
+class StructureCompass(Toggle):
+    """Adds structure compasses to the item pool, which point to the nearest indicated structure."""
+    displayname = "Structure Compasses"
+
+
+class BeeTraps(Range): 
+    """Replaces a percentage of junk items with bee traps, which spawn multiple angered bees around every player when received."""
+    displayname = "Bee Trap Percentage"
+    range_start = 0
+    range_end = 100
+
+
 class CombatDifficulty(Choice):
+    """Modifies the level of items logically required for exploring dangerous areas and fighting bosses."""
+    displayname = "Combat Difficulty"
     option_easy = 0
     option_normal = 1
     option_hard = 2
     default = 1
 
 
-class BeeTraps(Range): 
+class HardAdvancements(Toggle):
-    range_start = 0
+    """Enables certain RNG-reliant or tedious advancements."""
-    range_end = 100
+    displayname = "Include Hard Advancements"
 
 
-class EggShards(Range):
+class InsaneAdvancements(Toggle):
-    range_start = 0
+    """Enables the extremely difficult advancements "How Did We Get Here?" and "Adventuring Time.\""""
-    range_end = 30
+    displayname = "Include Insane Advancements"
+
+
+class PostgameAdvancements(Toggle):
+    """Enables advancements that require spawning and defeating the Ender Dragon."""
+    displayname = "Include Postgame Advancements"
 
 
 minecraft_options: typing.Dict[str, type(Option)] = {
-    "advancement_goal": AdvancementGoal,
+    "advancement_goal":                 AdvancementGoal,
-    "combat_difficulty": CombatDifficulty,
+    "egg_shards_required":              EggShardsRequired,
-    "include_hard_advancements": Toggle,
+    "egg_shards_available":             EggShardsAvailable,
-    "include_insane_advancements": Toggle,
+    "shuffle_structures":               ShuffleStructures,
-    "include_postgame_advancements": Toggle,
+    "structure_compasses":              StructureCompasses,
-    "shuffle_structures": Toggle,
+    "bee_traps":                        BeeTraps,
-    "structure_compasses": Toggle,
+    "combat_difficulty":                CombatDifficulty,
-    "bee_traps": BeeTraps,
+    "include_hard_advancements":        HardAdvancements,
-    "egg_shards_required": EggShards,
+    "include_insane_advancements":      InsaneAdvancements,
-    "egg_shards_available": EggShards
+    "include_postgame_advancements":    PostgameAdvancements,
 }