Merge branch 'Dev' into dev-fenhl

# Conflicts:
#	Plandomizer.py
#	World.py
#	data/presets_default.json

Author: fenhl

CHANGELOG.md

@@ -9,6 +9,7 @@
 * Glitched logic has been renamed to `Advanced` and been revamped to work with any settings, including Entrance Randomization.
 * A slew of advanced tricks and glitches have been added for the new `Advanced` logic setting.
 * The `Open Door of Time` setting has been renamed to `Door of Time`, with new options to require the Spiritual Stones and/or the Ocarina of Time.
+* New `Additional Random Starting Items` setting.
 
 ## Bug fixes
 * The Deku Shield pot in the Spirit Temple is no longer shuffled when both `Fix Broken Drops` and `Include Empty Pots` are off.

ItemPool.py

@@ -345,6 +345,14 @@
     "Mask of Truth",
 )
 
+ocarina_buttons: tuple[str, ...] = (
+    'Ocarina A Button',
+    'Ocarina C down Button',
+    'Ocarina C right Button',
+    'Ocarina C left Button',
+    'Ocarina C up Button',
+)
+
 normal_bottles: list[str] = [bottle for bottle in sorted(ItemInfo.bottles) if bottle not in ('Deliver Letter', 'Sell Big Poe')] + ['Bottle with Big Poe']
 reward_list: list[str] = [item.name for item in sorted([i for n, i in ItemInfo.items.items() if i.type == 'DungeonReward'], key=lambda x: x.special['item_id'])]
 song_list: list[str] = [item.name for item in sorted([i for n, i in ItemInfo.items.items() if i.type == 'Song'], key=lambda x: x.index if x.index is not None else 0)]
@@ -572,7 +580,7 @@ def get_pool_core(world: World) -> tuple[list[str], dict[str, Item]]:
         if world.settings.shuffle_song_items == 'any':
             pending_junk_pool.extend(song_list)
         if world.settings.shuffle_individual_ocarina_notes:
-            pending_junk_pool.extend(['Ocarina A Button', 'Ocarina C up Button', 'Ocarina C left Button', 'Ocarina C down Button', 'Ocarina C right Button'])
+            pending_junk_pool.extend(ocarina_buttons)
 
     if world.settings.triforce_hunt:
         if world.settings.triforce_hunt_mode == 'normal':
@@ -584,11 +592,7 @@ def get_pool_core(world: World) -> tuple[list[str], dict[str, Item]]:
             pending_junk_pool.extend(triforce_blitz_items)
         # Ice% is handled below
     if world.settings.shuffle_individual_ocarina_notes:
-        pending_junk_pool.append('Ocarina A Button')
-        pending_junk_pool.append('Ocarina C up Button')
-        pending_junk_pool.append('Ocarina C left Button')
-        pending_junk_pool.append('Ocarina C down Button')
-        pending_junk_pool.append('Ocarina C right Button')
+        pending_junk_pool.extend(ocarina_buttons)
 
     # Use the vanilla items in the world's locations when appropriate.
     vanilla_items_processed = Counter()
@@ -1075,6 +1079,25 @@ def get_pool_core(world: World) -> tuple[list[str], dict[str, Item]]:
             pool.remove(junk_item)
             pool.append(pending_item)
 
+    world.distribution.collect_starters(world.state)
+
+    if not world.settings.shuffle_individual_ocarina_notes:
+        for ocarina_button in ocarina_buttons:
+            world.state.collect(ItemFactory(ocarina_button, world))
+
+    for _ in range(world.settings.add_random_starting_items):
+        random_starting_items_pool = sorted({item for item in pool if item not in ItemInfo.junk_weight}) # give each item the same weight regardless of how many copies there are
+        selected_item = random.choice(random_starting_items_pool)
+        world.randomized_starting_items[selected_item] = world.randomized_starting_items.get(selected_item, 0) + 1
+        pool.remove(selected_item)
+        pool.extend(get_junk_item())
+    for item, count in world.randomized_starting_items.items():
+        item = ItemFactory(item, world)
+        for _ in range(count):
+            if item.solver_id is not None:
+                world.state.collect(item)
+    world.distribution.randomized_starting_items = world.randomized_starting_items
+
     if world.settings.junk_ice_traps in ('custom_count', 'custom_percent'):
         junk_pool[:] = [('Ice Trap', 1)]
         # Get a list of all "junk" type items
