Add Roamer Re-Encounter mode

modules/modes/__init__.py

@@ -27,6 +27,7 @@ def get_bot_modes() -> list[Type[BotMode]]:
         from .level_grind import LevelGrindMode
         from .nugget_bridge import NuggetBridgeMode
         from .puzzle_solver import PuzzleSolverMode
+        from .roamer_reencounter import RoamerReencounterMode
         from .roamer_reset import RoamerResetMode
         from .rock_smash import RockSmashMode
         from .safari import SafariMode
@@ -51,6 +52,7 @@ def get_bot_modes() -> list[Type[BotMode]]:
             LevelGrindMode,
             NuggetBridgeMode,
             PuzzleSolverMode,
+            RoamerReencounterMode,
             RoamerResetMode,
             RockSmashMode,
             SafariMode,

modules/modes/roamer_reencounter.py

@@ -0,0 +1,173 @@
+from typing import Generator, TYPE_CHECKING
+
+from modules.context import context
+from modules.map_data import MapRSE, MapFRLG
+from modules.modes import BotMode, BattleAction, BotModeError
+from modules.player import get_player, get_player_avatar, get_player_location
+from modules.pokemon_party import get_party
+from modules.roamer import get_roamer
+from ._asserts import (
+    assert_player_has_poke_balls,
+    assert_boxes_or_party_can_fit_pokemon,
+)
+from .util import (
+    walk_one_tile,
+    navigate_to,
+    register_key_item,
+    mount_bicycle,
+    unmount_bicycle,
+    repel_is_active,
+    apply_repel,
+    ensure_facing_direction,
+    RanOutOfRepels,
+)
+from ..battle_state import battle_is_active
+from ..items import get_item_bag, get_item_by_name
+from ..map import get_map_data_for_current_position
+
+if TYPE_CHECKING:
+    from modules.encounter import EncounterInfo
+
+
+class RoamerReencounterMode(BotMode):
+    @staticmethod
+    def name() -> str:
+        return "Roamer (Re-Encounter)"
+
+    @staticmethod
+    def is_selectable() -> bool:
+        if context.rom.is_emerald:
+            allowed_maps = (
+                MapRSE.ROUTE110,
+                MapRSE.SLATEPORT_CITY,
+                MapRSE.SLATEPORT_CITY_BATTLE_TENT_LOBBY,
+            )
+        elif context.rom.is_rs:
+            allowed_maps = (
+                MapRSE.ROUTE110,
+                MapRSE.SLATEPORT_CITY,
+                # This is actually the Pokémon Centre, but R/S's map numbers are different here
+                MapRSE.SLATEPORT_CITY_HOUSE,
+            )
+        else:
+            allowed_maps = (
+                MapFRLG.ROUTE1,
+                MapFRLG.PALLET_TOWN,
+                MapFRLG.PALLET_TOWN_RIVALS_HOUSE,
+            )
+
+        return get_roamer() is not None and get_player_avatar().map_group_and_number in allowed_maps
+
+    def on_battle_started(self, encounter: "EncounterInfo | None") -> BattleAction:
+        context.set_manual_mode()
+        return BattleAction.CustomAction
+
+    def on_repel_effect_ended(self) -> Generator:
+        try:
+            yield from apply_repel()
+        except RanOutOfRepels:
+            context.message = "Player ran out of Repel."
+            context.set_manual_mode()
+
+    def run(self) -> Generator:
+        if get_roamer() is None:
+            raise BotModeError("The Roamer is not currently roaming.")
+
+        min_level = 6 if context.rom.is_frlg else 14
+        max_level = 50 if context.rom.is_frlg else 40
+        first_pokemon = get_party().first_non_fainted
+        print(max_level, first_pokemon.level, min_level)
+        if first_pokemon.level > max_level or first_pokemon.level < min_level:
+            raise BotModeError(
+                f"The first non-fainted Pokémon in your party must have a level between {min_level} and {max_level}. Yours is {first_pokemon.level}."
+            )
+
+        assert_player_has_poke_balls()
+        assert_boxes_or_party_can_fit_pokemon()
+
+        if get_item_bag().number_of_repels == 0:
+            raise BotModeError("You do not have any repels in your item bag. Go and get some first!")
+
+        mach_bike = get_item_by_name("Bicycle" if context.rom.is_frlg else "Mach Bike")
+        if get_player().registered_item is not mach_bike and get_item_bag().quantity_of(mach_bike) > 0:
+            yield from register_key_item(mach_bike)
+        using_bike = get_player().registered_item is mach_bike
+
+        has_good_ability = get_party().non_eggs[0].ability.name in ("Illuminate", "Arena Trap")
+
+        if not repel_is_active():
+            yield from apply_repel()
+
+        is_rse = context.rom.is_rse
+        is_frlg = context.rom.is_frlg
+        while not battle_is_active():
+            player_map, player_coordinates = get_player_location()
+
+            if is_rse and player_map is MapRSE.SLATEPORT_CITY_BATTLE_TENT_LOBBY:
+                if player_coordinates in ((6, 9), (7, 9)):
+                    yield from walk_one_tile("Down")
+                else:
+                    yield from navigate_to(MapRSE.SLATEPORT_CITY_BATTLE_TENT_LOBBY, (6, 9))
+
+            elif is_rse and player_map is MapRSE.SLATEPORT_CITY_HOUSE:
+                if player_coordinates in ((6, 8), (7, 8)):
+                    yield from walk_one_tile("Down")
+                else:
+                    yield from navigate_to(MapRSE.SLATEPORT_CITY_HOUSE, (6, 8))
+
+            elif is_rse and player_map is MapRSE.SLATEPORT_CITY:
+                if using_bike:
+                    yield from mount_bicycle()
+                    yield from navigate_to(MapRSE.ROUTE110, (13, 98), avoid_encounters=False)
+                    yield from unmount_bicycle()
+                    context.emulator.hold_button("B")
+                    yield from walk_one_tile("Up")
+                    context.emulator.release_button("B")
+                else:
+                    yield from navigate_to(MapRSE.ROUTE110, (14, 97), run=True, avoid_encounters=False)
+
+            elif is_rse and player_map is MapRSE.ROUTE110:
+                if not get_map_data_for_current_position().has_encounters:
+                    yield from navigate_to(MapRSE.ROUTE110, (14, 97), run=True, avoid_encounters=False)
+
+                directions = ["Down", "Right", "Up", "Left"]
+                for index in range(42 if has_good_ability else 62):
+                    yield from ensure_facing_direction(directions[index % 4])
+
+                if using_bike:
+                    yield from mount_bicycle()
+
+                # In R/S, there is an NPC that wanders randomly and can get in the way of the
+                # player's path. That's why in these games, we instead go into the Pokémon Center
+                # to achieve the required map change.
+                destination_coordinates = (10, 12) if context.rom.is_emerald else (19, 19)
+                yield from navigate_to(MapRSE.SLATEPORT_CITY, destination_coordinates, avoid_encounters=False)
+
+            elif is_frlg and player_map is MapFRLG.PALLET_TOWN_RIVALS_HOUSE:
+                if player_coordinates == (4, 8):
+                    yield from walk_one_tile("Down")
+                else:
+                    yield from navigate_to(MapFRLG.PALLET_TOWN_RIVALS_HOUSE, (4, 8))
+
+            elif is_frlg and player_map is MapFRLG.PALLET_TOWN:
+                if using_bike:
+                    yield from mount_bicycle()
+                yield from navigate_to(MapFRLG.ROUTE1, (12, 39), avoid_encounters=False)
+                yield from unmount_bicycle()
+
+            elif is_frlg and player_map is MapFRLG.ROUTE1:
+                if not get_map_data_for_current_position().has_encounters:
+                    yield from navigate_to(MapFRLG.ROUTE1, (12, 39), run=True, avoid_encounters=False)
+
+                directions = ["Down", "Right", "Up", "Left"]
+                for index in range(18 if has_good_ability else 38):
+                    yield from ensure_facing_direction(directions[index % 4])
+
+                if using_bike:
+                    yield from mount_bicycle()
+                yield from navigate_to(MapFRLG.PALLET_TOWN, (15, 7), avoid_encounters=False)
+
+            else:
+                raise BotModeError("Player is on an unexpected map.")
+
+        context.set_manual_mode()

