FRLG AutoStory 00.28-00.29: through Rock Tunnel to Lavender Town

.github/workflows/cpp-ci-serial-programs-base.yml

@@ -106,7 +106,7 @@ jobs:
         uses: actions/checkout@v7
         with:
           repository: dayfine/PokemonSimulation
-          ref: 9cb12c52f5f055299e32c2a7cf43e7103c101e3e
+          ref: bdca47c5045797be1d2a1f0931ad6a8f15ab3225
           path: StoryReplaySource
 
       - name: Verify replay preview bytes and independently regenerate its route input

SerialPrograms/Source/Pokemon/Navigation/Pokemon_MapData.cpp

@@ -1,4 +1,4 @@
 /*  Map Data
  *
  *  From: https://github.com/PokemonAutomation/
  *
@@ -36,6 +36,13 @@
     {'2', TileKind::CLOSED_SOUTH},
     {'4', TileKind::CLOSED_WEST},
     {'6', TileKind::CLOSED_EAST},
+    {'u', TileKind::SPIN_NORTH},
+    {'d', TileKind::SPIN_SOUTH},
+    {'l', TileKind::SPIN_WEST},
+    {'r', TileKind::SPIN_EAST},
+    {'o', TileKind::STOP_SPIN},
+    {'H', TileKind::FALL_HOLE},
+    {'B', TileKind::STRENGTH_BUTTON},
 };
 
 constexpr std::pair<const char*, WarpEntry> WARP_ENTRIES[] = {

SerialPrograms/Source/Pokemon/Navigation/Pokemon_MapData.h

@@ -69,6 +69,13 @@ enum class TileKind : uint8_t{
     CLOSED_SOUTH,   //  '2'  not entered from it, nor left through it (the
     CLOSED_WEST,    //  '4'  number pad's arrows)
     CLOSED_EAST,    //  '6'
+    SPIN_NORTH,     //  'u'  open; stepping on it slides the player north
+    SPIN_SOUTH,     //  'd'  (Rocket Hideout and Viridian Gym spin tiles)
+    SPIN_WEST,      //  'l'
+    SPIN_EAST,      //  'r'
+    STOP_SPIN,      //  'o'  open; where a spin's slide stops
+    FALL_HOLE,      //  'H'  open; a hole that drops the player a floor
+    STRENGTH_BUTTON,//  'B'  open; Victory Road's switch for a boulder
 };
 //  The tile a glyph stands for, or nothing if it isn't one.
 std::optional<TileKind> tile_from_glyph(char glyph);

SerialPrograms/Source/Pokemon/Navigation/Pokemon_MapData_Tests.cpp

@@ -1,4 +1,4 @@
 /*  Map Data Tests
  *
  *  From: https://github.com/PokemonAutomation/
  *
@@ -181,7 +181,7 @@
 }
 
 UnitTestResult test_glyphs_round_trip(){
-    for (char glyph : std::string("#.~wv^<>DS 8246")){
+    for (char glyph : std::string("#.~wv^<>DS 8246udlroHB")){
         const std::optional<TileKind> tile = tile_from_glyph(glyph);
         if (!tile || glyph_of(*tile) != glyph){
             return std::string("Glyph '") + glyph + "' does not round-trip.";
@@ -193,6 +193,27 @@
     return true;
 }
 
+//  PokemonSimulation's tile-legend.json glyphs for forced movement, holes and
+//  boulder switches, in a map's rows.
+UnitTestResult test_spin_hole_and_button_glyphs_parse(){
+    const std::string json = R"({
+    "name": "SpinRoom",
+    "source": {"decomp_file": "f", "revision": "r", "date": "d"},
+    "tiles": ["udlroHB"]
+})";
+    const MapData map = parse_map(parse_json(json), "SpinRoom.json");
+    constexpr TileKind EXPECTED[] = {
+        TileKind::SPIN_NORTH, TileKind::SPIN_SOUTH, TileKind::SPIN_WEST, TileKind::SPIN_EAST,
+        TileKind::STOP_SPIN, TileKind::FALL_HOLE, TileKind::STRENGTH_BUTTON,
+    };
+    for (int x = 0; x < (int)std::size(EXPECTED); x++){
+        if (map.tiles.at({x, 0}) != EXPECTED[x]){
+            return std::format("Tile ({}, 0) read '{}'.", x, glyph_of(map.tiles.at({x, 0})));
+        }
+    }
+    return true;
+}
+
 struct BadMap{
     const char* name;
     std::string json;
@@ -484,6 +505,10 @@
         .input = {.name = "glyphs round-trip", .test = test_glyphs_round_trip},
         .expectation = {.description = "converts between tile characters and enum kinds"},
     },
+    {
+        .input = {.name = "spin, hole and button glyphs", .test = test_spin_hole_and_button_glyphs_parse},
+        .expectation = {.description = "parses u d l r o H B as the tile legend's spin, stop, hole and switch tiles"},
+    },
     {
         .input = {.name = "each error class", .test = test_each_error_class},
         .expectation = {.description = "rejects invalid JSON syntax and malformed map schemas"},

SerialPrograms/Source/VideoGames/PokemonFRLG/Inference/Menus/PokemonFRLG_SaveCardReader.cpp

@@ -59,7 +59,7 @@
         : SmallDictionaryMatcher(dictionary())
     {}
 
     static JsonObject dictionary(){
         JsonObject english;
         for (const auto& [slug, name] : {
             std::pair<const char*, const char*>{"pallet-town", "Pallet Town"},
@@ -74,6 +74,7 @@
             {"route-24", "Route 24"},
             {"route-25", "Route 25"},
             {"route-10", "Route 10"},
+            {"lavender-town", "Lavender Town"},
             {"vermilion-city", "Vermilion City"},
         }){
             JsonArray names;

SerialPrograms/Source/VideoGames/PokemonFRLG/Inference/Menus/PokemonFRLG_SaveCardReader.h

@@ -33,7 +33,8 @@ ImageFloatBox save_card_title_box();
 
 //  The place on the save card: "pallet-town", "viridian-city",
 //  "viridian-forest", "pewter-city", "route-1" to "route-4", "cerulean-city",
-//  "route-10", "route-24", "route-25", "vermilion-city"; empty if it can't be read, as
+//  "route-10", "route-24", "route-25", "vermilion-city",
+//  "lavender-town"; empty if it can't be read, as
 //  in a language the reader has no names for.
 std::string read_save_card_location(Logger& logger, Language language, const ImageViewRGB32& screen);
 

SerialPrograms/Source/VideoGames/PokemonFRLG/Overworld/PokemonFRLG_MovementMechanics.h

@@ -0,0 +1,101 @@
+/*  Movement Mechanics
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ *  How FireRed and LeafGreen move the player for a press of the D-pad, as
+ *  measured on the console, and the presses the walker sends because of
+ *  it. The overworld walker (OverworldWalkSteps, AutoStory's step_once())
+ *  presses by this table, and OverworldSim moves its player by the same
+ *  rules.
+ *
+ *  Taps measured on console B (2026-11-09, Route 10's Pokemon Center 1F,
+ *  D-pad presses with a 700ms release, tiles counted by exact frame match
+ *  against reference shots), 140 of 140 alike:
+ *  -   From a standstill, a tap of 16 to 133ms while the player faces
+ *      another way only turns them, never steps (pokefirered turns in 8
+ *      frames).
+ *  -   The same tap while they face its way takes exactly one step.
+ *  -   No tap was dropped.
+ *  Repeated step taps (66ms each, after a turn tap and a 1000ms wait):
+ *  -   A step tap that starts within STEP_TAP_LOCKOUT of the previous step
+ *      tap's start is ignored.
+ *  -   Taps with no release between them are one hold: after a turn, 3 of
+ *      them took 0 or 1 steps.
+ *  After a battle (console B, 2026-11-09 15:50, 00.28 winston_line): a
+ *  step tap sent as flee_battle() returned, on the black's end, was lost;
+ *  one more tap by hand stepped.
+ *
+ */
+
+#ifndef PokemonAutomation_PokemonFRLG_MovementMechanics_H
+#define PokemonAutomation_PokemonFRLG_MovementMechanics_H
+
+#include <cstddef>
+#include "Common/Cpp/Time.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+namespace PokemonFRLG{
+namespace MovementMechanics{
+
+
+//  The game.
+
+//  Walking: a tile per 16 frames at 60 fps (console B, 2026-11-09).
+inline constexpr Milliseconds TILE_TIME(267);
+//  Running with B held: a tile per 8 frames (console B, 2026-11-02, video
+//  of run 00.11).
+inline constexpr Milliseconds RUN_TILE_TIME(133);
+//  Surfing: a tile per 8 frames.
+inline constexpr Milliseconds SURF_TILE_TIME(133);
+//  The longest tap measured to only turn a player facing another way, and
+//  to take exactly one step for one facing its way.
+inline constexpr Milliseconds LONGEST_TAP(133);
+//  A step tap that starts sooner than this after the previous step tap
+//  started is ignored. Measured between 566ms (66ms taps 500ms apart: the
+//  2nd of 3 ignored, 3 of 3 times) and 666ms (600 to 900ms apart: 8 of 8
+//  worked).
+inline constexpr Milliseconds STEP_TAP_LOCKOUT(620);
+//  The shortest step tap spacing, start to start, measured to work.
+inline constexpr Milliseconds STEP_TAP_SPACING_WORKED(666);
+//  After a battle's black ends, the overworld fades in and the game ignores
+//  the D-pad this long. Not measured: pokefirered's fade from black is 16
+//  frames, then the field takes input; a tap sent at once was lost.
+inline constexpr Milliseconds BATTLE_EXIT_LOCKOUT(500);
+
+
+//  The walker's presses.
+
+//  Turns a player facing another way, without a step.
+inline constexpr Milliseconds TURN_TAP(40);
+//  How long to wait after a turn tap for the turn to show.
+inline constexpr Milliseconds TURN_SETTLE(300);
+//  How many taps turn_to() tries before it takes the player as turned.
+inline constexpr size_t MAX_TURN_TAPS = 3;
+//  Turns the player to face something, short enough not to step.
+inline constexpr Milliseconds FACE_HOLD(40);
+//  The turn animation, before an A press reaches what is ahead.
+inline constexpr Milliseconds FACE_SETTLE(300);
+//  The release between a leg's hold and what comes next.
+inline constexpr Milliseconds STEP_RELEASE(100);
+//  A one-step tap (step_once()).
+inline constexpr Milliseconds STEP_TAP(66);
+//  The release after a step tap: the next one starts STEP_TAP +
+//  STEP_TAP_RELEASE after it, past the lockout.
+inline constexpr Milliseconds STEP_TAP_RELEASE(700);
+
+//  How long the overworld must show nothing (no box, fade or battle) after
+//  a battle before the next tap: twice the lockout.
+inline constexpr Milliseconds AFTER_BATTLE_QUIET(1000);
+
+static_assert(TURN_TAP <= LONGEST_TAP && FACE_HOLD <= LONGEST_TAP && STEP_TAP <= LONGEST_TAP);
+static_assert(STEP_TAP + STEP_TAP_RELEASE > STEP_TAP_SPACING_WORKED);
+static_assert(STEP_TAP_SPACING_WORKED > STEP_TAP_LOCKOUT);
+static_assert(AFTER_BATTLE_QUIET > BATTLE_EXIT_LOCKOUT);
+
+
+} // namespace MovementMechanics
+} // namespace PokemonFRLG
+} // namespace NintendoSwitch
+} // namespace PokemonAutomation
+#endif

SerialPrograms/Source/VideoGames/PokemonFRLG/Overworld/PokemonFRLG_OverworldMaps.cpp

@@ -78,6 +78,19 @@ const char* const MAP_NAMES[] = {
     "Route9",
     "Route10",
     "Route10_PokemonCenter_1F",
+    //  Rock Tunnel to Lavender Town's Pokemon Center.
+    "RockTunnel_1F",
+    "RockTunnel_B1F",
+    "LavenderTown",
+    "LavenderTown_PokemonCenter_1F",
+    //  West from Lavender: Route 8, the Underground Path under Saffron and
+    //  Route 7 to Celadon City.
+    "Route8",
+    "UndergroundPath_EastEntrance",
+    "UndergroundPath_EastWestTunnel",
+    "UndergroundPath_WestEntrance",
+    "Route7",
+    "CeladonCity",
     "CeruleanCave_1F",
     "CeruleanCave_2F",
     "CeruleanCave_B1F",