@@ -1138,13 +1161,4 @@ def get_pool_core(world: World) -> tuple[list[str], dict[str, Item]]:
         item_groups['Junk'] = remove_junk_items
         world.distribution.distribution.search_groups['Junk'] = remove_junk_items
 
-    world.distribution.collect_starters(world.state)
-
-    if not world.settings.shuffle_individual_ocarina_notes:
-        world.state.collect(ItemFactory('Ocarina A Button', world))
-        world.state.collect(ItemFactory('Ocarina C up Button', world))
-        world.state.collect(ItemFactory('Ocarina C down Button', world))
-        world.state.collect(ItemFactory('Ocarina C left Button', world))
-        world.state.collect(ItemFactory('Ocarina C right Button', world))
-
     return pool, placed_items

Patches.py

@@ -2218,6 +2218,7 @@ def update_scrub_text(message: bytearray, text_replacement: list[str], default_p
 
     # actually write the save table to rom
     world.distribution.give_items(world, save_context)
+    world.distribution.give_randomized_items(world, save_context)
     if world.settings.starting_age == 'adult':
         # When starting as adult, the pedestal doesn't handle child default equips when going back child the first time, so we have to equip them ourselves
         save_context.equip_default_items('child')

Plandomizer.py

@@ -15,7 +15,7 @@
 from Fill import FillError
 from Hints import HintArea, gossipLocations, GossipText, hint_func
 from Item import ItemFactory, ItemInfo, ItemIterator, is_item, Item
-from ItemPool import item_groups, get_junk_item, song_list, trade_items, child_trade_items, eggs, triforce_blitz_items, triforce_pieces
+from ItemPool import item_groups, get_junk_item, song_list, trade_items, child_trade_items, ocarina_buttons, eggs, triforce_blitz_items, triforce_pieces
 from JSONDump import dump_obj, CollapseList, CollapseDict, AlignedDict, SortedDict
 from Location import Location, LocationIterator, LocationFactory
 from LocationList import location_groups, location_table
@@ -45,6 +45,7 @@ class InvalidFileException(Exception):
     'songs',
     'entrances',
     'locations',
+    ':randomized_starting_items',
     ':skipped_locations',
     ':woth_locations',
     ':goal_locations',
@@ -272,6 +273,7 @@ def __init__(self, distribution: Distribution, id: int, src_dict: Optional[dict[
         self.item_pool: Optional[dict[str, ItemPoolRecord]] = None
         self.entrances: Optional[dict[str, EntranceRecord]] = None
         self.locations: Optional[dict[str, LocationRecord | list[LocationRecord]]] = None
+        self.randomized_starting_items: Optional[dict[str, int]] = None
         self.woth_locations: Optional[dict[str, LocationRecord]] = None
         self.goal_locations: Optional[dict[str, dict[str, dict[str, LocationRecord | dict[str, LocationRecord]]]]] = None
         self.barren_regions: Optional[list[str]] = None
@@ -300,6 +302,7 @@ def update(self, src_dict: dict[str, Any], update_all: bool = False) -> None:
             'item_pool': {name: ItemPoolRecord(record) for (name, record) in src_dict.get('item_pool', {}).items()},
             'entrances': {name: EntranceRecord(record) for (name, record) in src_dict.get('entrances', {}).items()},
             'locations': {name: [LocationRecord(rec) for rec in record] if is_pattern(name) else LocationRecord(record) for (name, record) in src_dict.get('locations', {}).items() if not is_output_only(name)},
+            'randomized_starting_items': None,
             'woth_locations': None,
             'goal_locations': None,
             'barren_regions': None,
@@ -332,6 +335,7 @@ def to_json(self) -> dict[str, Any]:
             'item_pool': SortedDict({name: record.to_json() for (name, record) in self.item_pool.items()}),
             'entrances': {name: record.to_json() for (name, record) in self.entrances.items()},
             'locations': {name: [rec.to_json() for rec in record] if is_pattern(name) else record.to_json() for (name, record) in self.locations.items()},
+            ':randomized_starting_items': None if self.randomized_starting_items is None else {name: count for (name, count) in self.randomized_starting_items.items()},
             ':skipped_locations': {loc.name: LocationRecord.from_item(loc.item).to_json() for loc in self.skipped_locations},
             ':woth_locations': None if self.woth_locations is None else {name: record.to_json() for (name, record) in self.woth_locations.items()},
             ':goal_locations': self.goal_locations,
@@ -1077,6 +1081,10 @@ def give_items(self, world: World, save_context: SaveContext) -> None:
                 continue
             save_context.give_item(world, name, record.count)
 
+    def give_randomized_items(self, world: World, save_context: SaveContext) -> None:
+        for item, count in world.randomized_starting_items.items():
+            save_context.give_item(world, item, count)
+
     def get_starting_item(self, item: str) -> int:
         items = self.settings.starting_items
         if item in items:

SettingsList.py

@@ -3834,6 +3834,18 @@ class SettingInfos:
         ''',
     )
 
+    add_random_starting_items = Scale(
+        gui_text         = 'Additional Random Starting Items',
+        gui_tooltip    = '''\
+            Begin the game with this many randomly selected items in
+            addition to your selections from the tables.
+        ''',
+        default          = 0,
+        minimum          = 0,
+        maximum          = 10,
+        shared           = True,
+    )
+
     start_with_consumables = Checkbutton(
         gui_text       = 'Start with Consumables',
         gui_tooltip    = '''\

Unittest.py

@@ -328,6 +328,7 @@ def test_should_not_throw_exception(self):
             "plando-potscrates-allmq",
             "plando-beehives",
             "plando-freestanding-pots-crates-beehives-triforcehunt",
+            "random_starting_items",
         ]
         for filename in filenames:
             with self.subTest(filename):

World.py

@@ -58,6 +58,7 @@ def __init__(self, world_id: int, settings: Settings, resolve_randomized_setting
         self.barren_dungeon: int = 0
         self.woth_dungeon: int = 0
         self.randomized_list: list[str] = []
+        self.randomized_starting_items: dict[str, int] = {}
         self.cached_bigocto_location: Optional[EllipsisType | Location] = ...
 
         self.parser: Rule_AST_Transformer = Rule_AST_Transformer(self)
@@ -435,6 +436,7 @@ def copy(self) -> World:
         new_world.randomized_list = list(self.randomized_list)
         for randomized_item in new_world.randomized_list:
             setattr(new_world, randomized_item, getattr(self.settings, randomized_item))
+        new_world.distribution.randomized_starting_items = new_world.randomized_starting_items = copy.copy(self.randomized_starting_items)
 
         new_world.always_hints = list(self.always_hints)
         new_world.max_progressions = copy.copy(self.max_progressions)

data/Hints/scrubs.json

@@ -1,33 +1,36 @@
 {
     "name":                  "scrubs",
     "gui_name":              "Scrubs",
-    "description":           "Tournament hints used for Scrubs Races. Duplicates of each hint except foolish and item which are placed at ToT. Skull Mask, Ice Cavern Final Room and Castle Great Fairies are always hinted, 4 Path, 3 Foolish (no Dungeons), 1 Item, 9 sometimes, HC(Storms) & HF(Cow Grotto) junked.",
+    "description":           "Tournament hints used for Scrubs Races. Duplicates of each hint except foolish which are placed at ToT. Skull Mask, Ice Cavern Final Room, Frogs Rewards and Castle Great Fairies are always hinted, 5 Path, 4 Foolish (2 Dungeons), 8 sometimes (2 Dual), HC(Storms) & HF(Cow Grotto) junked.",
     "add_locations":         [
         { "location": "Castle Fairy Checks", "types": ["dual_always"] },
         { "location": "Ice Cavern Final Room", "types": ["dual_always"] },
-        { "location": "Deku Theater Skull Mask", "types": ["always"] }
+        { "location": "Deku Theater Skull Mask", "types": ["always"] },
+        { "location": "ZR Frogs Rewards", "types": ["dual_always"] }
     ],
     "remove_locations":      [
+        { "location": "the Haunted Wasteland", "types": ["barren"] },
         { "location": "Hyrule Castle", "types": ["barren"] },
-        { "location": "OGC Great Fairy Reward", "types": ["always"] },
-        { "location": "Sheik at Temple", "types": ["always", "sometimes"] },
-        { "location": "ZR Frogs Rewards", "types": ["dual_always", "dual"] },
+        { "location": "Gerudo's Fortress", "types": ["barren"] },
+        { "location": "the Temple of Time", "types": ["barren"] },
+        { "location": "ZR Frogs Ocarina Game", "types": ["always"] },
         { "location": "Sheik in Forest", "types": ["sometimes"] },
         { "location": "Sheik in Crater", "types": ["sometimes"] },
-        { "location": "Sheik in Kakariko", "types": ["always", "sometimes"] },
         { "location": "Sheik in Ice Cavern", "types": ["sometimes"] },
         { "location": "Sheik at Colossus", "types": ["sometimes"] },
         { "location": "Song from Royal Familys Tomb", "types": ["sometimes"] },
-        { "location": "Song from Ocarina of Time", "types": ["always", "sometimes"] },
-        { "location": "Deku Theater Rewards", "types": ["dual_always"] }
+        { "location": "Deku Theater Rewards", "types": ["dual_always", "dual"] },
+        { "location": "Fire Temple Lower Loop", "types": ["dual"] },
+        { "location": "GF Horseback Archery Rewards", "types": ["dual_always", "dual"] },
+        { "location": "Kak Anju as Child", "types": ["sometimes"] }
     ],
     "add_items":             [],
     "remove_items":          [
         { "item": "Zeldas Lullaby", "types": ["woth", "goal"] },
         { "item": "Nocturne of Shadow", "types": ["woth", "goal"] }
     ],
-    "dungeons_woth_limit":   2,
-    "dungeons_barren_limit": 0,
+    "dungeons_woth_limit":   5,
+    "dungeons_barren_limit": 2,
     "named_items_required":  true,
     "vague_named_items":     false,
     "use_default_goals":     true,
@@ -56,13 +59,13 @@
             "HC (Storms Grotto)",
             "HF (Cow Grotto)"
         ]},
-        "barren":          {"order": 4, "weight": 0.0, "fixed":   3, "copies": 1, "priority_stones": [
+        "barren":          {"order": 4, "weight": 0.0, "fixed":   4, "copies": 1, "priority_stones": [
             "ToT (Left)",
             "ToT (Left-Center)",
             "ToT (Right)",
             "ToT (Right-Center)"
         ]},
-        "goal":            {"order": 5, "weight": 0.0, "fixed":   4, "copies": 2, "remove_stones": [
+        "goal":            {"order": 5, "weight": 0.0, "fixed":   5, "copies": 2, "remove_stones": [
             "ToT (Left)",
             "ToT (Left-Center)",
             "ToT (Right)",
@@ -78,11 +81,13 @@
             "HC (Storms Grotto)",
             "HF (Cow Grotto)"
         ]},
-        "item":            {"order": 7, "weight": 0.0, "fixed":   1, "copies": 1, "priority_stones": [
+        "dual":            {"order": 7, "weight": 0.0, "fixed":   2, "copies": 2, "remove_stones": [
             "ToT (Left)",
             "ToT (Left-Center)",
             "ToT (Right)",
-            "ToT (Right-Center)"
+            "ToT (Right-Center)",
+            "HC (Storms Grotto)",
+            "HF (Cow Grotto)"
         ]},
         "junk":            {"order": 8, "weight": 0.0, "fixed":   1, "copies": 2, "priority_stones": [
             "HC (Storms Grotto)",
@@ -104,7 +109,7 @@
         "song":            {"order": 0, "weight": 0.0, "fixed":   0, "copies": 2},
         "overworld":       {"order": 0, "weight": 0.0, "fixed":   0, "copies": 2},
         "dungeon":         {"order": 0, "weight": 0.0, "fixed":   0, "copies": 2},
-        "dual":            {"order": 0, "weight": 0.0, "fixed":   0, "copies": 0},
+        "item":            {"order": 0, "weight": 0.0, "fixed":   0, "copies": 0},
         "named-item":      {"order": 0, "weight": 0.0, "fixed":   0, "copies": 2},
         "entrance_always": {"order": 0, "weight": 0.0, "fixed":   0, "copies": 2},
         "important_check": {"order": 0, "weight": 0.0, "fixed":   0, "copies": 0}