Pokémon Red and Blue: Version 4 update (ArchipelagoMW#1963)

## What is this fixing or adding?
Adds a large number of new options, including:

- Door Shuffle
- Sphere-based level scaling
- Key Item and Pokedex requirement options to reach the Elite Four
- Split Card Key option
- Dexsanity option can be set to a percentage of Pokémon that will be checks
- Stonesanity: remove the stones from the Celadon Department Store and shuffle them into the item pool, replacing 4 of the 5 Moon Stone items
- Sleep Trap items option
- Randomize Move Types option
- Town Map Fly Location option, to unlock a flight location when finding/receiving the Town Map

Many enhancements have been made, including:
- Game allows you to continue your save file _from Pallet Town_ as a way to save warp back to the beginning of the game. The one-way drop from Diglett's Cave to north Route 2 that had been added to the randomizer has been removed.
- Client auto-hints some locations when you are able to see the item before you can obtain it (but would only show AP Item if it is for another player), including Bike Shop, Oak's Aides, Celadon Prize Corner, and the unchosen Fossil location.

Various bugs have been fixed, including:
- Route 13 wild Pokémon not correctly logically requiring Cut
- Vanilla tm/hm compatibility options giving compatibility for many TMs/HMs erroneously 
- If an item that exists in multiple quantities in the item pool is chosen for one of the locations that are pre-filled with local items, it will continue placing that same item in the remaining locations as long as more of that item exist
- `start_with` option for `randomize_pokedex` still shuffling a Pokédex into the item pool
- The obedience threshold levels being incorrect with 0-2 badges, with Pokémon up to level 30 obeying with 0-1 badges and up to 10 with 2 badges
- Receiving a DeathLink trigger in the Safari Zone causing issues. Now, you will have your steps remaining set to 0 instead of blacking out when you're in the Safari Zone.

Many location names have been changed, as location names are automatically prepended using the Region name and a large number of areas have been split into new regions as part of the overhaul to add Door Shuffle.

Author: Alchav

PokemonClient.py

@@ -29,6 +29,9 @@
             location_map[type(location.ram_address).__name__][location.ram_address.flag] = location.address
             location_bytes_bits[location.address] = {'byte': location.ram_address.byte, 'bit': location.ram_address.bit}
 
+location_name_to_id = {location.name: location.address for location in location_data if location.type == "Item"
+                           and location.address is not None}
+
 SYSTEM_MESSAGE_ID = 0
 
 CONNECTION_TIMING_OUT_STATUS = "Connection timing out. Please restart your emulator, then restart pkmn_rb.lua"
@@ -72,6 +75,7 @@ def __init__(self, server_address, password):
         self.items_handling = 0b001
         self.sent_release = False
         self.sent_collect = False
+        self.auto_hints = set()
 
     async def server_auth(self, password_requested: bool = False):
         if password_requested and not self.password:
@@ -153,6 +157,31 @@ async def parse_locations(data: List, ctx: GBContext):
                     locations.append(loc_id)
             elif flags[flag_type][location_bytes_bits[loc_id]['byte']] & 1 << location_bytes_bits[loc_id]['bit']:
                 locations.append(loc_id)
+
+    hints = []
+    if flags["EventFlag"][280] & 16:
+        hints.append("Cerulean Bicycle Shop")
+    if flags["EventFlag"][280] & 32:
+        hints.append("Route 2 Gate - Oak's Aide")
+    if flags["EventFlag"][280] & 64:
+        hints.append("Route 11 Gate 2F - Oak's Aide")
+    if flags["EventFlag"][280] & 128:
+        hints.append("Route 15 Gate 2F - Oak's Aide")
+    if flags["EventFlag"][281] & 1:
+        hints += ["Celadon Prize Corner - Item Prize 1", "Celadon Prize Corner - Item Prize 2",
+                  "Celadon Prize Corner - Item Prize 3"]
+    if (location_name_to_id["Fossil - Choice A"] in ctx.checked_locations and location_name_to_id["Fossil - Choice B"]
+            not in ctx.checked_locations):
+        hints.append("Fossil - Choice B")
+    elif (location_name_to_id["Fossil - Choice B"] in ctx.checked_locations and location_name_to_id["Fossil - Choice A"]
+            not in ctx.checked_locations):
+        hints.append("Fossil - Choice A")
+    hints = [location_name_to_id[loc] for loc in hints if loc not in ctx.auto_hints and location_name_to_id[loc] in
+             ctx.missing_locations and location_name_to_id[loc] not in ctx.locations_checked]
+    if hints:
+        await ctx.send_msgs([{"cmd": "LocationScouts", "locations": hints, "create_as_hint": 2}])
+    ctx.auto_hints.update(hints)
+
     if flags["EventFlag"][280] & 1 and not ctx.finished_game:
         await ctx.send_msgs([
                     {"cmd": "StatusUpdate",

setup.py

@@ -77,7 +77,6 @@
     "Meritous",
     "Ocarina of Time",
     "Overcooked! 2",
-    "Pokemon Red and Blue",
     "Raft",
     "Secret of Evermore",
     "Slay the Spire",

worlds/pokemon_rb/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Alex "Alchav" Avery
+Copyright (c) 2022-2023 Alex "Alchav" Avery
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

worlds/pokemon_rb/__init__.py

@@ -11,35 +11,59 @@ Items which the player would normally acquire throughout the game have been move
 always able to be completed, but because of the item shuffle the player may need to access certain areas before they
 would in the vanilla game.
 
-A great many things besides item placement can be randomized, such as the location of Pokémon, their stats, types, etc., depending on your yaml settings.
+A great many things besides item placement can be randomized, such as the location of Pokémon, their stats, types, etc.,
+depending on your yaml settings.
 
 Many baseline changes are made to the game, including:
 
-* Bag item space increased to 128 slots (up from 20)
-* PC item storage increased to 64 slots (up from 50)
+* Bag item space increased to 128 slots (up from 20).
+* PC item storage increased to 64 slots (up from 50).
 * You can hold B to run (or bike extra fast!).
 * You can hold select while talking to a trainer to re-battle them.
-* You can return to route 2 from Diglett's Cave without the use of Cut.
+* You can select "Pallet Warp" below the "Continue" option to warp to Pallet Towna s you load your save.
 * Mew can be encountered at the S.S. Anne dock truck. This can be randomized depending on your settings.
 * The S.S. Anne will never depart.
 * Seafoam Islands entrances are swapped. This means you need Strength to travel through from Cinnabar Island to Fuchsia
-City
+City. You also cannot Surf onto the water from the end of Seafoam Islands going backwards if you have not yet dropped
+the boulders.
 * After obtaining one of the fossil item checks in Mt Moon, the remaining item can be received from the Cinnabar Lab
 fossil scientist. This may require reviving a number of fossils, depending on your settings.
 * Obedience depends on the total number of badges you have obtained instead of depending on specific badges.
 * Pokémon that evolve by trading can also evolve by reaching level 35.
-* Evolution stones are reusable.
+* Evolution stones are reusable key items.
 * Much of the dialogue throughout the game has been removed or shortened.
-* If the Old Man is blocking your way through Viridian City, you do not have Oak's Parcel in your inventory, and you've
-exhausted your money and Poké Balls, you can get a free Poké Ball from your mom.
+* The Pokédex shows which HMs can be learned by any Pokémon registered as seen.
 * HM moves can be overwritten if you have the HM for it in your bag.
 * The NPC on the left behind the Celadon Game Corner counter will sell 1500 coins at once instead of giving information
-about the Prize Corner
+about the Prize Corner.
+* A woman in Oak's Lab can send you back in time to replay the first rival battle, in case you have no other reachable
+and repeatable source of money.
+* You can disable and re-enable experience gains by talking to an aide in Oak's Lab.
+* You can reset static encounters (Poké Flute encounter, legendaries, and the trap Poké Ball battles in Power Plant)
+for any Pokémon you have defeated but not caught, by talking to an aide in Oak's Lab.
 
 ## What items and locations get shuffled?
 
 All items that go into your bags given by NPCs or found on the ground, as well as gym badges.
-Optionally, hidden items (those located with the Item Finder) can be shuffled as well.
+Various options add more items / location checks to the pool, including:
+* Randomize Hidden Items.
+* Stonesanity: Replace 4 of the 5 Moon Stones in the item pool with the other 4 stones, and remove them from the
+Celadon Department Store shop. Will shuffle the hidden item locations that contain Moon Stones in the original game
+regardless of the Randomize Hidden Items option.
+* Prizesanity: Shuffle the three item prizes from the Celadon Prize Corner.
+* Tea: Adds a Tea item to the item pool which is required to pass the Saffron Gate guards instead of vending machine
+drinks. Adds a location check to the woman in Celadon Mansion 1F, where the Tea item is found in FireRed and LeafGreen.
+* Extra Key Items: Adds key items that will be required to access the Power Plant, Pokémon Mansion, Rocket Hideout,
+and Safari Zone. Adds 4 extra item locations to Rock Tunnel B1F
+* Split Card Key: Splits the Card Key into 10 different Card Keys, one for each floor of Silph Co that has locked doors.
+Adds 9 location checks to friendly NPCs in Silph Co. You can also choose Progressive Card Keys to always obtain the
+keys in order from Card Key 2F to Card Key 11F.
+* Trainersanity: Adds location checks to 317 trainers. Does not include scripted trainers, most of which disappear
+after battling them, but also includes Gym Leaders. You must talk to the trainer after defeating them to receive
+your prize. Adds 317 random filler items to the item pool
+* Dexsanity: Location checks occur when registering Pokémon as owned in the Pokédex. You can choose a percentage
+of Pokémon to have checks added to, chosen randomly. You can identify which Pokémon have location checks by an empty
+Poké Ball icon shown in battle or in the Pokédex menu.
 
 ## Which items can be in another player's world?