wiki/Readme.md

@@ -33,6 +33,7 @@ For quick help and support, reach out in Discord [#pokebot-gen3-support❔](http
 - 🟡 [Nugget Bridge](pages/Mode%20-%20Nugget%20Bridge.md)
 - 🧩 [Puzzle Solver](pages/Mode%20-%20Puzzle%20Solver.md)
 - 🏃 [Roamer Resets](pages/Mode%20-%20Roamer%20Resets.md)
+- 🏃 [Roamer Re-Encounter](pages/Mode%20-%20Roamer%20Re-Encounter.md)
 - 🪨 [Rock Smash](pages/Mode%20-%20Rock%20Smash.md)
 - 🏞️ [Safari](pages/Mode%20-%20Safari.md)
 - 🔄 [Spin](pages/Mode%20-%20Spin.md)

wiki/pages/Mode - Roamer Re-Encounter.md

@@ -0,0 +1,54 @@
+🏠 [`pokebot-gen3` Wiki Home](../Readme.md)
+
+# 🏃 Roamer Re-Encounter Mode
+This mode helps with encountering a Roaming Pokémon again after it has fled a battle.
+
+It will run around the map (using Repel to avoid any other encounters) until it
+encounters the Roamer, in which case it switches back to manual mode.
+
+## Requirements for Ruby/Sapphire/Emerald
+![](../../modules/web/static/sprites/pokemon/normal/Latias.png)
+![](../../modules/web/static/sprites/pokemon/normal/Latios.png)
+
+1. The Roaming Pokémon must be active.
+2. The first non-fainted Pokémon in your party must be between level 14 and 40.
+3. You should have plenty of Max Repel in your inventory (though Super Repel and 
+   regular Repel will also work.)
+4. You must be on one of these maps:
+   - Route 110
+   - Slateport City
+   - Slateport Battle Tent (R/S) / Slateport Contest Hall (Emerald)
+5. Optional, but it speeds things up: Have the Mach Bike in your inventory.
+
+
+## Requirements for FireRed/LeafGreen
+![](../../modules/web/static/sprites/pokemon/normal/Raikou.png)
+![](../../modules/web/static/sprites/pokemon/normal/Entei.png)
+![](../../modules/web/static/sprites/pokemon/normal/Suicune.png)
+
+1. The Roaming Pokémon must be active.
+2. The first non-fainted Pokémon in your party must be between level 6 and 50.
+3. You should have plenty of Max Repel in your inventory (though Super Repel and
+   regular Repel will also work.)
+4. You must be on one of these maps:
+    - Route 1
+    - Pallet Town
+    - the Rival's house in Pallet Town
+5. Optional, but it speeds things up: Have the Bicycle in your inventory.
+
+
+## Game Support
+|          | 🟥 Ruby | 🔷 Sapphire | 🟢 Emerald | 🔥 FireRed | 🌿 LeafGreen |
+|:---------|:-------:|:-----------:|:----------:|:----------:|:------------:|
+| English  |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+| Japanese |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+| German   |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+| Spanish  |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+| French   |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+| Italian  |    ✅    |      ✅      |     ✅      |     ✅      |      ✅       |
+
+✅ Tested, working
+
+🟨 Untested, may not work
+
+❌ Untested, not working