Compare commits

...

11 Commits

Author SHA1 Message Date
bryanthaboi 9de4db8531 Merge pull request #882 from bryanthaboi/dev 2026-08-06 05:17:04 -04:00
bryanthaboi 1d77d42fe2 Merge pull request #881 from AverageConsumer/codex/upstream-screen-render-visible
Mod API: allow active screen states to be hidden from the main render
2026-08-05 17:13:14 -04:00
github-actions 683fee8028 chore(ios): update app-repo.json [skip ci] 2026-08-05 16:49:41 -04:00
bryanthaboi a83d18fc51 Merge pull request #879 from bryanthaboi/dev
CLOSES #604, CLOSES #666, CLOSES #716, CLOSES #727, CLOSES #763, CLOS…
2026-08-05 16:42:56 -04:00
AverageConsumer b9e8b00af0 feat(mods): add screen render visibility hook 2026-08-05 22:42:37 +02:00
bryanthaboi e2820e02c5 CLOSES #604, CLOSES #666, CLOSES #716, CLOSES #727, CLOSES #763, CLOSES #781, CLOSES #784, CLOSES #799, CLOSES #801, CLOSES #810, CLOSES #828, CLOSES #834, CLOSES #838, CLOSES #849, CLOSES #852, CLOSES #857, CLOSES #863, CLOSES #864, CLOSES #867, CLOSES #869, CLOSES #870, CLOSES #872, CLOSES #839 2026-08-05 16:36:37 -04:00
github-actions 9696c8d3e2 chore(ios): update app-repo.json [skip ci] 2026-08-05 14:59:49 -04:00
bryanthaboi 18b2bcd0a7 Merge pull request #873 from bryanthaboi/dev
bug fixes
2026-08-05 14:53:57 -04:00
bryanthaboi f56970350a Merge branch 'dev' of https://github.com/bryanthaboi/gen1recomp into dev
# Conflicts:
#	data/scripts/story4.lua
#	src/ui/DexEntryMenu.lua
#	tests/drivers/fighting_dojo_bug197_test.lua
2026-08-05 14:43:05 -04:00
bryanthaboi 863f371e68 CLOSES #806, CLOSES #809, CLOSES #853, CLOSES #854, CLOSES #860, CLOSES #862, CLOSES #865, CLOSES #866 2026-08-05 14:38:10 -04:00
github-actions 7def560726 chore(ios): update app-repo.json [skip ci] 2026-08-05 12:08:35 -04:00
59 changed files with 5935 additions and 118 deletions
+6 -2
View File
@@ -16,9 +16,13 @@ local function push(game, s, done)
game.stack:push(TextBox.new(game, s, done))
end
-- PrintText on a text_end string returns with the box still drawn and
-- YesNoChoice then draws the menu above it (InitYesNoTextBoxParameters,
-- engine/menus/text_box.asm); no A press clears the question first. Ride
-- TextBox's opts.choice, the same as Commands.ask (#854).
local function ask(game, s, cb)
local ChoiceBox = require("src.ui.ChoiceBox")
push(game, s, function() game.stack:push(ChoiceBox.new(game, cb)) end)
local TextBox = require("src.render.TextBox")
game.stack:push(TextBox.new(game, s, nil, { choice = cb }))
end
M.PEWTER_CITY = {
+6 -2
View File
@@ -23,9 +23,13 @@ local function push(game, s, done)
game.stack:push(TextBox.new(game, s, done))
end
-- PrintText on a text_end string returns with the box still drawn and
-- YesNoChoice then draws the menu above it (InitYesNoTextBoxParameters,
-- engine/menus/text_box.asm); no A press clears the question first. Ride
-- TextBox's opts.choice, the same as Commands.ask (#854).
local function ask(game, s, cb)
local ChoiceBox = require("src.ui.ChoiceBox")
push(game, s, function() game.stack:push(ChoiceBox.new(game, cb)) end)
local TextBox = require("src.render.TextBox")
game.stack:push(TextBox.new(game, s, nil, { choice = cb }))
end
M.VIRIDIAN_CITY = {
+29 -18
View File
@@ -800,9 +800,13 @@ M.SILPH_CO_11F = {
-- line) would touch, and the whole Silph ending -- the flag, the Master
-- Ball, the Saffron streets clearing -- silently never happened.
--
-- engageTrainer shows TEXT_SILPHCO11F_GIOVANNI as the battle text and,
-- via victories.lua OPP_GIOVANNI#2, sets the event on a win; a loss
-- sets nothing, so the trigger re-arms exactly as vanilla does.
-- SilphCo11FDefaultScript orders it DisplayTextID TEXT_SILPHCO11F_GIOVANNI
-- FIRST, then MoveSprite .GiovanniMovement: he speaks from behind the desk
-- and only then walks the three tiles down. Moving him before the box made
-- him cross the room in silence and deliver the speech point-blank (#869),
-- so the box comes first here and engageTrainer skips its own battle text.
-- victories.lua OPP_GIOVANNI#2 sets the event on a win; a loss sets
-- nothing, so the trigger re-arms exactly as vanilla does.
onStep = function(game, ow, x, y)
if game.save.flags.EVENT_BEAT_SILPH_CO_GIOVANNI then return false end
if not ((x == 6 and y == 13) or (x == 7 and y == 12)) then return false end
@@ -811,21 +815,28 @@ M.SILPH_CO_11F = {
if npc.def and npc.def.name == "SILPHCO11F_GIOVANNI" then gio = npc break end
end
if not gio or ow:trainerDefeated(gio) then return false end
ow:scriptMove(gio, "down", 3, function()
gio:facePlayer(ow.player)
ow:engageTrainer(gio, function()
-- SilphCo11FGiovanniAfterBattleScript: the "Blast it all!" speech,
-- then SilphCo11FTeamRocketLeavesScript behind a fade so every Silph
-- rocket leaves off-screen (the street rockets are handled by
-- M.SAFFRON_CITY.onEnter in story4.lua). Queued, not run here: the
-- battle's own callbacks are still unwinding, so queueScript starts
-- it on the first idle overworld frame -- after the end-battle
-- "Arrgh!!" box victories.lua OPP_GIOVANNI#2 pushes (#722).
if game.save.flags.EVENT_BEAT_SILPH_CO_GIOVANNI then
ow:queueScript(silphAftermathRows())
end
end)
end)
local TextBox = require("src.render.TextBox")
game.stack:push(TextBox.new(game,
game.data.text._SilphCo11FGiovanniText
or "Ah {PLAYER}!\nSo we meet again!",
function()
ow:scriptMove(gio, "down", 3, function()
gio:facePlayer(ow.player)
ow:engageTrainer(gio, function()
-- SilphCo11FGiovanniAfterBattleScript: the "Blast it all!"
-- speech, then SilphCo11FTeamRocketLeavesScript behind a fade so
-- every Silph rocket leaves off-screen (the street rockets are
-- handled by M.SAFFRON_CITY.onEnter in story4.lua). Queued, not
-- run here: the battle's own callbacks are still unwinding, so
-- queueScript starts it on the first idle overworld frame --
-- after the end-battle "Arrgh!!" box victories.lua OPP_GIOVANNI#2
-- pushes (#722).
if game.save.flags.EVENT_BEAT_SILPH_CO_GIOVANNI then
ow:queueScript(silphAftermathRows())
end
end, nil, true)
end)
end))
return true
end,
onEnter = function(game, ow)
+66 -15
View File
@@ -151,9 +151,27 @@ M.POKEMON_TOWER_6F = {
-- trick, and the speedrun route this bot follows depends on it.
if result == "win" or battle.pokeDollEscape then
game.save.flags.EVENT_BEAT_GHOST_MAROWAK = true
game.stack:push(TextBox.new(game,
t._PokemonTower6FSoulWasCalmedText
or "The mother's soul\nwas calmed.\012It departed to\nthe afterlife!"))
-- PokemonTower6FMarowakDepartedText (scripts/PokemonTower6F.asm)
-- is two texts, not one: the CUBONE's-mother line first, then
-- PlayCry RESTLESS_SOUL (EQU MAROWAK, constants/pokemon_constants
-- .asm:209) + WaitForSoundToFinish + DelayFrames 30 before the
-- calmed line; the port dropped the first text and the cry
-- (#867). play_cry arms the next show_text, so the cry rides
-- the calmed box's open with the button prompt kept, and the
-- wait row stands in for the asm's 30-frame gap.
local rows = {
{ "show_text", t._PokemonTower6FGhostWasCubonesMotherText
or "The GHOST was the\nrestless soul of\vCUBONE's mother!" },
{ "play_cry", "MAROWAK", true },
{ "wait", 30 },
{ "show_text", t._PokemonTower6FSoulWasCalmedText
or "The mother's soul\nwas calmed.\012It departed to\nthe afterlife!" },
}
if ow.runner then
ow.runner:run(rows)
elseif ow.queueScript then
ow:queueScript(rows)
end
elseif result ~= "lose" then
-- .did_not_defeat: one simulated step right, off the trigger,
-- so fleeing does not leave you standing on a cell that
@@ -517,6 +535,14 @@ M.GAME_CORNER = {
done()
return
end
-- GameCornerRocketText hands the battle its own loss line through
-- SaveEndBattleTextPointers (.BattleEndText ->
-- _GameCornerRocketBattleEndText, "Dang!"), and PrintEndBattleText
-- prints it ON the battle screen between TrainerDefeatedText and
-- MoneyForWinningText (engine/battle/core.asm TrainerBattleVictory).
-- He is a text_asm trainer with no def_trainers header, so there is no
-- header.won for engageTrainer to find and the line has to be handed
-- over here or it never shows at all (#862).
ow:engageTrainer(npc, function()
if not ow:trainerDefeated(npc) then
done()
@@ -527,19 +553,44 @@ M.GAME_CORNER = {
game.data.text._GameCornerRocketAfterBattleText
or "Our hideout might\nbe discovered! I\nbetter tell BOSS!",
function()
-- #198: GameCornerRocketExitScript (scripts/GameCorner.asm)
-- ApplyMovementData walks the grunt one tile UP into the poster
-- (the hideout's secret entrance at 9,4) before HideObject, so
-- he leaves the floor rather than popping out of existence on
-- (9,5). scriptMove locks player input (#scriptMoves>0) and
-- ignores collision, so we despawn + unfreeze (done) only once
-- the step lands.
ow:scriptMove(npc, "up", 1, function()
hideRocket()
done()
end)
-- #198/#862: GameCornerRocketBattleScript (scripts/GameCorner.asm)
-- picks the exit walk from where the player is standing, because
-- the grunt on (9,5) has to get past him: wYCoord == 6 (talked to
-- from the south) or wXCoord == 8 (from the west) leaves the row
-- clear and takes GameCornerMovement_Rocket_WalkDirect, five steps
-- RIGHT; otherwise the player is east of him on (10,5) and
-- GameCornerMovement_Rocket_WalkAroundPlayer steps DOWN, right, UP
-- and right again to go AROUND him. pokeyellow's copy of the
-- around-path takes one extra RIGHT on the lower row before coming
-- back up (it also has to clear Pikachu); both versions end on
-- (15,5). He never steps UP: (9,4) is the poster wall, which is
-- where the old single UP step sent him.
local px = ow.player and ow.player.cellX
local py = ow.player and ow.player.cellY
local path
if py == 6 or px == 8 then
path = { { "right", 5 } }
elseif require("src.core.GameVersion").isYellow() then
path = { { "down", 1 }, { "right", 3 }, { "up", 1 }, { "right", 3 } }
else
path = { { "down", 1 }, { "right", 2 }, { "up", 1 }, { "right", 4 } }
end
-- GameCornerRocketExitScript only HideObjects him once
-- BIT_SCRIPTED_NPC_MOVEMENT clears, i.e. after the last step.
-- scriptMove locks player input (#scriptMoves>0) and ignores
-- collision, so the despawn + unfreeze (done) ride the final step.
local function step(i)
if i > #path then
hideRocket()
done()
return
end
ow:scriptMove(npc, path[i][1], path[i][2],
function() step(i + 1) end)
end
step(1)
end))
end)
end, game.data.text._GameCornerRocketBattleEndText or "Dang!")
end,
-- GameCornerClerk1Text (scripts/GameCorner.asm): the offer, a
-- YesNoChoice, then ¥1000 for 50 coins. Yellow drops the "1" from the
+11 -2
View File
@@ -13,9 +13,18 @@ local function push(game, s, done)
game.stack:push(TextBox.new(game, s, done))
end
-- The question stays on screen under the YES/NO menu. The dojo prize
-- balls are the clearest case: FightingDojoHitmonleePokeBallText
-- (scripts/FightingDojo.asm) is `call PrintText` on a text_end string --
-- no prompt, so no WaitForTextScrollButtonPress -- immediately followed
-- by `call YesNoChoice`, and InitYesNoTextBoxParameters
-- (engine/menus/text_box.asm) puts the menu above the dialogue box
-- rather than replacing it. Ride TextBox's opts.choice, the same as
-- Commands.ask, instead of popping the box with an A press and leaving a
-- bare ChoiceBox over the overworld (#854).
local function ask(game, s, cb)
local ChoiceBox = require("src.ui.ChoiceBox")
push(game, s, function() game.stack:push(ChoiceBox.new(game, cb)) end)
local TextBox = require("src.render.TextBox")
game.stack:push(TextBox.new(game, s, nil, { choice = cb }))
end
-- fill the extracted text placeholders ({NUM:...}, {RAM:...}, {PLAYER})
+6 -2
View File
@@ -12,9 +12,13 @@ local function push(game, s, done)
game.stack:push(TextBox.new(game, s, done))
end
-- PrintText on a text_end string returns with the box still drawn and
-- YesNoChoice then draws the menu above it (InitYesNoTextBoxParameters,
-- engine/menus/text_box.asm); no A press clears the question first. Ride
-- TextBox's opts.choice, the same as Commands.ask (#854).
local function ask(game, s, cb)
local ChoiceBox = require("src.ui.ChoiceBox")
push(game, s, function() game.stack:push(ChoiceBox.new(game, cb)) end)
local TextBox = require("src.render.TextBox")
game.stack:push(TextBox.new(game, s, nil, { choice = cb }))
end
-- -------------------------------------------------------------------
+45 -12
View File
@@ -62,10 +62,15 @@ M.MT_MOON_B2F = {
{ "walk_npc", 6, { "left", "left", "left", "left", "left" } },
{ "face_object", 6, "left" },
{ "show_text", "_MtMoonJessieJamesText2" },
-- MtMoonB2FScript12 arms _MtMoonJessieJamesText3 with
-- SaveEndBattleTextPointers before it sets wCurOpponent, so
-- TrainerBattleVictory prints it on the battle screen as "ROCKET: A
-- brat beat us?" between TrainerDefeatedText and MoneyForWinningText.
-- Its one-word first line only reads right behind that tag (#866).
{ "save_end_battle_text", "_MtMoonJessieJamesText3" },
{ "start_battle", "trainer", "OPP_ROCKET", 42 },
{ "check_battle_result", "win" },
{ "jump_if_false", "end" },
{ "show_text", "_MtMoonJessieJamesText3" },
{ "show_text", "_MtMoonJessieJamesText4" },
{ "stop_music" },
{ "play_music", "Music_MeetJessieJames" },
@@ -85,7 +90,8 @@ M.MT_MOON_B2F = {
-- motto plays from off-screen FIRST, then the duo pops in at (25,10) /
-- (24,10) and whichever of them shares the player's column ($18=24 or
-- $19=25, EVENT_ROCKET_HIDEOUT_4_JESSIE_JAMES_ON_LEFT) walks the three
-- tiles down to loom over the player while the other steps one. A loss
-- tiles down to loom over the player while the other walks four and ends
-- up beside him. A loss
-- re-hides them (RocketHideoutB4FResetScripts via EVENT_6A0), so the
-- trigger re-arms clean.
-- -------------------------------------------------------------------
@@ -106,7 +112,7 @@ M.ROCKET_HIDEOUT_B4F = {
if f.EVENT_BEAT_ROCKET_HIDEOUT_4_JESSIE_JAMES then return false end
-- ON_LEFT: player under James's column (25); movement data pairs
-- RocketHideoutB4FJessieJamesMovementData_45605/45606 swap so the
-- column-mate walks 3, the other 1.
-- column-mate walks 3, the other 4.
local onLeft = (x == 25)
ow.runner:run({
{ "stop_music" },
@@ -116,16 +122,30 @@ M.ROCKET_HIDEOUT_B4F = {
{ "emote", "player", "shock", 30 },
{ "show_object", "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_JAMES" },
{ "show_object", "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_JESSIE" },
-- James (object 2) then Jessie (object 3), Script4..Script9 order
{ "walk_npc", 2, onLeft and { "down", "down", "down" } or { "down" } },
-- James (object 2) then Jessie (object 3), Script4..Script9 order.
-- RocketHideoutB4FJessieJamesMovementData_45605 is a lone $4 that FALLS
-- THROUGH into _45606 ($4 $4 $4 $ff), so MoveSprite_ (home/pathfinding.asm)
-- reads _45605 as FOUR steps and _45606 as three; $4 is DOWN in Yellow's
-- Func_5288 lookup (engine/overworld/movement.asm), which walks with no
-- collision test. From (25,10)/(24,10) against a player on y=14 the
-- column-mate stops three down, right above him, and the other walks the
-- full four to stand alongside -- which is what the facings below assume.
-- Reading _45605 as a single step stranded whoever was off-column three
-- tiles away, so James never reached the player (#865).
{ "walk_npc", 2, onLeft and { "down", "down", "down" }
or { "down", "down", "down", "down" } },
{ "face_object", 2, onLeft and "down" or "left" },
{ "walk_npc", 3, onLeft and { "down" } or { "down", "down", "down" } },
{ "walk_npc", 3, onLeft and { "down", "down", "down", "down" }
or { "down", "down", "down" } },
{ "face_object", 3, onLeft and "right" or "down" },
{ "show_text", "_RocketHideoutJessieJamesText2" },
-- RocketHideoutB4FScript10 saves _RocketHideoutJessieJamesText3 as the
-- end-battle text, so it prints as "ROCKET: Such a dreadful twerp!" on
-- the battle screen ahead of MoneyForWinningText (#866).
{ "save_end_battle_text", "_RocketHideoutJessieJamesText3" },
{ "start_battle", "trainer", "OPP_ROCKET", 43 },
{ "check_battle_result", "win" },
{ "jump_if_false", "lost" },
{ "show_text", "_RocketHideoutJessieJamesText3" },
{ "show_text", "_RocketHideoutJessieJamesText4" },
{ "stop_music" },
{ "play_music", "Music_MeetJessieJames" },
@@ -175,16 +195,27 @@ M.POKEMON_TOWER_7F = {
{ "show_text", "_PokemonTowerJessieJamesText1" },
{ "face_player_dir", "up" },
{ "emote", "player", "shock", 30 },
-- Jessie (object 1) then James (object 2), Script1..Script6 order
{ "walk_npc", 1, onLeft and { "down" } or { "down", "down", "down" } },
-- Jessie (object 1) then James (object 2), Script1..Script6 order.
-- Same fall-through blob as the hideout: PokemonTower7FMovementData_60d7a
-- is a lone $4 running into _60d7b ($4 $4 $4 $FF), so _60d7a is FOUR
-- steps and _60d7b is three. From (10,8)/(11,8) against a player on
-- y=12 the column-mate halts one tile above him and the other closes the
-- full four to his side; the single-step reading is why James only
-- "moved a bit" here (#865).
{ "walk_npc", 1, onLeft and { "down", "down", "down", "down" }
or { "down", "down", "down" } },
{ "face_object", 1, onLeft and "right" or "down" },
{ "walk_npc", 2, onLeft and { "down", "down", "down" } or { "down" } },
{ "walk_npc", 2, onLeft and { "down", "down", "down" }
or { "down", "down", "down", "down" } },
{ "face_object", 2, onLeft and "down" or "left" },
{ "show_text", "_PokemonTowerJessieJamesText2" },
-- PokemonTower7FScript7 saves _PokemonTowerJessieJamesText3 as the
-- end-battle text: "ROCKET: You will regret this!" on the battle screen,
-- before the prize money (#866).
{ "save_end_battle_text", "_PokemonTowerJessieJamesText3" },
{ "start_battle", "trainer", "OPP_ROCKET", 44 },
{ "check_battle_result", "win" },
{ "jump_if_false", "end" },
{ "show_text", "_PokemonTowerJessieJamesText3" },
{ "show_text", "_PokemonTowerJessieJamesText4" },
{ "stop_music" },
{ "play_music", "Music_MeetJessieJames" },
@@ -254,10 +285,12 @@ M.SILPH_CO_11F = {
{ "walk_npc", 6, jessieDirs },
{ "face_object", 6, jessieFace },
{ "show_text", "_SilphCoJessieJamesText2" },
-- SilphCo11FScript11 saves _SilphCoJessieJamesText3 (SilphCo11FText_624c2)
-- as the end-battle text: "ROCKET: Like always..." before the money (#866).
{ "save_end_battle_text", "_SilphCoJessieJamesText3" },
{ "start_battle", "trainer", "OPP_ROCKET", 45 },
{ "check_battle_result", "win" },
{ "jump_if_false", "end" },
{ "show_text", "_SilphCoJessieJamesText3" },
{ "show_text", "_SilphCoJessieJamesText4" },
{ "stop_music" },
{ "play_music", "Music_MeetJessieJames" },
+7
View File
@@ -226,5 +226,12 @@ for driving a second physical display. This is what lets a mod lay the two
passes out as two stacked Game Boy screens, or push one onto a second screen,
without the engine knowing the layout.
`screen.render_visible` receives `(next, state)` while the main screen is being
composed. Return `false` to omit that state from drawing, opacity selection and
palette-zone ownership. The state remains on the stack and keeps its normal
update and input ownership, so a mod can mirror a native menu on another
display without reimplementing it. The default is `true`. Treat the wrapper as
a pure predicate: the renderer may ask it more than once per frame.
Developer mode also arms the mod loader's dev tripwire, which flags mods
that reach outside their permission set.
+25
View File
@@ -332,6 +332,26 @@ one used sideways. An `options.lua` from before this split keeps its single
layout in both orientations until one of them is edited. In-game, Options →
**TOUCH PAD** toggles the same on/off flag without leaving a play session.
## Haptic feedback (mobile)
Options → **VIBRATION** (also in the launcher's gear menu) buzzes the device
the instant an on-screen control takes a button (#806). A glass pad has no
edges under a thumb, so the pulse is what tells you the press landed:
sliding the d-pad from one direction to the next buzzes again, a second
finger landing on a button that is already held does not, and releasing
never does.
Four levels: **OFF**, **LIGHT** (the default), **MEDIUM**, **HEAVY**.
"Intensity" is really a pulse length -- the platform call takes a duration
and nothing else -- so LIGHT is a 12 ms tick, MEDIUM 25 ms, HEAVY 45 ms.
Stepping the row fires one sample pulse at the level you land on, so the
three can be compared without leaving the menu. On iOS the system
vibration has one fixed length, so all three levels feel the same there and
the row is effectively on/off. The setting lives in `options.lua` and the
row only appears where the on-screen pad can (Android/iOS, or desktop with
`POKEPORT_TOUCH=1`, where it does nothing since desktop LOVE has no
vibrator).
## Screen orientation lock (Android)
Options → **ORIENTATION** (also in the launcher's gear menu) locks the
@@ -585,6 +605,11 @@ settings gear and pulses when an update is waiting, instead of sitting in a
banner at the bottom of the page that you had to scroll to notice. Checking
for updates from there shows a loader like everything else.
**A quit button.** An X sits to the right of the settings gear and closes
the app cleanly, the same shutdown path as the window's close button. Mostly
for platforms where reaching the window chrome is awkward (Android, Steam
Deck, fullscreen desktops).
**The look.** Black background, white outlines, no gradients or glows, and
buttons that are solid colour-coded keys: green commits, blue navigates, red
destroys, yellow wants attention. The three game tabs keep their red, blue
+54
View File
@@ -0,0 +1,54 @@
# RFC 0002 — Let mods hide an active screen state from the main render
## Status
Proposed. Engine: `StateStack.lua`, `Game.lua`. Tests:
`screen_render_visible.lua`.
## Motivation
A mod can render a native menu on a companion display through
`render.compose`, but it cannot remove that menu from the main display without
also popping it. Popping transfers update and input ownership and forces the
mod to reimplement native menu behavior.
## The decision it extends
No prior D-number. Extends the render-hook plan in `docs/modding.md` and the
state-stack rendering contract in `docs/architecture.md`.
## The exact API delta
Backward-compatible, additive-only.
### `screen.render_visible`
New hook called with `(state) -> boolean` through the public wrapper signature
`(next, state)`. Its vanilla result is `true`.
Returning `false` excludes the state from the main draw, from opaque-base
selection and from palette-zone ownership. It does not remove the state or
change update, input, push or pop behavior. The call sites are
`StateStack:visibleBase`, `StateStack:draw` and the equivalent draw and palette
walks in `Game:draw`.
The hook is guarded by `Runtime.wantsHook`, so the no-subscriber path allocates
nothing. It is a pure render predicate and may be evaluated more than once per
frame.
## Migration note for existing mods
**Nothing.** With no subscriber every state remains visible, and the existing
state-stack, event and hook behavior is unchanged.
## Parity tests
- **No-mod:** the topmost opaque state still owns drawing and palette zones,
and `Runtime.wantsHook("screen.render_visible")` stays false.
- **Mod-API:** a fixture mod registers through `mod.hooks:wrap`, hides one
opaque state and proves the state beneath draws and owns the palette while
the hidden state remains topmost and continues updating.
## Deprecation etiquette
Nothing deprecated. This is one additive hook with a `true` vanilla default.
+34 -1
View File
@@ -667,7 +667,33 @@ function love.wheelmoved(x, y)
Game:wheelmoved(x, y)
end
-- #781: Linux X11 multi-monitor with the primary display away from desktop
-- (0,0): SDL's polled mouse state can come back in desktop-virtual
-- coordinates while the event stream stays window-relative, which strands
-- every polled consumer (launcher Kit rising-edge clicks, the pad-cursor
-- motion yield, PadCursor) on coordinates no hit test can match. Sanitize
-- the poll once here: remember the last window-relative event coordinates
-- and substitute them whenever the polled value falls outside the window.
-- Linux only -- macOS / Windows / mobile keep the stock function, and the
-- NX launcher shim still composes because it captures whatever
-- love.mouse.getPosition is at bridge time (_ensureNxPointerBridge).
local eventMouseX, eventMouseY
if love.system and love.system.getOS() == "Linux"
and love.mouse and love.mouse.getPosition then
local polledGetPosition = love.mouse.getPosition
love.mouse.getPosition = function()
local x, y = polledGetPosition()
local w, h = love.graphics.getDimensions()
if x < 0 or y < 0 or x > w or y > h then
if eventMouseX then return eventMouseX, eventMouseY end
return math.max(0, math.min(x, w)), math.max(0, math.min(y, h))
end
return x, y
end
end
function love.mousepressed(x, y, button, istouch)
if not istouch then eventMouseX, eventMouseY = x, y end
if TouchEditor then
-- Android primary touch already arrived via love.touchpressed; a second
-- mouse path would double-fire Done / begin a second drag.
@@ -720,6 +746,7 @@ function love.mousereleased(x, y, button, istouch)
end
function love.mousemoved(x, y, dx, dy, istouch)
if not istouch then eventMouseX, eventMouseY = x, y end
if TouchEditor then
if love.system.getOS() == "Android" then return end
return TouchEditor.mousemoved(x, y)
@@ -748,7 +775,13 @@ local quitToLauncher = false
function love.quit()
if editorMode and EditorApp.quit then
return EditorApp.quit() -- return true to abort quit
-- true blocks the quit (unsaved-changes prompt). A quit that proceeds
-- must fall through to the worker shutdowns below instead of returning:
-- the bundled editor opens from a live launcher whose update-check and
-- fetch-pool workers are still parked in Channel:demand(), and returning
-- here skipped their "quit" push, so the process outlived the closed
-- window and kept the install folder locked on Windows (#727).
if EditorApp.quit() then return true end
end
-- Closing the window of a running game returns to the launcher instead of
-- exiting the app, so testing a mod does not need a relaunch every time
@@ -37,6 +37,13 @@
#include "filesystem/physfs/PhysfsIo.h"
// #604 / #839: the SAF bridges below must hand GameActivity the exact
// directory physfs mounted as the save dir -- the same contract the iOS
// GRPickerBridge already gets (mobile/ios/patch_love_src.py,
// gr_saveDirectory) -- instead of letting Java recompute the root on its
// own, which can name a different volume on merged / adopted-SD storage.
#include "filesystem/Filesystem.h"
namespace love
{
namespace android
@@ -183,6 +190,19 @@ void vibrate(double seconds)
env->DeleteLocalRef(activity);
}
// The directory physfs actually mounted as the save dir, or "" before the
// filesystem module is up. GameActivity must copy SAF picks HERE: its own
// getExternalFilesDir(null) recomputation can disagree with the mounted
// root on merged / adopted-SD storage (#604, #839).
static const char *bridgeSaveDirectory()
{
auto fs = Module::getInstance<love::filesystem::Filesystem>(Module::M_FILESYSTEM);
if (fs == nullptr)
return "";
const char *dir = fs->getSaveDirectory();
return dir != nullptr ? dir : "";
}
bool showFilePicker(const char *destFilename)
{
if (destFilename == nullptr || destFilename[0] == '\0')
@@ -192,9 +212,11 @@ bool showFilePicker(const char *destFilename)
jclass activity = env->FindClass("org/love2d/android/GameActivity");
jmethodID method = env->GetStaticMethodID(activity, "showFilePicker",
"(Ljava/lang/String;)Z");
"(Ljava/lang/String;Ljava/lang/String;)Z");
jstring jname = env->NewStringUTF(destFilename);
jboolean result = env->CallStaticBooleanMethod(activity, method, jname);
jstring jsavedir = env->NewStringUTF(bridgeSaveDirectory());
jboolean result = env->CallStaticBooleanMethod(activity, method, jname, jsavedir);
env->DeleteLocalRef(jsavedir);
env->DeleteLocalRef(jname);
env->DeleteLocalRef(activity);
@@ -210,9 +232,11 @@ bool showCreateDocument(const char *suggestedName)
jclass activity = env->FindClass("org/love2d/android/GameActivity");
jmethodID method = env->GetStaticMethodID(activity, "showCreateDocument",
"(Ljava/lang/String;)Z");
"(Ljava/lang/String;Ljava/lang/String;)Z");
jstring jname = env->NewStringUTF(suggestedName);
jboolean result = env->CallStaticBooleanMethod(activity, method, jname);
jstring jsavedir = env->NewStringUTF(bridgeSaveDirectory());
jboolean result = env->CallStaticBooleanMethod(activity, method, jname, jsavedir);
env->DeleteLocalRef(jsavedir);
env->DeleteLocalRef(jname);
env->DeleteLocalRef(activity);
@@ -116,6 +116,18 @@ public class GameActivity extends SDLActivity {
// bad ROM instead of installing it (#553).
private String pendingPickFilename = PICKED_ROM_FILENAME;
private static final String STATE_PENDING_PICK = "pendingPickFilename";
// Absolute save directory physfs actually mounted, as reported by the
// native bridge call that opened the picker (love/src/common/android.cpp,
// bridgeSaveDirectory). This activity used to recompute
// getExternalFilesDir(null)/save/<identity> on its own at result time; on
// merged / adopted-SD storage that can name a different volume than the
// one LOVE mounted, so the copied pick (and pick_error.flag) landed where
// Lua never scans -- the launcher then "did nothing" after a pick (#604)
// and the folders a file manager can browse stayed empty while the game
// saved fine elsewhere (#839). Empty string means "not told yet": fall
// back to the historical computation.
private String pendingPickSaveDir = "";
private static final String STATE_PENDING_PICK_DIR = "pendingPickSaveDir";
private static final String STATE_PENDING_CREATE = "pendingCreateSuggestedName";
// Suggested download name for the in-flight SAF create (set by showCreateDocument).
private String pendingCreateSuggestedName = "export.sav";
@@ -186,6 +198,8 @@ public class GameActivity extends SDLActivity {
// a recreated activity still lands under the basename it asked for.
String pick = savedInstanceState.getString(STATE_PENDING_PICK);
if (pick != null) pendingPickFilename = pick;
String pickDir = savedInstanceState.getString(STATE_PENDING_PICK_DIR);
if (pickDir != null) pendingPickSaveDir = pickDir;
String create = savedInstanceState.getString(STATE_PENDING_CREATE);
if (create != null) pendingCreateSuggestedName = create;
}
@@ -467,13 +481,23 @@ public class GameActivity extends SDLActivity {
* @param destFilename basename under the app save identity (e.g.
* picked_rom.gb, picked_mod.zip, picked_save.sav)
*/
/** Legacy single-argument entry; resolves the save dir itself. */
@Keep
public static boolean showFilePicker(String destFilename) {
return showFilePicker(destFilename, null);
}
@Keep
public static boolean showFilePicker(String destFilename, String saveDir) {
GameActivity self = (GameActivity) mSingleton;
if (self == null) return false;
if (destFilename == null || destFilename.length() == 0) {
destFilename = PICKED_ROM_FILENAME;
}
// Remember where LOVE's filesystem is really mounted so
// onActivityResult copies the pick there, not into a recomputed
// (possibly different-volume) root (#604, #839).
self.pendingPickSaveDir = (saveDir != null) ? saveDir : "";
// Reject path separators so a hostile JNI caller cannot escape the
// save identity directory.
if (destFilename.indexOf('/') >= 0 || destFilename.indexOf('\\') >= 0) {
@@ -644,8 +668,14 @@ public class GameActivity extends SDLActivity {
* return degrades on the Lua side (RomImporter export) to "Exported
* inside the app folder", which is the correct pre-KitKat behavior.
*/
/** Legacy single-argument entry; resolves the save dir itself. */
@Keep
public static boolean showCreateDocument(String suggestedName) {
return showCreateDocument(suggestedName, null);
}
@Keep
public static boolean showCreateDocument(String suggestedName, String saveDir) {
if (android.os.Build.VERSION.SDK_INT < 19) return false;
// (see showFilePicker for why the import side got a pre-19 path)
GameActivity self = (GameActivity) mSingleton;
@@ -657,9 +687,12 @@ public class GameActivity extends SDLActivity {
Log.d("GameActivity", "refusing unsafe create name: " + suggestedName);
return false;
}
File source = new File(
new File(self.getExternalFilesDir(null), "save"),
ROM_SAVE_IDENTITY + "/" + PENDING_EXPORT_FILENAME);
// Route through the mounted save dir (#604, #839): Lua staged
// pending_export.sav where physfs writes, which is not necessarily
// where a fresh getExternalFilesDir(null) points on merged /
// adopted-SD storage.
self.pendingPickSaveDir = (saveDir != null) ? saveDir : "";
File source = new File(self.saveIdentityDir(), PENDING_EXPORT_FILENAME);
if (!source.isFile()) {
Log.d("GameActivity", "no pending export at " + source);
return false;
@@ -680,7 +713,21 @@ public class GameActivity extends SDLActivity {
}
private File saveIdentityDir() {
return new File(new File(getExternalFilesDir(null), "save"), ROM_SAVE_IDENTITY);
// Prefer the mounted save dir the last bridge call reported: the
// recomputation below can name a different volume than the one LOVE
// mounted on merged / adopted-SD storage (#604, #839).
if (pendingPickSaveDir != null && pendingPickSaveDir.length() > 0) {
return new File(pendingPickSaveDir);
}
File ext = getExternalFilesDir(null);
if (ext == null) {
// Shared storage unavailable (ejected / mid-adoption): without
// this guard File(null, "save") silently built the RELATIVE
// path save/<identity>, mkdirs() failed against "/", and the
// pick was dropped with no message at all (#604).
ext = getFilesDir();
}
return new File(new File(ext, "save"), ROM_SAVE_IDENTITY);
}
/** Drops a small flag file in the save identity for Lua to consume on focus. */
@@ -875,6 +922,7 @@ public class GameActivity extends SDLActivity {
protected void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
outState.putString(STATE_PENDING_PICK, pendingPickFilename);
outState.putString(STATE_PENDING_PICK_DIR, pendingPickSaveDir);
outState.putString(STATE_PENDING_CREATE, pendingCreateSuggestedName);
}
+21
View File
@@ -12,6 +12,27 @@
"tintColor": "3b5ca8",
"category": "games",
"versions": [
{
"version": "0.1.72",
"date": "2026-08-05",
"size": 9586678,
"downloadURL": "https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.72/gen1recomp-0.1.72-ios.ipa",
"localizedDescription": "Download the correct version for your computer below.\n\n## Issues closed\n\n- #604 Android, retroid pocket 2+ Rom won't import\n- #666 Pikachu emotions are not working on Android\n- #716 Lock Auto Rotate Mobile\n- #727 [Bug] [Windows] Gen1 Recomp \"still in use\" after closing\n- #763 Some EVENTS are turned off\n- #781 Mouse cursor broken on Linux with multi-monitor X11 setup\n- #784 Leech Seed effect\n- #799 Held direction randomly stops player movement (requires re-input)\n- #801 Cannot update mods from the launcher (MacOS)\n- #810 Launcher menu cuts off in vertical mode iOS\n- #828 Closing the app causes settings in launcher to reset\n- #834 Mod import failing\n- #838 Exporting save file Pokemon Yellow\n- #839 AYN Thor Misplaced Data files\n- #849 Public folder support on iOS\n- #852 Cannot switch between saves states on smaller 4:3 screen or in vertical mode\n- #857 Mt. Moon Fossils Reappeared and Wont Disappear.\n- #863 [Yellow] When you use stairs, Pikachu shouldn't be next to you in the new area\n- #864 Faithful Ratio\n- #867 Missing Dialogue after defeating Marowak in Pokemon Tower\n- #869 Giovanni moves up to the player too early\n- #870 Start Menu on Classic Color\n- #872 Missing text when finding an item with full inventory\n\n## Contributors\n\n- @bryanthaboi"
},
{
"version": "0.1.71",
"date": "2026-08-05",
"size": 9569738,
"downloadURL": "https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.71/gen1recomp-0.1.71-ios.ipa",
"localizedDescription": "Download the correct version for your computer below.\n\n## Issues closed\n\n- #806 Haptic Feedback for On-screen controls (mobile)\n- #809 NPC Stuck in Rock when battle triggered and pushing rock towards it\n- #853 When selecting one of the two pokemon after defeating the Karate Master it should show the Pokedex entry\n- #854 Textbox disappears when the yes/no dialogue appears\n- #860 Disabled moves can still be used in the turn they were disabled\n- #862 Casino Poster Rocket Grunt walks into the poster and doesn't \"Dang!\"\n- #865 [Yellow] James doesn't move in multiple encounters\n- #866 [Yellow] Dialogue in wrong \"order\" after multiple encounters (J+J, Giovanni, probably more)\n\n## Contributors\n\n- @bryanthaboi"
},
{
"version": "0.1.70",
"date": "2026-08-05",
"size": 9562731,
"downloadURL": "https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.70/gen1recomp-0.1.70-ios.ipa",
"localizedDescription": "Download the correct version for your computer below.\n\n## Issues closed\n\n- #590 Launcher/Save Editor/Dex\n- #788 Fly to the Pokemon Centers in the Routes is not available in original\n- #795 Fly logic is drastically different from the originals.\n- #796 Using Rare Candy from the menu closes it out.\n- #797 Gym Leaders giving items when your bag is full / Bypassing bag limit.\n- #805 Escape Rope Moltres Tower\n- #826 \"Super effective\" and \"not very effective\" SFX are reversed\n- #833 Cancelling nickname entry results in \"A\" as the nickname\n- #835 Restarting the launcher forgets the last rom used\n- #837 Wrong sound effect for Pikachu when entering battle\n- #844 Blizzard sound effect.\n- #845 Moderate issue: Fuchsia City binoculars.\n- #846 Surfing speed after using the bicycle.\n- #847 Minor issues related to the endgame.\n\n## Contributors\n\n- @bryanthaboi\n- @dburton95\n- @johnjohto\n- @KikiManjaro"
},
{
"version": "0.1.69",
"date": "2026-08-04",
+15 -5
View File
@@ -3188,6 +3188,16 @@ function BattleState:executeAction(user, target, action)
user.boundTurns = target.trappingTurns
and math.max(1, target.trappingTurns) or nil
-- wPlayerSelectedMove / wEnemySelectedMove as the status gauntlet
-- reads it: the locked specials keep continuing the move they
-- started, so they carry a move id too. Resolved once here and
-- handed to every statusInterrupt below, which is where
-- .TriedToUseDisabledMoveCheck lives (#860).
local selectedId = action.id
or (action.special == "trapping" and user.trapMove)
or (action.special == "bide" and "BIDE")
or nil
-- trainer class AI actions (engine/battle/trainer_ai.asm)
if action.special == "aiItem" then
self.aiUses = (self.aiUses or 1) - 1
@@ -3245,17 +3255,17 @@ function BattleState:executeAction(user, target, action)
return
end
if action.special == "trapping" then
if self:statusInterrupt(user, target) then return end
if self:statusInterrupt(user, target, selectedId) then return end
self:continueTrapping(user, target)
return
end
if action.special == "bide" then
if self:statusInterrupt(user, target) then return end
if self:statusInterrupt(user, target, selectedId) then return end
self:continueBide(user, target)
return
end
if self:statusInterrupt(user, target) then return end
if self:statusInterrupt(user, target, selectedId) then return end
self:performMove(user, target, action, false)
end
run()
@@ -3349,8 +3359,8 @@ end
-- Runs Status.beforeMove plus the shared interruption bookkeeping;
-- returns true when the user's action is interrupted.
function BattleState:statusInterrupt(user, target)
local canMove, msgs, selfHit = Status.beforeMove(user, self.rng, self)
function BattleState:statusInterrupt(user, target, selectedId)
local canMove, msgs, selfHit = Status.beforeMove(user, self.rng, self, selectedId)
for _, m in ipairs(msgs) do self:sayStatusMsg(user, m) end
if selfHit then
-- confusion self-hit (core.asm:3428-3434): clears everything in
+23 -1
View File
@@ -168,7 +168,7 @@ end
-- The active status record's beforeMove runs at its priority slot: above
-- VOLATILE_PRIORITY before the held/disable/confusion block (sleep,
-- freeze), at or below after it (paralysis) -- the original's order.
function Status.beforeMove(battler, rng, battle)
function Status.beforeMove(battler, rng, battle, selectedMoveId)
local mon = battler.mon
-- Haze curing this mon's sleep/freeze forfeits its pending move for
-- the turn, silently (haze.asm writes $ff/CANNOT_MOVE to the selected
@@ -225,6 +225,28 @@ function Status.beforeMove(battler, rng, battle)
end
end
end
-- .TriedToUseDisabledMoveCheck (engine/battle/core.asm, and the enemy
-- copy .checkIfTriedToUseDisabledMove): the disabled-move test runs at
-- EXECUTION time, comparing wPlayerDisabledMoveNumber against the
-- already SELECTED move, so a Disable that lands earlier in the same
-- turn still blocks the slower mon's move (#860). It sits after the
-- confusion block and before the paralysis roll, so a confusion self-hit
-- still pre-empts it and the paralysis roll is never spent on a turn the
-- disable eats. PrintMoveIsDisabledText clears CHARGING_UP before
-- printing, so a disabled charge move drops its stored turn instead of
-- releasing later.
if selectedMoveId and battler.disabledSlot then
local disabled = (battler.curMoves or {})[battler.disabledSlot]
if disabled and disabled.id == selectedMoveId then
battler.charging, battler.chargeReady = nil, nil
local moves = battle and battle.data and battle.data.moves
local shown = moves and moves[selectedMoveId] and moves[selectedMoveId].name
or tostring(selectedMoveId)
table.insert(msgs, romText(battle and battle.data, "_MoveIsDisabledText",
"%s's\n%s is\ndisabled!", name(battler), shown))
return false, msgs
end
end
if handler then
local canMove, selfHit = runStatus()
if not canMove or selfHit then return canMove, msgs, selfHit end
+6 -2
View File
@@ -16,6 +16,10 @@ local Screens = require("src.ui.Screens")
local Game = {}
local function renderVisible(stack, state)
return state and (not stack.renderVisible or stack:renderVisible(state))
end
-- dev-mode gate for the F5/backtick hotkeys; false keeps every src/dev
-- module unloaded, so a player boot never touches a byte of dev code
local devMode = os.getenv("POKEPORT_DEV") == "1" or _G.POKEPORT_DEV_MODE == true
@@ -460,7 +464,7 @@ function Game:draw()
local state = self.stack.states[i]
local wideState = state and state.isWideBattleLayout
and state:isWideBattleLayout()
if state and state.draw then
if renderVisible(self.stack, state) and state.draw then
if classicOffset ~= 0 and not wideState then
love.graphics.push()
love.graphics.translate(classicOffset, 0)
@@ -484,7 +488,7 @@ function Game:draw()
local zones, worldZones, zoneOwner
for i = #self.stack.states, 1, -1 do
local s = self.stack.states[i]
if s.sgbPalettes then
if renderVisible(self.stack, s) and s.sgbPalettes then
zones = s:sgbPalettes(self)
zoneOwner = s
break
+18
View File
@@ -28,6 +28,24 @@ function SafeArea.rect()
return 0, 0, ww, wh
end
-- A safe rect that cannot fit the window's unit space is a backend
-- reporting framebuffer PIXELS -- the iOS build (LOVE 12 + SDL3) did this
-- in portrait on iOS 16, and clamping it as-is kept a DPI-inflated top
-- inset that pushed the whole launcher a band down the screen (#810).
-- Convert back to units with per-axis ratios; the axes can disagree on
-- forced-rotation devices (see displayMetrics in src/render/Renderer.lua,
-- #208).
if (w > ww + 0.5 or h > wh + 0.5)
and love.graphics.getPixelDimensions then
local pw, ph = love.graphics.getPixelDimensions()
local dx = (pw and pw > 0) and (pw / ww) or 1
local dy = (ph and ph > 0) and (ph / wh) or 1
if dx > 1.01 or dy > 1.01 then
x, w = x / dx, w / dx
y, h = y / dy, h / dy
end
end
-- Clamp to the drawable window so a bad / mid-rotation backend cannot
-- push layout outside the surface.
x = math.max(0, math.min(x, ww))
+65 -1
View File
@@ -30,6 +30,15 @@ local SaveData = {}
-- deliberately shared across versions (it holds global preferences and the
-- mod enable-state, not per-playthrough data).
local OPTIONS_FILENAME = "options.lua"
-- #828: options.lua is rewritten whole on every write (see saveOptions), and
-- unlike the progress files it had no staged copy, so a write interrupted
-- between the truncate and the flush -- the process replaced by
-- HostShell.restart on the way back to the launcher, an Android
-- external-storage volume that never flushed -- left a truncated or empty
-- file that loadOptions could only answer with defaults: every setting
-- "reset" at once. Same .bak/.tmp witness names the save files use.
local OPTIONS_BACKUP_FILENAME = OPTIONS_FILENAME .. ".bak"
local OPTIONS_TMP_FILENAME = OPTIONS_FILENAME .. ".tmp"
-- Main / backup / staged-witness names for a version (defaults to the active
-- one). The backup is a rolling copy and .tmp is the staged-write witness;
@@ -305,6 +314,13 @@ function SaveData.defaultOptions()
-- layout (#633). Pre-#633 files stored one top-level positions table;
-- TouchControls.normalizeConfig folds it into both orientations on load.
touchControls = { enabled = true },
-- Haptic feedback level for on-screen pad presses (#806):
-- off | light | medium | heavy, mapped to a love.system.vibrate
-- duration in src/core/TouchControls.lua. LIGHT by default, like the
-- overlay itself defaulting on, so an options.lua predating this key
-- gets the tick without going looking for the row. Inert wherever the
-- overlay never appears (desktop) or LOVE has no vibrator.
haptics = "light",
}
end
@@ -369,7 +385,21 @@ function SaveData.saveOptions(opts, fs)
opts.modOptions = merged
end
local encoded = SaveSerializer.encode(opts)
local ok, err = fs.write(OPTIONS_FILENAME, encoded)
-- Stage the new bytes and roll the last good file aside BEFORE the main
-- write truncates it, the same tmp/bak dance SaveData.save uses for
-- progress: whatever ends the process mid-write, one of the three copies
-- is complete and loadOptions promotes it instead of falling back to
-- defaults (#828).
local ok, err = fs.write(OPTIONS_TMP_FILENAME, encoded)
if not ok then
Logger.error("options save failed: %s", tostring(err))
return nil
end
local prev = fs.getInfo(OPTIONS_FILENAME) and fs.read(OPTIONS_FILENAME)
if type(prev) == "string" and prev ~= "" and prev ~= encoded then
fs.write(OPTIONS_BACKUP_FILENAME, prev)
end
ok, err = fs.write(OPTIONS_FILENAME, encoded)
if not ok then
Logger.error("options save failed: %s", tostring(err))
return nil
@@ -387,6 +417,20 @@ function SaveData.saveOptions(opts, fs)
#encoded, type(wrote) == "string" and tostring(#wrote) or "nothing")
return nil
end
-- #828: roll the backup FORWARD to the bytes just verified. The
-- pre-write roll above only preserves the previous file for a death
-- during this rewrite; at rest the backup must hold the newest verified
-- state, because the hard teardown out of a game session (HostShell's
-- restartApp kill on Android, execv on a SteamOS AppImage) can eat the
-- main file outright and loadOptions then promotes this copy. The
-- encoder is key-sorted, so the follow-up rewrites a play session makes
-- (play()'s lastVersion stamp, the in-game save flush) are byte-identical
-- and skip the conditional roll -- without this line the backup still
-- held the file from BEFORE the launcher's change, and recovery reverted
-- the just-changed setting (BATTLE LAYOUT back to OG).
fs.write(OPTIONS_BACKUP_FILENAME, encoded)
-- the staged witness has served its purpose; the main file is verified
remove(fs, OPTIONS_TMP_FILENAME)
return opts
end
@@ -397,6 +441,26 @@ function SaveData.loadOptions(fs)
if fs.getInfo(OPTIONS_FILENAME) then
Logger.error("options load failed: %s", tostring(err))
end
-- #828: answering defaults here is what "closing the game reset all my
-- settings" looked like -- one interrupted whole-file rewrite and every
-- preference, the mod enable-state and the slot registry were gone.
-- Promote the staged copy, then the rolled-aside backup, exactly as
-- SaveData.load does for progress, and heal the main file from whichever
-- one parsed.
local recovered = readTable(fs, OPTIONS_TMP_FILENAME)
local from = "tmp"
if not recovered then
recovered = readTable(fs, OPTIONS_BACKUP_FILENAME)
from = "bak"
end
if recovered then
Logger.warn("options.lua %s; recovered from %s copy",
fs.getInfo(OPTIONS_FILENAME) and "corrupt" or "missing", from)
if fs.write then
fs.write(OPTIONS_FILENAME, SaveSerializer.encode(recovered))
end
return SaveData.mergeOptions(recovered)
end
return SaveData.defaultOptions()
end
return SaveData.mergeOptions(data)
+14 -2
View File
@@ -39,17 +39,29 @@ function StateStack:update(dt)
if top and top.update then top:update(dt) end
end
local function visibleByDefault() return true end
-- A mod may mirror a state elsewhere and hide only its main-screen render.
-- The state stays on the stack, so update and input ownership do not move.
function StateStack:renderVisible(state)
if not state then return false end
if not Runtime.wantsHook("screen.render_visible") then return true end
return Runtime.call("screen.render_visible", visibleByDefault, state) ~= false
end
-- index of the lowest state drawn this frame (highest opaque, else 1)
function StateStack:visibleBase()
for i = #self.states, 1, -1 do
if self.states[i].isOpaque then return i end
local state = self.states[i]
if self:renderVisible(state) and state.isOpaque then return i end
end
return 1
end
function StateStack:draw()
for i = self:visibleBase(), #self.states do
if self.states[i].draw then self.states[i]:draw() end
local state = self.states[i]
if self:renderVisible(state) and state.draw then state:draw() end
end
end
+64 -1
View File
@@ -85,6 +85,55 @@ local function clampScale(v)
return v
end
-- Haptic feedback (#806): a short vibration the instant a control takes a GB
-- button, the way every mobile emulator front-end does it -- the pad has no
-- edges under a thumb, so the buzz is the only confirmation a press landed.
-- Persisted as options.haptics (src/core/SaveData.lua defaultOptions), NOT
-- under options.touchControls: TouchControls:config() is the launcher
-- editor's save snapshot and only emits enabled + layouts, so a nested key
-- would be dropped on every editor save.
-- love.system.vibrate takes a duration and nothing else, so "intensity" is a
-- duration preset: Android runs the platform vibrator for exactly that long,
-- while iOS ignores the duration and fires the fixed system vibration, so
-- there the three levels all read as simply on.
TouchControls.HAPTICS = { "off", "light", "medium", "heavy" }
TouchControls.HAPTIC_DEFAULT = "light"
local HAPTIC_SECONDS = { off = 0, light = 0.012, medium = 0.025, heavy = 0.045 }
local HAPTIC_LABELS = {
off = "OFF", light = "LIGHT", medium = "MEDIUM", heavy = "HEAVY",
}
function TouchControls.normalizeHaptics(level)
if HAPTIC_SECONDS[level] then return level end
return TouchControls.HAPTIC_DEFAULT
end
function TouchControls.hapticLabel(level)
return HAPTIC_LABELS[TouchControls.normalizeHaptics(level)]
end
function TouchControls.cycleHaptics(level, dir)
local cur, idx = TouchControls.normalizeHaptics(level), 1
for i, m in ipairs(TouchControls.HAPTICS) do
if m == cur then idx = i break end
end
local n = #TouchControls.HAPTICS
return TouchControls.HAPTICS[(idx - 1 + (dir or 1)) % n + 1]
end
-- One pulse at the given level. Feature-guarded rather than platform-gated:
-- love.system.vibrate is a no-op on desktop and absent from the headless love
-- stubs, so the press path below stays identical everywhere and the tests
-- never reach a vibrator.
function TouchControls.buzz(level)
local secs = HAPTIC_SECONDS[TouchControls.normalizeHaptics(level)]
if not secs or secs <= 0 then return false end
if not (love and love.system and love.system.vibrate) then return false end
pcall(love.system.vibrate, secs)
return true
end
-- Copy a persisted positions table, dropping unknown / non-numeric entries.
-- Always a fresh table: two orientations seeded from the same pre-#633
-- layout must not alias, or dragging one would still move the other.
@@ -174,6 +223,10 @@ end
function TouchControls:init()
self.active = wantsOverlay()
self.enabled = true
-- vibration level for presses (#806); applyOptions overwrites it from
-- options.haptics, this is the value a harness that never applies options
-- runs with
self.haptics = TouchControls.HAPTIC_DEFAULT
-- per-orientation buckets (#633); self.positions / self.scale mirror the
-- one currently on screen so layout(), the editor and the tests keep a
-- single lookup
@@ -210,6 +263,9 @@ end
function TouchControls:applyOptions(opts)
local cfg = TouchControls.normalizeConfig(opts and opts.touchControls)
self.enabled = cfg.enabled
-- haptics is a plain top-level option, not part of the layout config the
-- launcher editor round-trips through config() (#806)
self.haptics = TouchControls.normalizeHaptics(opts and opts.haptics)
self.layouts = cfg.layouts
self.layoutW, self.layoutH = nil, nil
self.layoutOx, self.layoutOy = nil, nil
@@ -401,7 +457,14 @@ end
local function pressBtn(self, btn)
local n = (self.held[btn] or 0) + 1
self.held[btn] = n
if n == 1 then Input:overlayPressed(btn) end
-- Buzz only on the 0 -> 1 edge, the same edge that presses the GB button:
-- a second finger landing on a button that is already held, and a d-pad
-- finger resting inside one direction, must not retrigger it. Sliding the
-- d-pad to a new direction does, which is the point (#806).
if n == 1 then
Input:overlayPressed(btn)
TouchControls.buzz(self.haptics)
end
end
local function releaseBtn(self, btn)
+12
View File
@@ -242,6 +242,18 @@ local function coreRows(opts)
opts.touchControls = tc
return true
end)
-- VIBRATION sits with it (#806): same gate, same subsystem. Stepping
-- the row buzzes once at the level being selected.
local okTC, TC = pcall(require, "src.core.TouchControls")
if okTC then
add(Strings("VIBRATION"),
function() return Strings(TC.hapticLabel(opts.haptics)) end,
function(dir)
opts.haptics = TC.cycleHaptics(opts.haptics, dir)
TC.buzz(opts.haptics)
return true
end)
end
end
end
+47 -3
View File
@@ -311,8 +311,20 @@ local function setPage(imp, key, v)
imp._pages[key] = v
end
-- A hand-drawn X, for the same reason drawCheck exists below: the UI font has
-- no guaranteed glyph, and the launcher ships no icon asset for it.
local function drawCross(x, y, size, color)
love.graphics.push("all")
love.graphics.setColor(color)
love.graphics.setLineWidth(math.max(2, size * 0.16))
love.graphics.setLineJoin("bevel")
love.graphics.line(x, y, x + size, y + size)
love.graphics.line(x + size, y, x, y + size)
love.graphics.pop()
end
-- ------------------------------------------------------------- header
-- Rail, logo row (settings on the right), tab bar.
-- Rail, logo row (settings and quit on the right), tab bar.
-- Returns the y at which content may start. Its vertical arithmetic is
-- mirrored by headerHeight() at the bottom of this file (the short-window
-- scroll decision needs the height before anything draws) -- keep in sync.
@@ -340,7 +352,14 @@ local function buildHeader(imp, m)
local rx = m.x + m.w - m.pad
local by = y + (rowH - gear) / 2
-- Settings gear, top-right corner.
-- The right cluster is laid out right to left -- Quit outermost, the gear
-- inboard of it -- but the two are REGISTERED gear first, because the first
-- focusable of the first frame adopts the keyboard ring and that must not be
-- the button that exits the app.
local quitX = rx - gear
rx = quitX - math.floor(6 * m.s)
-- Settings gear.
imp._gearIcon = imp._gearIcon
or love.graphics.newImage("assets/launcher/gear.png")
rx = rx - gear
@@ -365,6 +384,23 @@ local function buildHeader(imp, m)
end
end
-- Quit, top-right corner.
do
local x = quitX
Kit._audit("control", x, by, gear, gear, "quit")
local focused = Kit.focusable("quit", x, by, gear, gear)
local hot = focused or Kit.hover(x, by, gear, gear)
Theme.fill(x, by, gear, gear, hot and PAL.ink or PAL.bg, 1)
Theme.stroke(x, by, gear, gear, PAL.line,
hot and Theme.A.focus or Theme.A.hairline, 1)
local pad = math.floor(gear * 0.32)
drawCross(x + pad, by + pad, gear - 2 * pad,
hot and { 0, 0, 0, 1 } or { 1, 1, 1, 0.85 })
if Kit.press(x, by, gear, gear) or Kit._activateId == "quit" then
queueAction(imp, "quit", function() imp:_quitApp() end)
end
end
-- The self-update control lives in the FOOTER next to the BCG mark (small,
-- out of the wordmark's way -- it used to overlap the logo on a phone). It
-- still GLOWS through Kit.button when there is something to act on.
@@ -2164,7 +2200,15 @@ end
-- pinned Play block used to walk up over the cards on a short window, which
-- is unusable, and the footer simply lives below the fold until scrolled to.
local function minPanelHeight(m)
return math.floor(460 * m.s)
-- One column stacks the actions card, the slot card and the pinned Play
-- block in a single pile, so it needs more room than the side-by-side
-- layout: 460 was tuned for two columns, and on a squat one-column window
-- (a 4:3 device, a phone held upright) it left the slot card clipped
-- inert against the pinned buttons -- Kit's clip bounds hit-testing, so
-- no slot could be picked at all (#852). 660 fits the actions card, one
-- slot row with its pager and New button, and the pinned block; whatever
-- the window cannot show, the page scroll above reaches.
return math.floor((m.twoCol and 460 or 660) * m.s)
end
function LauncherView.draw(imp)
+18 -3
View File
@@ -2409,10 +2409,18 @@ function RomImporter:runActions(queue)
end
-- Clicks are polled inside FlexLove (mouse + love.touch); host-forwarded
-- mousepressed stays inert so Android's synthesized mouse path cannot
-- double-fire a tap (#553). Touch move/press/release must still reach
-- mousepressed mints no click, so Android's synthesized mouse path cannot
-- double-fire a tap (#553). It DOES hand the pointer back from the pad
-- cursor (#781): a Linux boot with a joystick present arms it (see the
-- getJoystickCount block in new()), and while it is active
-- LauncherView.update refuses to mint mouse clicks, so a real press must
-- win the pointer back even when the polled motion yield misses (X11
-- multi-monitor coords). Same contract as PadCursor.yieldToPointer for
-- the overlay hosts. Touch move/press/release must still reach
-- FlexLove.touch* or scroll containers never drag on phones.
function RomImporter:mousepressed() end
function RomImporter:mousepressed()
self._padCursorActive = false
end
function RomImporter:touchpressed(id, x, y, dx, dy, pressure)
if not self._flex then return end
@@ -2459,6 +2467,13 @@ function RomImporter:_openSettings()
if ok and model then self._settings = model end
end
-- Quit from the launcher's own X. It goes through love.event.quit so main.lua's
-- love.quit hook still runs: that is where the worker threads are shut down
-- (#339) and where a launcher close is told apart from a running game's (#785).
function RomImporter:_quitApp()
if love.event and love.event.quit then love.event.quit() end
end
function RomImporter:_closeSettings()
if self._settings then self._settings.save() end
self._settings = nil
+47 -12
View File
@@ -474,6 +474,33 @@ local function removeTree(path)
fs.remove(path)
end
-- Every mods/ folder currently holding this id, plus the bare mods/<id> tree
-- even when its manifest is missing or unreadable. Second return: whether any
-- of them carries a manifest the panel can actually list. An install names
-- its dest after the manifest id, but a hand-unzipped copy keeps whatever
-- folder name the archive carried, and discover()'s first-id-wins rule means
-- whichever folder physfs happens to enumerate first is the one the panel and
-- the loader really use. Replacing only mods/<id> let an update report
-- success while the old copy kept winning that race (#801); and a
-- manifest-less mods/<id> left by an interrupted copy blocked every re-import
-- as "already installed" while showing nowhere the player could see (#834).
local function sameIdTrees(fs, id)
local out, installed = {}, false
if not fs.getInfo("mods") then return out, installed end
for _, name in ipairs(fs.getDirectoryItems("mods")) do
local path = "mods/" .. name
local raw = fs.read(path .. "/manifest.json")
local manifest = raw and decodeManifest(raw, path)
if manifest and manifest.id == id then
out[#out + 1] = path
installed = true
elseif name == id and fs.getInfo(path) then
out[#out + 1] = path
end
end
return out, installed
end
-- ------- strays: mods dropped beside the game that it cannot see
-- love.filesystem looks in two places for "mods/": the save directory, and --
@@ -666,16 +693,21 @@ function LauncherMods._installZipInner(source, opts)
end
local dest = "mods/" .. manifest.id
if fs.getInfo(dest) then
if not opts.replace then
cleanup()
return nil, "a mod named '" .. manifest.id .. "' is already installed"
end
-- drop the old tree before copy; enable-flag is preserved (uninstall
-- would clear it, which would surprise an update)
local existing, installedSomewhere = sameIdTrees(fs, manifest.id)
if installedSomewhere and not opts.replace then
cleanup()
return nil, "a mod named '" .. manifest.id .. "' is already installed"
end
if #existing > 0 then
-- drop every old tree before copy -- mods/<id> and any same-id folder
-- under another name, or the survivor keeps winning discover()'s
-- first-id-wins race after the "successful" update (#801). A tree with
-- no readable manifest is debris from an interrupted copy: it never
-- refuses the install, it only gets cleared (#834). Enable-flag is
-- preserved (uninstall would clear it, which would surprise an update).
local savedPrefix = CacheFs.prefix
CacheFs.prefix = ""
removeTree(dest)
for _, path in ipairs(existing) do removeTree(path) end
CacheFs.prefix = savedPrefix
end
@@ -789,14 +821,17 @@ function LauncherMods.uninstall(id)
return nil, "mod uninstall needs LOVE"
end
local fs = love.filesystem
local dest = "mods/" .. id
if not fs.getInfo(dest) then
local trees = sameIdTrees(fs, id)
if #trees == 0 then
return nil, "mod '" .. id .. "' is not installed"
end
-- same root pin as installZip: the mods tree is not version-prefixed (#330)
-- same root pin as installZip: the mods tree is not version-prefixed (#330).
-- Every same-id tree goes, folder name notwithstanding, so Delete works on a
-- hand-unzipped copy too and cannot leave a shadow copy for discover()'s
-- first-id-wins rule to resurrect on the next boot (#801)
local savedPrefix = CacheFs.prefix
CacheFs.prefix = ""
removeTree(dest)
for _, path in ipairs(trees) do removeTree(path) end
CacheFs.prefix = savedPrefix
-- Drop the enable flag so a reinstall of the same id starts from the
-- loader's default (enabled) rather than a stale false.
+17 -2
View File
@@ -820,8 +820,13 @@ function Renderer:endFrame(zones, worldZones)
-- non-battle state that opts in) uses the paper shade. "world" never
-- reaches here -- it makes the battle non-opaque, so the world pass is
-- active and this whole branch is skipped.
-- FAITHFUL RATIO's mobile lock promises the display outside the GB
-- screen stays black (src/core/FaithfulRes.lua); the paper surround
-- painted the whole phone white on New Game and in battle (#864), so
-- the lock keeps the default black bars.
if state and state.letterboxWhite
and not (state.bgMode and state:bgMode() == "black") then
and not (state.bgMode and state:bgMode() == "black")
and not FaithfulRes.scaleCap() then
clearR, clearG, clearB = PaletteFX.paperShade(Game and Game.data)
end
end
@@ -1029,7 +1034,17 @@ function Renderer:endFrame(zones, worldZones)
local veil = self.screenVeil
if veil and veil[2] > 0 then
love.graphics.setColor(veil[1], veil[1], veil[1], veil[2])
love.graphics.rectangle("fill", 0, 0, ww, wh)
-- FAITHFUL RATIO's mobile lock: the surface the player sees is the
-- locked viewport and the bars around it are dead display, not screen
-- (src/core/FaithfulRes.lua). A whole-window veil lit the entire phone
-- for the battle flash and the post-battle fade (#864), so under the
-- lock the veil stops at the letterbox. The desktop lock is unaffected:
-- there the window IS the viewport.
if FaithfulRes.scaleCap() then
love.graphics.rectangle("fill", ox, oy, vpw, vph)
else
love.graphics.rectangle("fill", 0, 0, ww, wh)
end
love.graphics.setColor(1, 1, 1, 1)
end
+88
View File
@@ -93,6 +93,12 @@ O.statusFlags1 = O.townVisited + 29 -- 1B
O.statusFlags4 = O.townVisited + 35 -- 1B
O.elite4Flags = O.townVisited + 41 -- 1B
O.tradeFlags = O.townVisited + 44 -- 2B (flag_array NUM_NPC_TRADES)
-- wToggleableObjectFlags (ram/wram.asm, flag_array $100): the ShowObject/
-- HideObject persistence, one bit per data/maps/toggleable_objects.asm entry,
-- set = hidden (engine/overworld/toggleable_objects.asm IsObjectHidden).
-- Sits 2 bytes (wPlayerCoins) past O.coins per the walk above; absolute
-- 0x2852 (#763, #857).
O.toggleObjectFlags = O.coins + 2 -- 32B
-- Play time (wPlayTimeHours/Maxed/Minutes/Seconds/Frames) lives INSIDE the
-- sMainData window (wMainDataStart..wMainDataEnd is copied verbatim into
-- SRAM), 1866 bytes past wMainDataStart -- reached from the checksum-verified
@@ -107,6 +113,15 @@ O.playTimeMaxed = O.mainData + 1867 -- 1B (set once past 2
O.playTimeMinutes = O.mainData + 1868 -- 1B (0-59)
O.playTimeSeconds = O.mainData + 1869 -- 1B (0-59)
O.playTimeFrames = O.mainData + 1870 -- 1B (0-59, 1/60s ticks)
-- wPikachuHappiness, Yellow only (pret/pokeyellow ram/wram.asm; no local
-- pokeyellow checkout, so verified against the pokeyellow symbol file
-- instead: d46f - wMainDataStart d2f6 = 377, the well-known absolute
-- 0x271C). In Red/Blue this byte is current-map scratch the game
-- regenerates on load, so the codec touches it only when the crosswalk
-- data set names the game "yellow" (#763, #838). Every other modeled
-- offset is identical between pokered and pokeyellow (same sram.asm, same
-- wMainData field spacing per both symbol files).
O.pikachuHappiness = O.mainData + 377
O.mainDataSize = 1929 -- wMainDataEnd - wMainDataStart
O.spriteData = O.mainData + O.mainDataSize
@@ -729,6 +744,25 @@ function GenSave.decode(bytes, data, opts)
if save.flags[vanillaName] then save.flags[portName] = true end
end
-- wToggleableObjectFlags -> save.objectToggles (bit set = hidden). A few
-- of these are re-derived from flags on map entry (#106/#234 onEnter
-- re-applies), but most ShowObject/HideObject state -- the Mt Moon
-- fossils, the Cerulean guard swap -- has no flag to re-derive from, so
-- an import that drops the array resurrects taken fossils and blocking
-- guards (#763, #857).
local toggles = data.toggleObjects
if toggles then
save.objectToggles = {}
for bitIdx, e in pairs(toggles.byBit) do
local mapToggles = save.objectToggles[e[1]]
if not mapToggles then
mapToggles = {}
save.objectToggles[e[1]] = mapToggles
end
mapToggles[e[2]] = not bitGet(bytes, O.toggleObjectFlags, bitIdx)
end
end
-- FLY destinations. wTownVisitedFlag's bit index IS the town's map index:
-- engine/items/town_map.asm BuildFlyLocationsList loads the 16-bit value
-- into de and rotates it right one bit per iteration with b counting up
@@ -774,6 +808,15 @@ function GenSave.decode(bytes, data, opts)
+ u8(bytes, O.playTimeSeconds)
+ u8(bytes, O.playTimeFrames) / 60
-- Yellow starter friendship (save.pikachuHappiness,
-- src/world/PikachuFollower.lua reads it; pokeyellow's
-- init_player_data.asm seeds 90 on a new game), gated on the data set's
-- game because the byte is map scratch in Red/Blue (see
-- O.pikachuHappiness) (#763, #838).
if data.gameVersion == "yellow" then
save.pikachuHappiness = u8(bytes, O.pikachuHappiness)
end
save.warnings = warnings
save.rawImport = bytes -- template for a later encode(); see file header
return save
@@ -868,6 +911,41 @@ function GenSave.encode(save, data, template)
end
end
-- wToggleableObjectFlags, written both ways like the #396 extras: this
-- port's save is the authority, and vanilla folds three stores this port
-- keeps separate into these same bits -- script ShowObject/HideObject
-- (save.objectToggles), taken overworld items (engine/events/
-- pick_up_item.asm -> save.itemsTaken) and beaten static encounters
-- (home/trainers.asm HideObject after battle -> save.defeatedTrainers) --
-- so all three fold back in here or an exported save resurrects them
-- (#763, #857).
local toggleData = data.toggleObjects
if toggleData then
local objectToggles = save.objectToggles or {}
local itemsTaken = save.itemsTaken or {}
local beaten = save.defeatedTrainers or {}
for bitIdx, e in pairs(toggleData.byBit) do
local mapId, objName, visible = e[1], e[2], e[3]
local mapToggles = objectToggles[mapId]
if mapToggles and mapToggles[objName] ~= nil then
visible = mapToggles[objName]
end
if visible and data.maps and data.maps[mapId] then
for _, obj in ipairs(data.maps[mapId].objects or {}) do
if obj.name == objName then
local key = mapId .. "_obj_" .. obj.index
if (obj.item and itemsTaken[key])
or (obj.pokemon and beaten[key]) then
visible = false
end
break
end
end
end
bitSet(buf, O.toggleObjectFlags, bitIdx, not visible)
end
end
-- FLY destinations back into wTownVisitedFlag (see the decode note), so a
-- save exported from this port is flyable on hardware (#263). A save
-- table with no `visited` key at all says nothing about the set, so leave
@@ -967,6 +1045,16 @@ function GenSave.encode(save, data, template)
setByte(buf, O.playTimeFrames, rem - secs * 60)
end
-- Yellow starter friendship back out (see O.pikachuHappiness); Red/Blue
-- data sets never reach this write. 90 is the fresh-game seed the
-- follower system itself uses when the save has never tracked it.
-- Placed before the checksum pass so the byte is covered by the
-- main-data checksum automatically (#763, #838).
if data.gameVersion == "yellow" then
local h = tonumber(save.pikachuHappiness) or 90
setByte(buf, O.pikachuHappiness, math.max(0, math.min(255, math.floor(h))))
end
local out = table.concat(buf)
-- checksums, computed last over the now-final bytes
local outBuf = {}
+20
View File
@@ -44,6 +44,19 @@ local DATA_MODULES = {
maps = { "data.generated.maps", "data/generated/maps.lua" },
charmap = { "src.save_convert.data.charmap", "src/save_convert/data/charmap.lua" },
eventFlags = { "src.save_convert.data.event_flags", "src/save_convert/data/event_flags.lua" },
toggleObjects = { "src.save_convert.data.toggle_objects", "src/save_convert/data/toggle_objects.lua" },
}
-- Yellow renumbers wEventFlags bits: pokeyellow's constants/event_constants.asm
-- inserts events pokered does not have (the Jessie & James fights, catch
-- training, the Officer Jenny Squirtle) and shifts the Mt Moon 3 / Silph Co
-- 11F block, so writing a Yellow save through the Red table lands bits on the
-- wrong events and drops every Yellow-only flag. Kept outside DATA_MODULES so
-- the ensureData loop never loads it as a crosswalk of its own -- it
-- substitutes for `eventFlags` when the caller names Yellow (#838).
local YELLOW_EVENT_FLAGS = {
"src.save_convert.data.event_flags_yellow",
"src/save_convert/data/event_flags_yellow.lua",
}
local function loadTable(requirePath, filePath)
@@ -112,6 +125,9 @@ local function ensureData(gameVersion)
local data = {}
for name, spec in pairs(DATA_MODULES) do
if name ~= "charmap" then
if name == "eventFlags" and gameVersion == "yellow" then
spec = YELLOW_EVENT_FLAGS -- Yellow's bit numbering differs (#838)
end
local mod = loadCacheTable(gameVersion, spec[2])
if not mod then
local e
@@ -121,6 +137,10 @@ local function ensureData(gameVersion)
data[name] = mod
end
end
-- record which game's tables these are: the codec gates Yellow-only
-- bytes (wPikachuFriendship) on it, since those offsets are map
-- scratch in Red/Blue (#763, #838)
data.gameVersion = gameVersion
crosswalks[key] = data
end
if not charmapReady then
File diff suppressed because it is too large Load Diff
+243
View File
@@ -0,0 +1,243 @@
-- wToggleableObjectFlags bit index -> { map id, object_event name, default
-- visible } for the Gen1 save codec (src/save_convert/GenSave.lua).
-- Derived entry by entry from ../pokered/data/maps/toggleable_objects.asm
-- (ToggleableObjectStates: three bytes per entry, blocks laid out in map-id
-- order, so an entry's position in the table IS its wToggleableObjectFlags
-- bit -- constants/toggle_constants.asm numbers the same list), with the
-- default taken from each row's ON/OFF state. Bit set = hidden
-- (engine/overworld/toggleable_objects.asm IsObjectHidden). Object names
-- match data/generated/maps.lua object_event names one for one; the two
-- placeholder bits with no object_event in this port stay as comments so
-- the numbering remains auditable (#763, #857).
return {
byBit = {
[0] = { "PALLET_TOWN", "PALLETTOWN_OAK", false },
[1] = { "VIRIDIAN_CITY", "VIRIDIANCITY_OLD_MAN_SLEEPY", true },
[2] = { "VIRIDIAN_CITY", "VIRIDIANCITY_OLD_MAN", false },
[3] = { "PEWTER_CITY", "PEWTERCITY_SUPER_NERD1", true },
[4] = { "PEWTER_CITY", "PEWTERCITY_YOUNGSTER", true },
[5] = { "CERULEAN_CITY", "CERULEANCITY_RIVAL", false },
[6] = { "CERULEAN_CITY", "CERULEANCITY_ROCKET", true },
[7] = { "CERULEAN_CITY", "CERULEANCITY_GUARD1", false },
[8] = { "CERULEAN_CITY", "CERULEANCITY_SUPER_NERD3", true },
[9] = { "CERULEAN_CITY", "CERULEANCITY_GUARD2", true },
[10] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET1", true },
[11] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET2", true },
[12] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET3", true },
[13] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET4", true },
[14] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET5", true },
[15] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET6", true },
[16] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET7", true },
[17] = { "SAFFRON_CITY", "SAFFRONCITY_SCIENTIST", false },
[18] = { "SAFFRON_CITY", "SAFFRONCITY_SILPH_WORKER_M", false },
[19] = { "SAFFRON_CITY", "SAFFRONCITY_SILPH_WORKER_F", false },
[20] = { "SAFFRON_CITY", "SAFFRONCITY_GENTLEMAN", false },
[21] = { "SAFFRON_CITY", "SAFFRONCITY_PIDGEOT", false },
[22] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKER", false },
[23] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET8", true },
[24] = { "SAFFRON_CITY", "SAFFRONCITY_ROCKET9", false },
[25] = { "ROUTE_2", "ROUTE2_MOON_STONE", true },
[26] = { "ROUTE_2", "ROUTE2_HP_UP", true },
[27] = { "ROUTE_4", "ROUTE4_TM_WHIRLWIND", true },
[28] = { "ROUTE_9", "ROUTE9_TM_TELEPORT", true },
[29] = { "ROUTE_12", "ROUTE12_SNORLAX", true },
[30] = { "ROUTE_12", "ROUTE12_TM_PAY_DAY", true },
[31] = { "ROUTE_12", "ROUTE12_IRON", true },
[32] = { "ROUTE_15", "ROUTE15_TM_RAGE", true },
[33] = { "ROUTE_16", "ROUTE16_SNORLAX", true },
[34] = { "ROUTE_22", "ROUTE22_RIVAL1", false },
[35] = { "ROUTE_22", "ROUTE22_RIVAL2", false },
[36] = { "ROUTE_24", "ROUTE24_COOLTRAINER_M1", true },
[37] = { "ROUTE_24", "ROUTE24_TM_THUNDER_WAVE", true },
[38] = { "ROUTE_25", "ROUTE25_TM_SEISMIC_TOSS", true },
[39] = { "BLUES_HOUSE", "BLUESHOUSE_DAISY1", true },
[40] = { "BLUES_HOUSE", "BLUESHOUSE_DAISY2", false },
[41] = { "BLUES_HOUSE", "BLUESHOUSE_TOWN_MAP", true },
[42] = { "OAKS_LAB", "OAKSLAB_RIVAL", true },
[43] = { "OAKS_LAB", "OAKSLAB_CHARMANDER_POKE_BALL", true },
[44] = { "OAKS_LAB", "OAKSLAB_SQUIRTLE_POKE_BALL", true },
[45] = { "OAKS_LAB", "OAKSLAB_BULBASAUR_POKE_BALL", true },
[46] = { "OAKS_LAB", "OAKSLAB_OAK1", false },
[47] = { "OAKS_LAB", "OAKSLAB_POKEDEX1", true },
[48] = { "OAKS_LAB", "OAKSLAB_POKEDEX2", true },
[49] = { "OAKS_LAB", "OAKSLAB_OAK2", false },
[50] = { "VIRIDIAN_GYM", "VIRIDIANGYM_GIOVANNI", true },
[51] = { "VIRIDIAN_GYM", "VIRIDIANGYM_REVIVE", true },
[52] = { "MUSEUM_1F", "MUSEUM1F_OLD_AMBER", true },
[53] = { "CERULEAN_CAVE_1F", "CERULEANCAVE1F_FULL_RESTORE", true },
[54] = { "CERULEAN_CAVE_1F", "CERULEANCAVE1F_MAX_ELIXER", true },
[55] = { "CERULEAN_CAVE_1F", "CERULEANCAVE1F_NUGGET", true },
[56] = { "POKEMON_TOWER_2F", "POKEMONTOWER2F_RIVAL", true },
[57] = { "POKEMON_TOWER_3F", "POKEMONTOWER3F_ESCAPE_ROPE", true },
[58] = { "POKEMON_TOWER_4F", "POKEMONTOWER4F_ELIXER", true },
[59] = { "POKEMON_TOWER_4F", "POKEMONTOWER4F_AWAKENING", true },
[60] = { "POKEMON_TOWER_4F", "POKEMONTOWER4F_HP_UP", true },
[61] = { "POKEMON_TOWER_5F", "POKEMONTOWER5F_NUGGET", true },
[62] = { "POKEMON_TOWER_6F", "POKEMONTOWER6F_RARE_CANDY", true },
[63] = { "POKEMON_TOWER_6F", "POKEMONTOWER6F_X_ACCURACY", true },
[64] = { "POKEMON_TOWER_7F", "POKEMONTOWER7F_ROCKET1", true },
[65] = { "POKEMON_TOWER_7F", "POKEMONTOWER7F_ROCKET2", true },
[66] = { "POKEMON_TOWER_7F", "POKEMONTOWER7F_ROCKET3", true },
[67] = { "POKEMON_TOWER_7F", "POKEMONTOWER7F_MR_FUJI", true },
[68] = { "MR_FUJIS_HOUSE", "MRFUJISHOUSE_MR_FUJI", false },
[69] = { "CELADON_MANSION_ROOF_HOUSE", "CELADONMANSION_ROOF_HOUSE_EEVEE_POKEBALL", true },
[70] = { "GAME_CORNER", "GAMECORNER_ROCKET", true },
[71] = { "WARDENS_HOUSE", "WARDENSHOUSE_RARE_CANDY", true },
[72] = { "POKEMON_MANSION_1F", "POKEMONMANSION1F_ESCAPE_ROPE", true },
[73] = { "POKEMON_MANSION_1F", "POKEMONMANSION1F_CARBOS", true },
[74] = { "FIGHTING_DOJO", "FIGHTINGDOJO_HITMONLEE_POKE_BALL", true },
[75] = { "FIGHTING_DOJO", "FIGHTINGDOJO_HITMONCHAN_POKE_BALL", true },
[76] = { "SILPH_CO_1F", "SILPHCO1F_LINK_RECEPTIONIST", false },
[77] = { "POWER_PLANT", "POWERPLANT_VOLTORB1", true },
[78] = { "POWER_PLANT", "POWERPLANT_VOLTORB2", true },
[79] = { "POWER_PLANT", "POWERPLANT_VOLTORB3", true },
[80] = { "POWER_PLANT", "POWERPLANT_ELECTRODE1", true },
[81] = { "POWER_PLANT", "POWERPLANT_VOLTORB4", true },
[82] = { "POWER_PLANT", "POWERPLANT_VOLTORB5", true },
[83] = { "POWER_PLANT", "POWERPLANT_ELECTRODE2", true },
[84] = { "POWER_PLANT", "POWERPLANT_VOLTORB6", true },
[85] = { "POWER_PLANT", "POWERPLANT_ZAPDOS", true },
[86] = { "POWER_PLANT", "POWERPLANT_CARBOS", true },
[87] = { "POWER_PLANT", "POWERPLANT_HP_UP", true },
[88] = { "POWER_PLANT", "POWERPLANT_RARE_CANDY", true },
[89] = { "POWER_PLANT", "POWERPLANT_TM_THUNDER", true },
[90] = { "POWER_PLANT", "POWERPLANT_TM_REFLECT", true },
[91] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_MOLTRES", true },
[92] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_TM_SUBMISSION", true },
[93] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_FULL_HEAL", true },
[94] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_TM_MEGA_KICK", true },
[95] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_GUARD_SPEC", true },
[96] = { "VICTORY_ROAD_2F", "VICTORYROAD2F_BOULDER3", true },
[97] = { "BILLS_HOUSE", "BILLSHOUSE_BILL_POKEMON", true },
[98] = { "BILLS_HOUSE", "BILLSHOUSE_BILL1", false },
[99] = { "BILLS_HOUSE", "BILLSHOUSE_BILL2", false },
[100] = { "VIRIDIAN_FOREST", "VIRIDIANFOREST_ANTIDOTE", true },
[101] = { "VIRIDIAN_FOREST", "VIRIDIANFOREST_POTION", true },
[102] = { "VIRIDIAN_FOREST", "VIRIDIANFOREST_POKE_BALL", true },
[103] = { "MT_MOON_1F", "MTMOON1F_POTION1", true },
[104] = { "MT_MOON_1F", "MTMOON1F_MOON_STONE", true },
[105] = { "MT_MOON_1F", "MTMOON1F_RARE_CANDY", true },
[106] = { "MT_MOON_1F", "MTMOON1F_ESCAPE_ROPE", true },
[107] = { "MT_MOON_1F", "MTMOON1F_POTION2", true },
[108] = { "MT_MOON_1F", "MTMOON1F_TM_WATER_GUN", true },
[109] = { "MT_MOON_B2F", "MTMOONB2F_DOME_FOSSIL", true },
[110] = { "MT_MOON_B2F", "MTMOONB2F_HELIX_FOSSIL", true },
[111] = { "MT_MOON_B2F", "MTMOONB2F_HP_UP", true },
[112] = { "MT_MOON_B2F", "MTMOONB2F_TM_MEGA_PUNCH", true },
[113] = { "SS_ANNE_2F", "SSANNE2F_RIVAL", false },
[114] = { "SS_ANNE_1F_ROOMS", "SSANNE1FROOMS_TM_BODY_SLAM", true },
[115] = { "SS_ANNE_2F_ROOMS", "SSANNE2FROOMS_MAX_ETHER", true },
[116] = { "SS_ANNE_2F_ROOMS", "SSANNE2FROOMS_RARE_CANDY", true },
[117] = { "SS_ANNE_B1F_ROOMS", "SSANNEB1FROOMS_ETHER", true },
[118] = { "SS_ANNE_B1F_ROOMS", "SSANNEB1FROOMS_TM_REST", true },
[119] = { "SS_ANNE_B1F_ROOMS", "SSANNEB1FROOMS_MAX_POTION", true },
[120] = { "VICTORY_ROAD_3F", "VICTORYROAD3F_MAX_REVIVE", true },
[121] = { "VICTORY_ROAD_3F", "VICTORYROAD3F_TM_EXPLOSION", true },
[122] = { "VICTORY_ROAD_3F", "VICTORYROAD3F_BOULDER4", true },
[123] = { "ROCKET_HIDEOUT_B1F", "ROCKETHIDEOUTB1F_ESCAPE_ROPE", true },
[124] = { "ROCKET_HIDEOUT_B1F", "ROCKETHIDEOUTB1F_HYPER_POTION", true },
[125] = { "ROCKET_HIDEOUT_B2F", "ROCKETHIDEOUTB2F_MOON_STONE", true },
[126] = { "ROCKET_HIDEOUT_B2F", "ROCKETHIDEOUTB2F_NUGGET", true },
[127] = { "ROCKET_HIDEOUT_B2F", "ROCKETHIDEOUTB2F_TM_HORN_DRILL", true },
[128] = { "ROCKET_HIDEOUT_B2F", "ROCKETHIDEOUTB2F_SUPER_POTION", true },
[129] = { "ROCKET_HIDEOUT_B3F", "ROCKETHIDEOUTB3F_TM_DOUBLE_EDGE", true },
[130] = { "ROCKET_HIDEOUT_B3F", "ROCKETHIDEOUTB3F_RARE_CANDY", true },
[131] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_GIOVANNI", true },
[132] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_HP_UP", true },
[133] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_TM_RAZOR_WIND", true },
[134] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_IRON", true },
[135] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_SILPH_SCOPE", false },
[136] = { "ROCKET_HIDEOUT_B4F", "ROCKETHIDEOUTB4F_LIFT_KEY", false },
[137] = { "SILPH_CO_2F", "SILPHCO2F_SILPH_WORKER_F", true },
[138] = { "SILPH_CO_2F", "SILPHCO2F_SCIENTIST1", true },
[139] = { "SILPH_CO_2F", "SILPHCO2F_SCIENTIST2", true },
[140] = { "SILPH_CO_2F", "SILPHCO2F_ROCKET1", true },
[141] = { "SILPH_CO_2F", "SILPHCO2F_ROCKET2", true },
[142] = { "SILPH_CO_3F", "SILPHCO3F_ROCKET", true },
[143] = { "SILPH_CO_3F", "SILPHCO3F_SCIENTIST", true },
[144] = { "SILPH_CO_3F", "SILPHCO3F_HYPER_POTION", true },
[145] = { "SILPH_CO_4F", "SILPHCO4F_ROCKET1", true },
[146] = { "SILPH_CO_4F", "SILPHCO4F_SCIENTIST", true },
[147] = { "SILPH_CO_4F", "SILPHCO4F_ROCKET2", true },
[148] = { "SILPH_CO_4F", "SILPHCO4F_FULL_HEAL", true },
[149] = { "SILPH_CO_4F", "SILPHCO4F_MAX_REVIVE", true },
[150] = { "SILPH_CO_4F", "SILPHCO4F_ESCAPE_ROPE", true },
[151] = { "SILPH_CO_5F", "SILPHCO5F_ROCKET1", true },
[152] = { "SILPH_CO_5F", "SILPHCO5F_SCIENTIST", true },
[153] = { "SILPH_CO_5F", "SILPHCO5F_ROCKER", true },
[154] = { "SILPH_CO_5F", "SILPHCO5F_ROCKET2", true },
[155] = { "SILPH_CO_5F", "SILPHCO5F_TM_TAKE_DOWN", true },
[156] = { "SILPH_CO_5F", "SILPHCO5F_PROTEIN", true },
[157] = { "SILPH_CO_5F", "SILPHCO5F_CARD_KEY", true },
[158] = { "SILPH_CO_6F", "SILPHCO6F_ROCKET1", true },
[159] = { "SILPH_CO_6F", "SILPHCO6F_SCIENTIST", true },
[160] = { "SILPH_CO_6F", "SILPHCO6F_ROCKET2", true },
[161] = { "SILPH_CO_6F", "SILPHCO6F_HP_UP", true },
[162] = { "SILPH_CO_6F", "SILPHCO6F_X_ACCURACY", true },
[163] = { "SILPH_CO_7F", "SILPHCO7F_ROCKET1", true },
[164] = { "SILPH_CO_7F", "SILPHCO7F_SCIENTIST", true },
[165] = { "SILPH_CO_7F", "SILPHCO7F_ROCKET2", true },
[166] = { "SILPH_CO_7F", "SILPHCO7F_ROCKET3", true },
[167] = { "SILPH_CO_7F", "SILPHCO7F_RIVAL", true },
[168] = { "SILPH_CO_7F", "SILPHCO7F_CALCIUM", true },
[169] = { "SILPH_CO_7F", "SILPHCO7F_TM_SWORDS_DANCE", true },
-- [170] SILPH_CO_7F (SILPHCO7F_UNUSED): placeholder entry, no object_event in this port
[171] = { "SILPH_CO_8F", "SILPHCO8F_ROCKET1", true },
[172] = { "SILPH_CO_8F", "SILPHCO8F_SCIENTIST", true },
[173] = { "SILPH_CO_8F", "SILPHCO8F_ROCKET2", true },
[174] = { "SILPH_CO_9F", "SILPHCO9F_ROCKET1", true },
[175] = { "SILPH_CO_9F", "SILPHCO9F_SCIENTIST", true },
[176] = { "SILPH_CO_9F", "SILPHCO9F_ROCKET2", true },
[177] = { "SILPH_CO_10F", "SILPHCO10F_ROCKET", true },
[178] = { "SILPH_CO_10F", "SILPHCO10F_SCIENTIST", true },
[179] = { "SILPH_CO_10F", "SILPHCO10F_SILPH_WORKER_F", true },
[180] = { "SILPH_CO_10F", "SILPHCO10F_TM_EARTHQUAKE", true },
[181] = { "SILPH_CO_10F", "SILPHCO10F_RARE_CANDY", true },
[182] = { "SILPH_CO_10F", "SILPHCO10F_CARBOS", true },
[183] = { "SILPH_CO_11F", "SILPHCO11F_GIOVANNI", true },
[184] = { "SILPH_CO_11F", "SILPHCO11F_ROCKET1", true },
[185] = { "SILPH_CO_11F", "SILPHCO11F_ROCKET2", true },
-- [186] UNUSED_MAP_F4 ($02): placeholder entry, no object_event in this port
[187] = { "POKEMON_MANSION_2F", "POKEMONMANSION2F_CALCIUM", true },
[188] = { "POKEMON_MANSION_3F", "POKEMONMANSION3F_MAX_POTION", true },
[189] = { "POKEMON_MANSION_3F", "POKEMONMANSION3F_IRON", true },
[190] = { "POKEMON_MANSION_B1F", "POKEMONMANSIONB1F_RARE_CANDY", true },
[191] = { "POKEMON_MANSION_B1F", "POKEMONMANSIONB1F_FULL_RESTORE", true },
[192] = { "POKEMON_MANSION_B1F", "POKEMONMANSIONB1F_TM_BLIZZARD", true },
[193] = { "POKEMON_MANSION_B1F", "POKEMONMANSIONB1F_TM_SOLARBEAM", true },
[194] = { "POKEMON_MANSION_B1F", "POKEMONMANSIONB1F_SECRET_KEY", true },
[195] = { "SAFARI_ZONE_EAST", "SAFARIZONEEAST_FULL_RESTORE", true },
[196] = { "SAFARI_ZONE_EAST", "SAFARIZONEEAST_MAX_RESTORE", true },
[197] = { "SAFARI_ZONE_EAST", "SAFARIZONEEAST_CARBOS", true },
[198] = { "SAFARI_ZONE_EAST", "SAFARIZONEEAST_TM_EGG_BOMB", true },
[199] = { "SAFARI_ZONE_NORTH", "SAFARIZONENORTH_PROTEIN", true },
[200] = { "SAFARI_ZONE_NORTH", "SAFARIZONENORTH_TM_SKULL_BASH", true },
[201] = { "SAFARI_ZONE_WEST", "SAFARIZONEWEST_MAX_POTION", true },
[202] = { "SAFARI_ZONE_WEST", "SAFARIZONEWEST_TM_DOUBLE_TEAM", true },
[203] = { "SAFARI_ZONE_WEST", "SAFARIZONEWEST_MAX_REVIVE", true },
[204] = { "SAFARI_ZONE_WEST", "SAFARIZONEWEST_GOLD_TEETH", true },
[205] = { "SAFARI_ZONE_CENTER", "SAFARIZONECENTER_NUGGET", true },
[206] = { "CERULEAN_CAVE_2F", "CERULEANCAVE2F_PP_UP", true },
[207] = { "CERULEAN_CAVE_2F", "CERULEANCAVE2F_ULTRA_BALL", true },
[208] = { "CERULEAN_CAVE_2F", "CERULEANCAVE2F_FULL_RESTORE", true },
[209] = { "CERULEAN_CAVE_B1F", "CERULEANCAVEB1F_MEWTWO", true },
[210] = { "CERULEAN_CAVE_B1F", "CERULEANCAVEB1F_ULTRA_BALL", true },
[211] = { "CERULEAN_CAVE_B1F", "CERULEANCAVEB1F_MAX_REVIVE", true },
[212] = { "VICTORY_ROAD_1F", "VICTORYROAD1F_TM_SKY_ATTACK", true },
[213] = { "VICTORY_ROAD_1F", "VICTORYROAD1F_RARE_CANDY", true },
[214] = { "CHAMPIONS_ROOM", "CHAMPIONSROOM_OAK", false },
[215] = { "SEAFOAM_ISLANDS_1F", "SEAFOAMISLANDS1F_BOULDER1", true },
[216] = { "SEAFOAM_ISLANDS_1F", "SEAFOAMISLANDS1F_BOULDER2", true },
[217] = { "SEAFOAM_ISLANDS_B1F", "SEAFOAMISLANDSB1F_BOULDER1", false },
[218] = { "SEAFOAM_ISLANDS_B1F", "SEAFOAMISLANDSB1F_BOULDER2", false },
[219] = { "SEAFOAM_ISLANDS_B2F", "SEAFOAMISLANDSB2F_BOULDER1", false },
[220] = { "SEAFOAM_ISLANDS_B2F", "SEAFOAMISLANDSB2F_BOULDER2", false },
[221] = { "SEAFOAM_ISLANDS_B3F", "SEAFOAMISLANDSB3F_BOULDER2", true },
[222] = { "SEAFOAM_ISLANDS_B3F", "SEAFOAMISLANDSB3F_BOULDER3", true },
[223] = { "SEAFOAM_ISLANDS_B3F", "SEAFOAMISLANDSB3F_BOULDER5", false },
[224] = { "SEAFOAM_ISLANDS_B3F", "SEAFOAMISLANDSB3F_BOULDER6", false },
[225] = { "SEAFOAM_ISLANDS_B4F", "SEAFOAMISLANDSB4F_BOULDER1", false },
[226] = { "SEAFOAM_ISLANDS_B4F", "SEAFOAMISLANDSB4F_BOULDER2", false },
[227] = { "SEAFOAM_ISLANDS_B4F", "SEAFOAMISLANDSB4F_ARTICUNO", true },
},
}
+23
View File
@@ -260,6 +260,26 @@ function Commands.take_item(ctx, itemId, count)
if inv[itemId] == 0 then inv[itemId] = nil end
end
-- save_end_battle_text <TEXT_KEY>: SaveEndBattleTextPointers
-- (home/trainers.asm, called from e.g. RocketHideoutB4FScript10 just before
-- wCurOpponent is set). The armed line is the trainer's OWN loss line and
-- belongs on the battle screen: PrintEndBattleText (home/trainers.asm) runs
-- from TrainerBattleVictory (engine/battle/core.asm) after
-- TrainerDefeatedText and the pic scroll but BEFORE MoneyForWinningText, and
-- TrainerEndBattleText prints _TrainerNameText first so the line opens with
-- the "CLASS: " tag. Scripts that printed it with a plain show_text after
-- start_battle got it a box too late -- after the payout -- and untagged
-- (#866). Arms exactly one battle; start_battle consumes it.
function Commands.save_end_battle_text(ctx, textId)
local text = ctx.game.data.text[textId]
if not text and ctx.overworld then
text = ctx.game.data:resolveText(ctx.overworld.map.def.label, textId)
end
-- BattleState takes finished text, so expand {PLAYER}/{RIVAL} here the
-- way OverworldState:engageTrainer does for the sight/talk path
ctx.endBattleText = TextBox.substitute(ctx.game, text or textId)
end
-- start_battle "wild" species level | start_battle "trainer" OPP_CLASS partyIndex
function Commands.start_battle(ctx, kind, a, b)
local BattleState = require("src.battle.BattleState")
@@ -270,6 +290,9 @@ function Commands.start_battle(ctx, kind, a, b)
else
battle = BattleState.newTrainer(ctx.game, a, b)
end
-- one SaveEndBattleTextPointers arms one battle; leaving it set would leak
-- the line into the next scripted fight
battle.endBattleText, ctx.endBattleText = ctx.endBattleText, nil
battle.onFinish = function(result)
ctx.lastBattleResult = result
ctx.lastCheck = result == "win"
+26 -3
View File
@@ -437,6 +437,25 @@ local function buildRows(game)
require("src.core.TouchControls"):applyOptions(o)
return true
end },
-- Haptic feedback for on-screen pad presses (#806): OFF / LIGHT /
-- MEDIUM / HEAVY, where the intensity is a vibration duration --
-- love.system.vibrate takes nothing else. Hidden with TOUCH PAD below,
-- since the only thing that buzzes is a virtual button press.
{ id = "haptics", label = Strings("VIBRATION"),
value = function(g)
local TC = require("src.core.TouchControls")
return Strings(TC.hapticLabel(g.save.options.haptics))
end,
step = function(g, dir)
local o = g.save.options
local TC = require("src.core.TouchControls")
o.haptics = TC.cycleHaptics(o.haptics, dir)
TC:applyOptions(o)
-- sample the level being selected: stepping the row is the only way
-- to compare LIGHT against HEAVY without leaving the menu
TC.buzz(o.haptics)
return true
end },
}
-- issue #136: hide GBC FX on Android/iOS -- the present shader soft-bricks
if not GBCFX.isSupported() then
@@ -454,8 +473,10 @@ local function buildRows(game)
end
rows = filtered
end
-- TOUCH PAD only where the overlay can appear (mobile, or desktop with
-- POKEPORT_TOUCH=1). POKEPORT_TOUCH=0 forces it off everywhere.
-- TOUCH PAD and VIBRATION only where the overlay can appear (mobile, or
-- desktop with POKEPORT_TOUCH=1). POKEPORT_TOUCH=0 forces it off
-- everywhere. VIBRATION rides the same gate: nothing else in the port
-- vibrates, and love.system.vibrate is a no-op on desktop anyway.
do
local env = os.getenv("POKEPORT_TOUCH")
local osName = love.system and love.system.getOS and love.system.getOS()
@@ -464,7 +485,9 @@ local function buildRows(game)
if not show then
local filtered = {}
for _, row in ipairs(rows) do
if row.id ~= "touchControls" then filtered[#filtered + 1] = row end
if row.id ~= "touchControls" and row.id ~= "haptics" then
filtered[#filtered + 1] = row
end
end
rows = filtered
end
+8 -1
View File
@@ -68,7 +68,14 @@ function TitleState:sgbPalettes(game)
local top = game.stack and game.stack:top()
local box = top and top.titleUiBox
if box then
z[#z + 1] = P.trueColorZone(box[1], box[2], box[3], box[4])
-- A DMG-grays zone, not the trueColor opt-out: through the shade-remap
-- shader GRAYS is the identity for the box's four shades, so SGB /
-- ADVANCED / OG modes keep #133's white paper and black ink exactly,
-- while effectiveColors still substitutes the mono and inverted display
-- modes -- a trueColor rect skipped the shader entirely, leaving the
-- main menu and CONTINUE info box a raw white hole over a CLASSIC
-- pea-green title instead of matching it like the START menu does (#870).
z[#z + 1] = P.zone(P.GRAYS, box[1], box[2], box[3], box[4])
end
return z[3] and z or nil
end
+13
View File
@@ -234,6 +234,11 @@ local function launchDownload(url, partAbs, doneAbs)
local batRel = "updates/dl.bat"
love.filesystem.write(batRel,
"@echo off\r\n"
-- start /b hands the child our cwd, the install folder, and the
-- detached cmd.exe held that folder un-movable for the rest of the
-- transfer after the game exited (#727). Every path below is
-- absolute, so park the child in its own directory (the save dir).
.. "cd /d \"%~dp0\"\r\n"
.. "curl -fsSL --connect-timeout 15 --max-time 900 -o \""
.. partAbs .. "\" \"" .. url .. "\"\r\n"
.. "type nul > \"" .. doneAbs .. "\"\r\n")
@@ -271,6 +276,14 @@ local function doDownload()
-- stalled or run-away transfer breaks out and lets verification fail cleanly
local waited, lastSize, lastChange = 0, -1, 0
while true do
-- A queued quit means the window already closed. Bail so the join in
-- Check.shutdown does not hold the dead window's process (and, on
-- Windows, its folder) open for up to the whole transfer (#727). The
-- quit stays on the channel for the command loop; the detached curl
-- times out on its own and the next launch's doCheck verifies and
-- re-offers whatever landed.
local peeked = cmdCh:peek()
if type(peeked) == "table" and peeked.cmd == "quit" then return end
if love.filesystem.getInfo(doneRel) then break end
local pinfo = love.filesystem.getInfo(partRel)
local cur = (pinfo and pinfo.size) or 0
+96 -13
View File
@@ -440,8 +440,10 @@ function OverworldState:setMap(mapId, x, y, facing, opts)
self.entities = { self.player }
for _, n in ipairs(self.npcs) do table.insert(self.entities, n) end
-- Yellow's companion Pikachu trails the player (never in
-- self.entities: it does not block movement, pikachu_follow.asm)
require("src.world.PikachuFollower").onMapEntered(Game, self, opts)
-- self.entities: it does not block movement, pikachu_follow.asm).
-- true = fresh map entry: the follower spawns under the player and
-- walks out of the warp, not beside him (#863)
require("src.world.PikachuFollower").onMapEntered(Game, self, opts, true)
-- opts.keepMusic: the Oak-escort warp keeps MUSIC_MEET_PROF_OAK
-- playing into the lab (BIT_NO_MAP_MUSIC in wStatusFlags7);
@@ -1259,8 +1261,14 @@ end
function OverworldState:checkBoulderPush(dir)
local p = self.player
local fx, fy = Collision.target(p.cellX, p.cellY, dir)
local npc = self:npcAtCell(fx, fy)
if not npc or not Map.isPushable(npc.def) or npc.moving then
-- IsSpriteInFrontOfPlayer (home/overworld.asm) hands TryPushingBoulder
-- the LOWEST sprite index standing on the faced cell, so in the original a
-- second sprite parked on the boulder's cell hides the boulder from the
-- push path for the rest of the map visit. Pick the pushable sprite out of
-- the cell instead: a scripted walk-up that lands a trainer on the boulder
-- must not brick it permanently (#809).
local npc = self:pushableAtCell(fx, fy)
if not npc or npc.moving then
self.boulderTried = nil -- pokered resets when no boulder is in front
return false
end
@@ -1720,6 +1728,22 @@ function OverworldState:npcAtCell(cx, cy)
return nil
end
-- The Strength boulder on a cell, ignoring anything else standing there.
-- npcAtCell returns whichever object the map listed first, which is only
-- well defined while at most one sprite occupies a cell; scripted walks
-- (TrainerWalkUpToPlayer) can break that, and the push path must still find
-- the boulder underneath (#809).
function OverworldState:pushableAtCell(cx, cy)
for _, npc in ipairs(self.npcs) do
if ((npc.cellX == cx and npc.cellY == cy) or
(npc.targetX == cx and npc.targetY == cy))
and Map.isPushable(npc.def) then
return npc
end
end
return nil
end
-- what the A press resolved to, for world.interacted's listeners
local function interacted(self, fx, fy, kind, target)
Runtime.emit("world.interacted", { mapId = self.map.id, x = fx, y = fy,
@@ -1903,7 +1927,14 @@ function OverworldState:tryHiddenObject(fx, fy)
save.hiddenTaken = save.hiddenTaken or {}
if save.hiddenTaken[key] then return false end
if not require("src.inventory.Bag").add(save, h.item, 1, Game.data) then
Game.stack:push(TextBox.new(Game, romText(Game.data, "_CantCarryMoreText", "You can't carry\nany more items!")))
-- hidden_items.asm FoundHiddenItemText: the find is announced first,
-- then GiveItem's .bagFull branch prints _HiddenItemBagFullText and
-- leaves the spot unfound; _CantCarryMoreText is the Toss line (#872)
local name = Game.data.items[h.item] and Game.data.items[h.item].name or h.item
Game.stack:push(TextBox.new(Game,
Strings("%s found\n%s!", save.player.name, name) .. "\f"
.. romText(Game.data, "_HiddenItemBagFullText",
"But, {PLAYER} has\nno more room for\vother items!")))
return true
end
save.hiddenTaken[key] = true
@@ -2548,7 +2579,17 @@ function OverworldState:talkTo(npc)
-- the string "0" as truthy, so screen it out and fall through to text.
if d.item and d.item ~= "0" and d.item ~= 0 then
if not require("src.inventory.Bag").add(Game.save, d.item, 1, Game.data) then
Game.stack:push(TextBox.new(Game, romText(Game.data, "_CantCarryMoreText", "You can't carry\nany more items!")))
-- pick_up_item.asm .BagFull prints _NoMoreRoomForItemText, not the
-- Toss-screen _CantCarryMoreText; Yellow announces the find first,
-- then the refusal (#872)
local noRoom = romText(Game.data, "_NoMoreRoomForItemText",
"No more room for\nitems!")
if GameVersion.isYellow() then
local name = Game.data.items[d.item] and Game.data.items[d.item].name or d.item
noRoom = Strings("%s found\n%s!", Game.save.player.name, name)
.. "\f" .. noRoom
end
Game.stack:push(TextBox.new(Game, noRoom))
return
end
Game.save.itemsTaken = Game.save.itemsTaken or {}
@@ -2962,7 +3003,12 @@ local function meetTrainerTheme(cls)
end
-- Run the pre-battle text -> battle -> won text -> flags sequence.
function OverworldState:engageTrainer(npc, onDone)
-- skipBattleText is for map scripts shaped like SilphCo11FDefaultScript
-- (scripts/SilphCo11F.asm), which DisplayTextID the challenge line BEFORE
-- the approach walk and then EngageMapTrainer with no further text: the
-- caller already showed the box, so the battle starts without a second
-- one (#869).
function OverworldState:engageTrainer(npc, onDone, endBattleText, skipBattleText)
local d = npc.def
Runtime.emit("world.trainer_engaged", { npc = npc, trainerClass = d.trainerClass,
partyIndex = d.trainerParty })
@@ -2972,10 +3018,18 @@ function OverworldState:engageTrainer(npc, onDone)
battleText = select(1, Game.data:resolveText(self.map.def.label, d.text))
or Strings("I like shorts!\nThey're comfy and\neasy to wear!")
end
local wonText = header and header.won and Game.data.text[header.won]
-- `endBattleText` is a caller-supplied stand-in for header.won: the
-- text_asm trainers that hand their loss line to the battle through
-- SaveEndBattleTextPointers (scripts/GameCorner.asm GameCornerRocketText
-- passes _GameCornerRocketBattleEndText, "Dang!") have no def_trainers
-- header for the extractor to read, so their script passes the finished
-- line here and it still lands where PrintEndBattleText puts it -- between
-- TrainerDefeatedText and MoneyForWinningText, on the battle screen (#862).
local wonText = endBattleText
or (header and header.won and Game.data.text[header.won])
local BattleState = require("src.battle.BattleState")
Game.stack:push(TextBox.new(Game, battleText, function()
local function startBattle()
-- TalkToTrainer (home/trainers.asm:88) prints the before-battle text
-- FIRST and only then runs `call EngageMapTrainer` / `jp
-- StartTrainerBattle`, so a trainer challenged on foot gets the sting
@@ -3018,7 +3072,12 @@ function OverworldState:engageTrainer(npc, onDone)
end
end
self:pushBattle(battle)
end))
end
if skipBattleText then
startBattle()
else
Game.stack:push(TextBox.new(Game, battleText, startBattle))
end
end
-- Shared GiveItem step for the victory rewards (pokered home/give.asm):
@@ -3241,8 +3300,26 @@ function OverworldState:startTrainerApproach(npc, dist)
self.emote = {
npc = npc, frames = 60,
onDone = function()
if dist > 1 then
self:scriptMove(npc, npc.facing, dist - 1, fight)
-- TrainerWalkUpToPlayer (engine/overworld/trainer_sight.asm) writes
-- dist-1 NPC_MOVEMENT_* bytes and hands them to MoveSprite, and every
-- scripted step skips collision entirely (CanWalkOntoTile,
-- engine/overworld/movement.asm: "always allow walking if the
-- movement is scripted"), so the original marches the trainer straight
-- through a Strength boulder sitting on the sight line. Stop one cell
-- short of the boulder instead: two sprites on one cell is a state the
-- push path cannot represent, and the walk-up is the one scripted move
-- the player can steer a boulder into (#809).
local steps = dist - 1
local cx, cy = npc.cellX, npc.cellY
for i = 1, steps do
cx, cy = Collision.target(cx, cy, npc.facing)
if self:pushableAtCell(cx, cy) then
steps = i - 1
break
end
end
if steps > 0 then
self:scriptMove(npc, npc.facing, steps, fight)
else
fight()
end
@@ -4422,7 +4499,13 @@ function OverworldState:drawWorld()
-- ghost NPCs on neighbor maps, y-sorted among themselves
table.sort(self.ghosts,
function(a, b) return a.npc.py + a.oy < b.npc.py + b.oy end)
table.sort(self.entities, function(a, b) return a.py < b.py end)
table.sort(self.entities, function(a, b)
if a.py ~= b.py then return a.py < b.py end
-- a fresh warp spawn parks the follower on the player's own cell
-- until it trails out; the tie must draw it under him, never on
-- top (#863)
return a.pikachuFollower == true and b.pikachuFollower ~= true
end)
-- === shared FX draw bodies ==========================================
-- Each draws at flat world-canvas offsets; the tilt path wraps the
+9 -2
View File
@@ -188,7 +188,7 @@ function PikachuFollower.current(ow)
return npc
end
function PikachuFollower.onMapEntered(game, ow, opts)
function PikachuFollower.onMapEntered(game, ow, opts, viaMapLoad)
-- Bill's House owns a short scripted scene that deliberately keeps
-- Pikachu off the normal trailing loop. A new map instance ends it.
ow.pikachuBillsScene = nil
@@ -200,7 +200,8 @@ function PikachuFollower.onMapEntered(game, ow, opts)
-- takes .normal_spawn_state -- map coords rebased, sprite data and
-- follow command buffer left alone. Re-list the same instance and let
-- rebase() shift its cell; a warp arrives without it and respawns
-- behind the player, the full spawn path of that same routine.
-- under the player, the full spawn path of that same routine (the
-- viaMapLoad spawn below, #863).
local keep = opts and opts.keepPikachu
if keep then
table.insert(ow.npcs, keep)
@@ -208,6 +209,12 @@ function PikachuFollower.onMapEntered(game, ow, opts)
return
end
local x, y = spawnCell(ow)
-- a fresh map entry (warp, boot) parks the follower ON the player's
-- cell instead: it stays hidden under him (the draw-sort tie-break in
-- OverworldController) and walks out of the warp behind him as the
-- trail opens up. Mid-map respawns (bike dismount, revive) keep the
-- behind-the-facing cell (#863)
if viaMapLoad then x, y = ow.player.cellX, ow.player.cellY end
local npc = makeFollower(game, ow, x, y, ow.player.facing)
table.insert(ow.npcs, npc)
-- entities is the draw list; passable keeps it out of collision
@@ -0,0 +1,222 @@
-- Manual check of both bag-full pickup refusals (#872): an item ball must
-- refuse with _NoMoreRoomForItemText (pokered scripts/pick_up_item.asm
-- .BagFull), never the Toss-screen _CantCarryMoreText, and a hidden item
-- announces the find first, then _HiddenItemBagFullText (hidden_items.asm).
-- Run without POKEPORT_SPEED -- the box paging under test is timing-honest.
-- POKEPORT_DRIVER=tests/drivers/bag_full_pickup_bug872_test.lua POKEPORT_IDENTITY=bug872 POKEPORT_TOUCH=0 love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local TextBox = require("src.render.TextBox")
local Bag = require("src.inventory.Bag")
local GameVersion = require("src.core.GameVersion")
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local MAP = "VIRIDIAN_FOREST"
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
return ok
end
-- neither refusal plays a jingle, but the human will want the normal
-- pickup sound as a contrast, so warn when it would be muted
local opts = game.save.options or {}
if (opts.sfxVol or 7) == 0 then
U.log("note: sfxVol is 0, so a successful pickup afterwards will be",
"silent; the refusal boxes themselves are unaffected")
end
-- a real fresh game, so the save has a player name and clean flags
U.newGame(game)
local save = game.save
-- Empty the bag, then refill to exactly capacity with ids that are NOT
-- POTION: Bag.add succeeds by quantity for an id already in a slot
-- (src/inventory/Bag.lua), which would mask the bug, and both test
-- targets below hand out POTION. Badges share save.inventory but are
-- not bag slots, so they are left alone.
for _, id in ipairs({ unpack(Bag.order(save)) }) do
Bag.remove(save, id, save.inventory[id] or 1)
end
local ids = {}
for id in pairs(game.data.items) do
if not Bag.isBadge(id) and id ~= "POTION" then ids[#ids + 1] = id end
end
table.sort(ids)
for _, id in ipairs(ids) do
if Bag.slots(save) >= Bag.capacity(game.data) then break end
Bag.add(save, id, 1, game.data)
end
check(("bag is full (%d/%d slots) and holds no POTION")
:format(Bag.slots(save), Bag.capacity(game.data)),
Bag.slots(save) >= Bag.capacity(game.data)
and not save.inventory.POTION)
-- first target: the Potion item ball. pokered
-- data/maps/objects/ViridianForest.asm:36 puts it at walk cell (12, 29)
-- (object_event 12, 29, SPRITE_POKE_BALL ... POTION), free floor below.
local BALL = { x = 12, y = 29 }
U.teleport(game, MAP, BALL.x, BALL.y + 1, "left")
U.wait(10)
local function isBall(n)
return n and n.def and n.def.item and n.def.item ~= "0" and n.def.item ~= 0
end
local ow = game.overworld
local ball = ow:npcAtCell(BALL.x, BALL.y)
if not isBall(ball) then
-- a map edit or mod moved the object: take any item ball on the map
-- and stand on a free walkable neighbour instead
ball = nil
for _, n in ipairs(ow.npcs or {}) do
if isBall(n) then ball = n break end
end
if ball then
local sides = {
{ 0, 1, "up" }, { 0, -1, "down" }, { 1, 0, "left" }, { -1, 0, "right" },
}
for _, s in ipairs(sides) do
local cx, cy = ball.cellX + s[1], ball.cellY + s[2]
if ow.map:isWalkableCell(cx, cy) and not ow:npcAtCell(cx, cy) then
U.log(("ball not at (%d, %d); using the one at (%d, %d)")
:format(BALL.x, BALL.y, ball.cellX, ball.cellY))
-- teleport facing away, the tap below still does the turn
U.teleport(game, MAP, cx, cy, s[3] == "left" and "right" or "left")
U.wait(10)
BALL.x, BALL.y = ball.cellX, ball.cellY
break
end
end
end
end
check("an item ball is loaded on " .. MAP, ball ~= nil)
local ballItem = ball and ball.def.item or "POTION"
-- turn toward the ball ourselves (a one-frame press only turns when the
-- player faces elsewhere, src/world/Player.lua), then trigger the talk
ow = game.overworld
local dx, dy = BALL.x - ow.player.cellX, BALL.y - ow.player.cellY
local dir = (dy < 0 and "up") or (dy > 0 and "down")
or (dx < 0 and "left") or "right"
U.tap(game, dir)
U.wait(10)
local fx, fy = game.overworld.player:facingCell()
check("player turned to face the ball",
game.overworld:npcAtCell(fx, fy) == ball)
U.tap(game, "a")
U.wait(30)
local function readPages()
local top = game.stack:top()
if getmetatable(top) ~= TextBox then return nil end
local pages = {}
for _, page in ipairs(top.pages or {}) do
pages[#pages + 1] = table.concat(page, " / ")
end
return pages
end
local function closeBox()
for _ = 1, 8 do
if getmetatable(game.stack:top()) ~= TextBox then break end
U.tap(game, "a")
U.wait(25)
end
end
local pages = readPages()
check("A on the full-bag ball opened a text box", pages ~= nil)
if pages then
local all = table.concat(pages, " || ")
U.log("ball refusal reads:", all)
check("it is the pickup refusal, not the Toss line",
all:find("No more room", 1, true) ~= nil
and all:find("can't carry", 1, true) == nil)
if GameVersion.isYellow() then
check("Yellow announces the find, then refuses on page 2",
#pages == 2
and pages[1]:find(ballItem, 1, true) ~= nil
and pages[2]:find("No more room", 1, true) ~= nil)
else
check("Red/Blue refuse in one page with no found line",
#pages == 1 and pages[1]:find("found", 1, true) == nil)
end
U.shot(game, SHOT_DIR .. "/bug872_ball_refusal.png")
end
closeBox()
-- the refusal must leave the world untouched so the pickup can be
-- retried after tossing something
check("the ball is still standing there",
game.overworld:npcAtCell(BALL.x, BALL.y) == ball)
check("itemsTaken was not marked",
not (save.itemsTaken and ball and save.itemsTaken[ball.id]))
check("the item stayed out of the bag", not save.inventory[ballItem])
-- second target: the hidden POTION. pokered
-- data/events/hidden_item_coords.asm:8 puts it at (x=1, y=18) on
-- VIRIDIAN_FOREST; Game.data.field.hiddenItems carries the same spot.
local hidden
local list = (game.data.field.hiddenItems or {})[MAP] or {}
for _, h in ipairs(list) do
if h.x == 1 and h.y == 18 then hidden = h break end
end
hidden = hidden or list[1]
check("a hidden item exists on " .. MAP, hidden ~= nil)
local stood = false
if hidden then
-- {dx, dy, facing} from the hidden cell to a stand cell that looks
-- back at it; the spot itself is usually an unwalkable tree tile
local sides = {
{ 0, 1, "up" }, { 0, -1, "down" }, { 1, 0, "left" }, { -1, 0, "right" },
}
for _, s in ipairs(sides) do
local cx, cy = hidden.x + s[1], hidden.y + s[2]
local m = game.overworld.map
if m:isWalkableCell(cx, cy) and not game.overworld:npcAtCell(cx, cy) then
U.teleport(game, MAP, cx, cy, s[3] == "left" and "right" or "left")
U.wait(10)
U.tap(game, s[3])
U.wait(10)
local hfx, hfy = game.overworld.player:facingCell()
if hfx == hidden.x and hfy == hidden.y then stood = true break end
end
end
end
check("standing against the hidden spot", stood)
U.tap(game, "a")
U.wait(30)
pages = readPages()
check("A on the full-bag hidden spot opened a text box", pages ~= nil)
if pages then
local all = table.concat(pages, " || ")
U.log("hidden refusal reads:", all)
check("the found line comes first",
#pages == 2 and pages[1]:find("found", 1, true) ~= nil
and (not hidden or pages[1]:find(
(game.data.items[hidden.item] or {}).name or hidden.item,
1, true) ~= nil))
check("then the hidden-item bag-full line, not the Toss line",
#pages == 2
and pages[2]:find("no more room", 1, true) ~= nil
and pages[2]:find("other items", 1, true) ~= nil
and all:find("can't carry", 1, true) == nil)
U.shot(game, SHOT_DIR .. "/bug872_hidden_refusal.png")
end
closeBox()
local key = hidden and (MAP .. "_" .. hidden.x .. "_" .. hidden.y)
check("the hidden spot can still be prompted again",
not (key and save.hiddenTaken and save.hiddenTaken[key]))
check("the hidden item stayed out of the bag",
not (hidden and save.inventory[hidden.item]))
U.log("You are still facing the hidden spot with a full bag; pressing A")
U.log("should say the item was found, then that there is no more room for")
U.log("other items, and never the bag screen's \"can't carry\" wording.")
U.log("Toss something and both spots should hand their item over normally.")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,222 @@
-- A trainer's walk-up must stop short of a Strength boulder, and the boulder
-- must still be pushable afterwards (#809). TrainerWalkUpToPlayer (pokered
-- engine/overworld/trainer_sight.asm) writes dist-1 movement bytes that skip
-- collision, so the trainer used to park ON the boulder, and after that
-- IsSpriteInFrontOfPlayer (home/overworld.asm) handed TryPushingBoulder the
-- trainer instead of the rock. POKEPORT_DRIVER=tests/drivers/boulder_trainer_bug809_test.lua POKEPORT_IDENTITY=bug809 POKEPORT_TOUCH=0 POKEPORT_VERSION=red love .
-- No POKEPORT_SPEED: the sighting, the "!" bubble and the walk-up all run at
-- the normal 60 Hz logic clock so the stop-short frame is the one a player
-- would see. The setup pushes are slow for the same reason; the run takes
-- about half a minute of real time before it hands the pad over.
return function(game)
local U = dofile("tests/drivers/util.lua")
-- pokered data/maps/objects/VictoryRoad3F.asm:
-- object_event 13, 3, SPRITE_COOLTRAINER_F, STAY, RIGHT, ..., OPP_COOLTRAINER_F, 3
-- object_event 22, 3, SPRITE_BOULDER, STAY, BOULDER_MOVEMENT_BYTE_2, ...
-- Her header range is 4 (data/generated/trainer_headers.lua VictoryRoad3F[4]),
-- so she spots the player anywhere on row 3 within four cells to her east and
-- then walks dist-1 cells toward him. Row 3 is walled at x=19, so BOULDER1
-- cannot simply be shoved west into her sight line: it has to go down column
-- 22 to row 6, west along row 6, and back up column 17 onto row 3.
local MAP = "VICTORY_ROAD_3F"
local MAP_LABEL = "VictoryRoad3F"
local BOULDER = "VICTORYROAD3F_BOULDER1"
local TRAINER = "VICTORYROAD3F_COOLTRAINER_F2"
local START = { x = 22, y = 2, facing = "down" }
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local pass = true
local function check(label, ok)
if not ok then pass = false end
U.log(ok and "PASS" or "FAIL", label)
return ok
end
local function findNpc(ow, name)
for _, n in ipairs(ow.npcs or {}) do
if n.def and n.def.name == name then return n end
end
return nil
end
-- Hold `btn` until `cond` goes true or the budget runs out, then release and
-- let any half-finished step land. Boulder pushes need a held direction:
-- handleInput only reaches checkBoulderPush while the player already faces
-- that way, and TryPushingBoulder arms on one poll and moves on the next
-- (BIT_TRIED_PUSH_BOULDER), so a single tap can never shift a rock.
local function holdUntil(btn, cond, budget)
local first = true
for _ = 1, budget or 600 do
if cond() then break end
if first then table.insert(game.input.pressQueue, btn); first = false end
game.input.state[btn] = true
coroutine.yield()
end
game.input.state[btn] = false
for _ = 1, 40 do
if not game.overworld.player.moving and #game.overworld.scriptMoves == 0 then
break
end
coroutine.yield()
end
U.wait(4) -- an input-free poll re-arms turning in place (wCheckFor180DegreeTurn)
return cond()
end
U.teleport(game, MAP, START.x, START.y, START.facing)
U.wait(10)
local ow = game.overworld
local rock = findNpc(ow, BOULDER)
local trainer = findNpc(ow, TRAINER)
check("BOULDER1 loaded on " .. MAP, rock ~= nil)
check("COOLTRAINER_F2 loaded on " .. MAP, trainer ~= nil)
if not (rock and trainer) then
U.log("map objects missing; nothing to drive")
while true do coroutine.yield() end
end
check("BOULDER1 starts at the asm cell (22,3)",
rock.cellX == 22 and rock.cellY == 3)
check("COOLTRAINER_F2 starts at the asm cell (13,3) facing right",
trainer.cellX == 13 and trainer.cellY == 3 and trainer.facing == "right")
check("checkBoulderPush resolves through pushableAtCell",
type(ow.pushableAtCell) == "function")
local header = game.data:trainerHeader(MAP_LABEL, trainer.def.index)
local range = header and header.range or 0
check("her sight range is 4 cells", range == 4)
-- The whole route, so a map or tileset edit shows up here instead of as a
-- driver that quietly wanders off. If a cell is not walkable the boulder
-- cannot be pushed onto it (CheckForCollisionWhenPushingBoulder reuses the
-- player's passability check) and the run is not worth continuing.
local ROUTE = {
{ 22, 4 }, { 22, 5 }, { 22, 6 }, { 23, 5 }, { 23, 6 },
{ 21, 6 }, { 20, 6 }, { 19, 6 }, { 18, 6 }, { 17, 6 },
{ 18, 7 }, { 17, 7 }, { 17, 5 }, { 17, 4 }, { 17, 3 },
{ 18, 4 }, { 18, 3 }, { 16, 3 }, { 16, 4 }, { 16, 2 },
}
local routeOk = true
for _, c in ipairs(ROUTE) do
if not ow.map:isWalkableCell(c[1], c[2]) then
routeOk = false
U.log("route cell not walkable:", c[1], c[2])
end
end
check("the push route is walkable end to end", routeOk)
-- STRENGTH is live for the map visit. BIT_STRENGTH_ACTIVE is what
-- TryPushingBoulder gates on -- it never re-reads badges or party moves --
-- so setting the field-move state is the whole grant (see the comment in
-- OverworldState:checkBoulderPush).
ow.strengthActive = true
-- Victory Road rolls a wild encounter on every completed step, not just in
-- grass (wild_encounters.asm counts caves as indoor), and this run walks
-- twenty-odd cells with an empty party. Drop the map's table: a wild
-- battle mid-route interrupts the push with a screen transition and has
-- nothing to do with what is being checked.
game.data.encounters[MAP] = nil
if not pass then
U.log("setup checks already failed; not driving the push")
while true do coroutine.yield() end
end
local function boulderAt(x, y)
return function() return rock.cellX == x and rock.cellY == y end
end
local function playerAt(x, y)
local p = ow.player
return function() return p.cellX == x and p.cellY == y end
end
-- down column 22 to row 6
holdUntil("down", boulderAt(22, 6), 400)
check("boulder pushed down column 22 to (22,6)", rock.cellX == 22 and rock.cellY == 6)
-- around to its east side
holdUntil("right", playerAt(23, 5), 120)
holdUntil("down", playerAt(23, 6), 120)
-- west along row 6 to the column that reaches row 3
holdUntil("left", boulderAt(17, 6), 700)
check("boulder pushed west along row 6 to (17,6)", rock.cellX == 17 and rock.cellY == 6)
-- around to its south side
holdUntil("down", playerAt(18, 7), 120)
holdUntil("left", playerAt(17, 7), 120)
-- up column 17 onto her row
holdUntil("up", boulderAt(17, 3), 400)
check("boulder pushed up column 17 onto row 3 at (17,3)",
rock.cellX == 17 and rock.cellY == 3)
if not pass then
U.log("the boulder never reached her row; the race below cannot happen")
while true do coroutine.yield() end
end
-- Step onto row 3 one cell out of range (18 - 13 = 5 > 4) so the sighting
-- happens on the push itself and not a moment earlier.
holdUntil("right", playerAt(18, 4), 120)
holdUntil("up", playerAt(18, 3), 120)
check("player waiting at (18,3), one cell outside her range",
ow.player.cellX == 18 and ow.player.cellY == 3 and not ow.engaging)
-- The engage lands on a battle we are not going to fight: stand in for it,
-- record where the walk-up stopped, and mark her beaten the way winning
-- would. Everything the walk-up does has already happened by this point.
local stopped
local realEngage = ow.engageTrainer
ow.engageTrainer = function(self, npc, onDone)
stopped = { npc = npc, x = npc.cellX, y = npc.cellY }
game.save.defeatedTrainers[npc.id] = true
if onDone then onDone() end
end
-- One push west: the boulder lands on (16,3) and the player follows onto
-- (17,3), four cells from her, which is the frame she spots him on.
holdUntil("left", function() return stopped ~= nil end, 400)
check("she spotted the player and finished her walk-up", stopped ~= nil)
check("the boulder moved one cell west to (16,3)",
rock.cellX == 16 and rock.cellY == 3)
if stopped then
U.log("she stopped at", stopped.x, stopped.y, "boulder at", rock.cellX, rock.cellY)
check("she is not standing on the boulder cell",
not (stopped.x == rock.cellX and stopped.y == rock.cellY))
check("she stopped one cell short of it, at (15,3)",
stopped.x == 15 and stopped.y == 3)
check("the push path still finds the boulder under that cell",
ow:pushableAtCell(rock.cellX, rock.cellY) == rock)
check("nothing else shares the boulder's cell",
ow:npcAtCell(rock.cellX, rock.cellY) == rock)
end
U.shot(game, SHOT_DIR .. "/bug809_walkup_stop.png")
-- ...and the rock still moves. Push it north, the one free direction left:
-- west is her, east is the player, south is where he came from.
holdUntil("down", playerAt(17, 4), 120)
holdUntil("left", playerAt(16, 4), 120)
holdUntil("up", boulderAt(16, 2), 400)
if not check("the boulder is still pushable after the engage",
rock.cellX == 16 and rock.cellY == 2) then
U.log("boulder ended at", rock.cellX, rock.cellY, "player at",
ow.player.cellX, ow.player.cellY)
end
holdUntil("down", playerAt(16, 4), 120)
U.shot(game, SHOT_DIR .. "/bug809_still_pushable.png")
ow.engageTrainer = realEngage
U.log(pass and "ALL CHECKS PASSED" or "SOME CHECKS FAILED")
U.log("On screen: the COOLTRAINER stands at (15,3) with a one-cell gap")
U.log("between her and the rock, which now sits at (16,2), one row up from")
U.log("where she stopped. The near miss to watch for is her sprite ending")
U.log("the walk-up on top of the rock, or standing clear of it but leaving")
U.log("it inert: walk into the rock from any side and it should still shift")
U.log("a cell. Her battle was stubbed out and she is flagged as beaten;")
U.log("re-run the driver to watch the race again from the start.")
while true do
coroutine.yield()
end
end
+209
View File
@@ -0,0 +1,209 @@
-- Driver: Fighting Dojo prize balls, #853 (dex page first) and #854 (the
-- question stays on screen under YES/NO). pokered scripts/FightingDojo.asm
-- runs `ld a, HITMONLEE / call DisplayPokedex` before .Text, and .Text is a
-- text_end string printed with PrintText immediately followed by YesNoChoice.
-- No POKEPORT_SPEED here: the dex page and the YES/NO pop are what is judged.
-- SHOT_DIR=/tmp/shots POKEPORT_DRIVER=tests/drivers/dojo_balls_bug853_test.lua POKEPORT_IDENTITY=bug853 POKEPORT_TOUCH=0 POKEPORT_VERSION=red love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local TextBox = require("src.render.TextBox")
local ChoiceBox = require("src.ui.ChoiceBox")
local DexEntryMenu = require("src.ui.DexEntryMenu")
local MapScripts = require("src.script.MapScripts")
local Screens = require("src.ui.Screens")
local OW = require("src.world.OverworldController")
local Pokemon = require("src.pokemon.Pokemon")
-- pokered data/maps/objects/FightingDojo.asm: the two SPRITE_POKE_BALL
-- objects sit at (4, 1) HITMONLEE and (5, 1) HITMONCHAN, on the north wall
-- under the posters. The only approach is from the mat below them.
local MAP = "FIGHTING_DOJO"
local LEE = { name = "FIGHTINGDOJO_HITMONLEE_POKE_BALL", x = 4, y = 1 }
local CHAN = { name = "FIGHTINGDOJO_HITMONCHAN_POKE_BALL", x = 5, y = 1 }
local START = { x = 4, y = 4 } -- walk up from here to (4, 2), facing LEE
local failures = {}
local function check(cond, msg)
if cond then U.log("PASS", msg) else
failures[#failures + 1] = msg
U.log("FAIL", msg)
end
return cond
end
local function topIs(mt) return getmetatable(game.stack:top()) == mt end
local function under()
return game.stack.states[#game.stack.states - 1]
end
local function npcByName(ow, name)
for _, n in ipairs(ow.npcs or {}) do
if n.def and n.def.name == name then return n end
end
end
local function pageText()
local top = game.stack:top()
if getmetatable(top) ~= TextBox then return "" end
local page = top.pages and top.pages[top.pageIndex]
return page and table.concat(page, "\n") or ""
end
local function waitFor(cond, cap)
for _ = 1, (cap or 200) do
if cond() then return true end
U.wait(2)
end
return cond()
end
local function mashUntil(cond, cap)
for _ = 1, (cap or 100) do
if cond() then return true end
U.tap(game, "a")
U.wait(2)
end
return cond()
end
-- fresh dojo with the master already beaten and neither prize taken
local function seed(x, y, facing)
while game.stack:top() do game.stack:pop() end
game.save.flags = {
EVENT_BEAT_KARATE_MASTER = true,
EVENT_BEAT_FIGHTING_DOJO_TRAINER_0 = true,
EVENT_BEAT_FIGHTING_DOJO_TRAINER_1 = true,
EVENT_BEAT_FIGHTING_DOJO_TRAINER_2 = true,
EVENT_BEAT_FIGHTING_DOJO_TRAINER_3 = true,
}
game.save.defeatedTrainers = { FIGHTING_DOJO_obj_1 = true }
game.save.objectToggles = {}
game.save.player.name = game.save.player.name or "RED"
-- one mon so give_pokemon has a party to append to, and room for a prize
game.save.party = { Pokemon.new(game.data, "CHARIZARD", 50) }
game.stack:push(OW, MAP, x, y, facing or "up")
U.wait(10)
return game.stack:top()
end
local ow = seed(START.x, START.y, "up")
------------------------------------------------------------------
-- machine-checkable half: seed, objects, script rows, text, screen id
------------------------------------------------------------------
check(game.save.flags.EVENT_BEAT_KARATE_MASTER == true,
"EVENT_BEAT_KARATE_MASTER is set (the balls answer at all)")
check(not game.save.flags.EVENT_GOT_HITMONLEE
and not game.save.flags.EVENT_GOT_HITMONCHAN,
"neither prize taken yet (no 'greedy' refusal path)")
local leeBall, chanBall = npcByName(ow, LEE.name), npcByName(ow, CHAN.name)
check(leeBall ~= nil, "HITMONLEE ball object loaded")
check(chanBall ~= nil, "HITMONCHAN ball object loaded")
check(leeBall and leeBall.cellX == LEE.x and leeBall.cellY == LEE.y,
("HITMONLEE ball sits at the asm cell (%d, %d)"):format(LEE.x, LEE.y))
check(chanBall and chanBall.cellX == CHAN.x and chanBall.cellY == CHAN.y,
("HITMONCHAN ball sits at the asm cell (%d, %d)"):format(CHAN.x, CHAN.y))
check(type(MapScripts.talkScript(MAP, "TEXT_FIGHTINGDOJO_HITMONLEE_POKE_BALL"))
== "function",
"TEXT_FIGHTINGDOJO_HITMONLEE_POKE_BALL has a hand-ported talk script")
check(type(MapScripts.talkScript(MAP, "TEXT_FIGHTINGDOJO_HITMONCHAN_POKE_BALL"))
== "function",
"TEXT_FIGHTINGDOJO_HITMONCHAN_POKE_BALL has a hand-ported talk script")
-- the ask() string is the extracted descriptor, not the "You want X?" stub
local leeText = game.data.text._FightingDojoHitmonleePokeBallText
local chanText = game.data.text._FightingDojoHitmonchanPokeBallText
check(type(leeText) == "string" and leeText ~= "",
"_FightingDojoHitmonleePokeBallText resolves")
check(type(chanText) == "string" and chanText ~= "",
"_FightingDojoHitmonchanPokeBallText resolves")
if type(leeText) == "string" then
U.log("lee prompt reads:", (leeText:gsub("\n", " / ")))
end
local dexOk = pcall(Screens.get, game, "DexEntryMenu")
check(dexOk, "DexEntryMenu resolves through the Screens registry")
------------------------------------------------------------------
-- rehearsal on the HITMONCHAN ball, answered NO so nothing is consumed
------------------------------------------------------------------
if chanBall then
ow:talkTo(chanBall)
check(waitFor(function() return topIs(DexEntryMenu) end, 60),
"#853: the ball opens the HITMONCHAN dex page before any question")
U.shot(game, DIR .. "/dojo_balls_1_dex.png")
U.tap(game, "b")
check(waitFor(function() return topIs(TextBox) end, 60),
"#853: closing the dex page leads into the offer text")
mashUntil(function() return topIs(ChoiceBox) end, 60)
check(topIs(ChoiceBox), "#854: the YES/NO menu opens on the offer")
check(getmetatable(under()) == TextBox,
"#854: the question box is still on the stack under the YES/NO menu")
U.shot(game, DIR .. "/dojo_balls_2_choice.png")
U.tap(game, "b") -- B answers NO; the prize stays unclaimed
waitFor(function() return game.stack:top() == ow end, 120)
check(not game.save.flags.EVENT_GOT_HITMONCHAN,
"answering NO leaves the HITMONCHAN prize unclaimed")
check(#game.save.party == 1, "answering NO adds nothing to the party")
end
------------------------------------------------------------------
-- hand-off: walk to the HITMONLEE ball and open it for real
------------------------------------------------------------------
ow = seed(START.x, START.y, "up")
for _ = 1, 12 do
if ow.player.cellY <= LEE.y + 1 then break end
U.hold(game, "up", 16)
U.wait(4)
end
local function facingTheBall()
local cur = game.overworld
local ball = cur and npcByName(cur, LEE.name)
if not ball then return false end
local fx, fy = cur.player:facingCell()
return cur:npcAtCell(fx, fy) == ball
end
if not facingTheBall() then
-- a map edit or a mod moved the ball: stand on any free walkable
-- neighbour instead. {dx, dy, facing} is the offset from the ball to
-- the stand cell plus the direction that looks back at it.
local sides = {
{ 0, 1, "up" }, { 1, 0, "left" }, { -1, 0, "right" }, { 0, -1, "down" },
}
for _, s in ipairs(sides) do
local cx, cy = LEE.x + s[1], LEE.y + s[2]
if ow.map:isWalkableCell(cx, cy) and not ow:npcAtCell(cx, cy) then
U.log("walk up stopped short; standing on", cx, cy, "facing", s[3])
ow = seed(cx, cy, s[3])
break
end
end
end
check(facingTheBall(), "player is standing against the HITMONLEE ball")
U.tap(game, "a")
check(waitFor(function() return topIs(DexEntryMenu) end, 60),
"#853: pressing A opens the HITMONLEE dex page")
U.shot(game, DIR .. "/dojo_balls_3_handoff.png")
if #failures == 0 then
U.log("all checks passed")
else
U.log(("%d check(s) failed:"):format(#failures), table.concat(failures, "; "))
end
U.log("On screen now: the HITMONLEE dex page the ball opened, name and")
U.log("sprite only, since the mon is seen but not owned yet. Press B: the")
U.log("offer types out, and the YES/NO menu should appear above it with the")
U.log("question still readable -- the old bug swapped the text away for a")
U.log("bare YES/NO over the overworld. Answer YES to take HITMONLEE; the")
U.log("HITMONCHAN ball beside it stays put and gives the greedy refusal.")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,296 @@
-- Eye check: FAITHFUL RATIO's mobile scale lock keeps the display outside the
-- locked 160x144 viewport black through the pre-battle flash (pokered
-- BattleTransition_FlashScreen_, engine/battle/battle_transitions.asm), the
-- post-battle fade (GBFadeInFromWhite, home/fade.asm) and Oak speech (#864).
-- POKEPORT_DRIVER=tests/drivers/faithful_res_mobile_veil_bug864_test.lua POKEPORT_FORCE_MOBILE=1 POKEPORT_IDENTITY=bug864 POKEPORT_TOUCH=0 POKEPORT_VERSION=red SHOT_DIR=/tmp/shots love .
-- No POKEPORT_SPEED anywhere: the flash and the fade ARE the frames under test.
return function(game)
local U = dofile("tests/drivers/util.lua")
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local Renderer = require("src.render.Renderer")
local FaithfulRes = require("src.core.FaithfulRes")
local Pokemon = require("src.pokemon.Pokemon")
local BattleState = require("src.battle.BattleState")
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
return ok
end
-- FaithfulRes.isMobile reads the env per call, so the desktop build only
-- takes the scale-cap branch when the launcher command set it. Without it
-- every check below tests the ordinary letterbox and proves nothing.
if not check("POKEPORT_FORCE_MOBILE=1 is set (the branch under test)",
os.getenv("POKEPORT_FORCE_MOBILE") == "1") then
U.log("Re-run with POKEPORT_FORCE_MOBILE=1; nothing below is meaningful.")
while true do coroutine.yield() end
end
-- A phone-shaped window, so the locked viewport (160x144 at the largest
-- whole multiple, here 3x = 480x432) leaves tall bars above and below --
-- the "dead display" FaithfulRes.lua's contract says must stay black.
-- 480x960 keeps the width an exact 3x so the bars are purely vertical.
if love.window and love.window.setMode then
love.window.setMode(480, 960, { resizable = true,
minwidth = FaithfulRes.MIN_W,
minheight = FaithfulRes.MIN_H })
end
U.wait(3)
-- New Game replaces game.save (and Game:applyOptions re-applies its fresh
-- options, which releases the lock), so re-arm before every shot rather
-- than trusting one application to survive the whole run.
local function lock()
game.save.options = game.save.options or {}
game.save.options.faithfulRes = 1
game.save.options.battleBg = "black"
FaithfulRes.applyOptions(game.save.options)
return FaithfulRes.scaleCap()
end
check("the mobile scale lock engaged (FaithfulRes.scaleCap ~= nil)",
lock() ~= nil)
local opts = game.save.options
if (opts.musicVol or 0) == 0 or (opts.sfxVol or 0) == 0 then
U.log("WARN music/sfx volume is zero; the flash's battle theme will be silent")
end
-- Load a captured PNG back as ImageData; love.image cannot read absolute
-- paths, so go through io.open + newFileData.
local function loadShot(path)
local f = io.open(path, "rb")
if not f then return nil end
local bytes = f:read("*a")
f:close()
local ok, img = pcall(function()
return love.image.newImageData(
love.filesystem.newFileData(bytes, "shot.png"))
end)
return ok and img or nil
end
local function regionMean(img, x, y, w, h)
local sum, n = 0, 0
local x2 = math.min(x + w, img:getWidth()) - 1
local y2 = math.min(y + h, img:getHeight()) - 1
for yy = math.max(y, 0), y2 do
for xx = math.max(x, 0), x2 do
local r, g, b = img:getPixel(xx, yy)
sum = sum + (r + g + b) / 3
n = n + 1
end
end
return n > 0 and sum / n or 0, n
end
-- The locked viewport in framebuffer pixels: the same uiSize * fitScale
-- centring endFrame uses for ox/oy/vpw/vph, which is the rectangle the
-- veil is clamped to under the lock. Screenshots are framebuffer-sized,
-- so no dpi divide.
local function viewBox(img)
local pw, ph = img:getWidth(), img:getHeight()
local uiw, uih = Renderer:uiSize()
local S = Renderer:fitScale()
local bw, bh = uiw * S, uih * S
return math.floor((pw - bw) / 2), math.floor((ph - bh) / 2), bw, bh, pw, ph
end
-- Mean over every bar strip the window has (top/bottom always here,
-- left/right only if the width is not an exact multiple). Inset by 2px so
-- the viewport's own edge pixels cannot bleed into the bar sample.
local function barMean(img)
local bx, by, bw, bh, pw, ph = viewBox(img)
local sum, n = 0, 0
local function add(x, y, w, h)
if w < 1 or h < 1 then return end
local m, c = regionMean(img, x, y, w, h)
sum, n = sum + m * c, n + c
end
if by >= 8 then
add(0, 0, pw, by - 2)
add(0, by + bh + 2, pw, ph - (by + bh) - 2)
end
if bx >= 8 then
add(0, by, bx - 2, bh)
add(bx + bw + 2, by, bx - 2, bh)
end
return n > 0 and sum / n or -1, n
end
local function innerMean(img)
local bx, by, bw, bh = viewBox(img)
return regionMean(img, bx + math.floor(bw / 4), by + math.floor(bh / 4),
math.floor(bw / 2), math.floor(bh / 2))
end
-- shot + the two-sided assertion every moment shares: bars dead black,
-- viewport interior at least `bright` (the effect visibly inside the frame)
local function shotAndCheck(name, bright)
check("lock still held at " .. name, lock() ~= nil)
local path = DIR .. "/bug864_" .. name .. ".png"
U.shot(game, path)
local img = loadShot(path)
if not check(name .. " shot decoded", img ~= nil) then return nil end
local bars, n = barMean(img)
local inner = innerMean(img)
U.log((" %s: bar mean %.3f over %d px, viewport interior %.3f")
:format(name, bars, n, inner))
check(name .. ": window has bars to sample", n > 0)
check(name .. ": bars stay dead black (#864)", n > 0 and bars < 0.05)
check(name .. ": the effect still lights the viewport", inner > bright)
return img
end
-- ---- (3rd symptom first: it is where a boot starts) New Game -----------
-- OakSpeech sets letterboxWhite; before #864 that painted the WHOLE phone
-- paper white, leaving the locked frame indistinguishable from its bars.
U.wait(5)
U.tap(game, "start") -- skip intro movie
U.wait(10)
U.tap(game, "a") -- title -> menu
U.wait(5)
U.tap(game, "a") -- NEW GAME (POKEPORT_IDENTITY=bug864 has no save)
local oak
for _ = 1, 300 do
for i = #game.stack.states, 1, -1 do
local s = game.stack.states[i]
if s and s.letterboxWhite then oak = s break end
end
if oak then break end
U.tap(game, "a")
U.wait(2)
end
check("Oak speech reached (a letterboxWhite state is on the stack)",
oak ~= nil)
U.wait(40) -- let Oak's pic and a line of text land inside the frame
shotAndCheck("oakspeech", 0.5)
-- mash through the rest of the speech into the overworld; the naming
-- screens and the closing shrink-away beat (~103 unskippable frames) eat
-- most of this, so the headroom is generous on purpose
for _ = 1, 900 do
U.tap(game, "a")
U.wait(2)
if game.overworld and game.stack:top() == game.overworld then break end
end
check("New Game landed in the overworld",
game.overworld ~= nil and game.stack:top() == game.overworld)
-- ---- the pre-battle flash ----------------------------------------------
-- pokered data/maps/objects/Route1.asm puts its youngsters at (5,24) and
-- (15,13) and the sign at (9,27), so the top of the road is empty; the
-- battle is pushed straight in, the cell is only somewhere to stand.
local MAP = "ROUTE_1"
local STAND = { x = 5, y = 6, facing = "down" }
game.save.party = { Pokemon.new(game.data, "BULBASAUR", 12) }
U.teleport(game, MAP, STAND.x, STAND.y, STAND.facing)
U.wait(10)
local ow = game.overworld
check("the overworld is up on " .. MAP, ow ~= nil and ow.map.id == MAP)
if ow and not ow.map:isWalkableCell(STAND.x, STAND.y) then
-- a map edit moved the road: any free neighbour serves, the cell is not
-- itself under test
for _, d in ipairs({ {0,1}, {0,-1}, {1,0}, {-1,0} }) do
local cx, cy = STAND.x + d[1], STAND.y + d[2]
if ow.map:isWalkableCell(cx, cy) and not ow:npcAtCell(cx, cy) then
U.log(("stand cell (%d, %d) blocked, using (%d, %d)")
:format(STAND.x, STAND.y, cx, cy))
U.teleport(game, MAP, cx, cy, STAND.facing)
U.wait(10)
ow = game.overworld
break
end
end
end
U.shot(game, DIR .. "/bug864_route1_base.png") -- unlit reference frame
lock()
-- wild, weaker (L5 vs the L12 lead), not a dungeon map: the 3-bit select
-- (battle_transitions.asm) lands on %000 doublecircle, one of the two
-- wipes that call BattleTransition_FlashScreen first
local battle = BattleState.newWild(game, "RATTATA", 5)
ow:pushBattle(battle)
local trans = game.stack:top()
check("the transition is a flashing wipe (doublecircle)",
trans ~= nil and trans.def ~= nil and trans.def.flash == true)
-- screenVeil is written during draw and cleared at beginFrame, so at
-- update time it holds the LAST rendered frame's veil; catch the white
-- peak (shade 1, near-full alpha) and shoot the very next frames while
-- the 2-frame palette holds keep it bright
local caught = false
for _ = 1, 400 do
local v = game.renderer and game.renderer.screenVeil
if v and v[1] == 1 and v[2] >= 0.9 then caught = true break end
U.wait(1)
end
check("caught the flash at its white peak", caught)
local flashImg = shotAndCheck("flash", 0.5)
local baseImg = loadShot(DIR .. "/bug864_route1_base.png")
if flashImg and baseImg then
local lit, plain = innerMean(flashImg), innerMean(baseImg)
U.log((" viewport interior %.3f unlit -> %.3f mid-flash")
:format(plain, lit))
check("the flash visibly brightens the viewport over the base frame",
lit > plain + 0.15)
end
-- ---- the post-battle fade in from white --------------------------------
for _ = 1, 600 do
if game.stack:top() == battle then break end
U.wait(1)
end
check("the battle reached the screen", game.stack:top() == battle)
for _ = 1, 200 do
if battle.phase == "menu" then break end
U.tap(game, "a")
U.wait(6)
end
check("the battle reached its FIGHT/PKMN/ITEM/RUN menu",
battle.phase == "menu")
-- run away (down+right lands on RUN from anywhere in the 2x2 grid; the
-- L12 lead outspeeds the L5 wild mon, so the escape always succeeds),
-- then watch for BattleReturn's white veil -- battle over, shade 1,
-- alpha 1 through its hold frames
local sawReturn = false
for _ = 1, 1500 do
local top = game.stack:top()
local v = game.renderer and game.renderer.screenVeil
if top ~= battle and v and v[1] == 1 and v[2] >= 0.9 then
sawReturn = true
break
end
if top == battle then
if battle.phase == "menu" then
U.tap(game, "down")
U.wait(1)
U.tap(game, "right")
U.wait(1)
U.tap(game, "a")
U.wait(2)
else
U.tap(game, "a")
U.wait(3)
end
else
U.wait(1)
end
end
check("caught the post-battle fade in from white", sawReturn)
shotAndCheck("return", 0.8)
-- ---- over to you --------------------------------------------------------
U.log("You are back on Route 1 with the picture locked to a 480x432 frame in")
U.log("the middle of a tall window. Open the three shots in " .. DIR .. ":")
U.log("bug864_oakspeech, bug864_flash and bug864_return should each show a lit")
U.log("frame -- paper, white flash, white fade -- with dead-black bars above")
U.log("and below. Before #864 the white spilled over the whole window and the")
U.log("frame had no edge at all. Walking into grass here replays the flash live.")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,321 @@
-- Driver: #862 Celadon Game Corner poster grunt, loss line + exit walk.
-- GameCornerRocketText saves _GameCornerRocketBattleEndText ("Dang!") for
-- PrintEndBattleText, and GameCornerRocketBattleScript picks the exit walk
-- from the player's cell (pokered/scripts/GameCorner.asm:54-102): east of
-- him it is WalkAroundPlayer, DOWN/R/R/UP/R/R/R/R, never UP into the poster.
-- No POKEPORT_SPEED: the walk and the battle text are what is under test.
-- SHOT_DIR=/tmp/shots POKEPORT_IDENTITY=bug862 POKEPORT_TOUCH=0 \
-- POKEPORT_DRIVER=tests/drivers/game_corner_grunt_bug862_test.lua love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
os.execute("mkdir -p " .. DIR)
local Pokemon = require("src.pokemon.Pokemon")
local TextBox = require("src.render.TextBox")
local BattleState = require("src.battle.BattleState")
local pass, fail = 0, 0
local function check(label, ok, detail)
if ok then pass = pass + 1 else fail = fail + 1 end
U.log(ok and "PASS" or "FAIL", label, detail or "")
return ok
end
-- pokered/data/maps/objects/GameCorner.asm:36 -- the grunt is
-- object_event 9, 5, SPRITE_ROCKET, STAY, UP, facing the poster bg_event
-- at (9,4), which is wall. Standing east of him on (10,5) is the branch
-- that matters: wYCoord ~= 6 and wXCoord ~= 8, so the script takes
-- GameCornerMovement_Rocket_WalkAroundPlayer.
local MAP = "GAME_CORNER"
local NAME = "GAMECORNER_ROCKET"
local GX, GY = 9, 5
local STAND = { x = 10, y = 5, facing = "left" }
local POSTER = { x = 9, y = 4 }
-- DOWN, RIGHT, RIGHT, UP, RIGHT x4 from (9,5), ending on (15,5)
local AROUND = {
{ 9, 6 }, { 10, 6 }, { 11, 6 }, { 11, 5 },
{ 12, 5 }, { 13, 5 }, { 14, 5 }, { 15, 5 },
}
-- clean slate: he must not read as already defeated or already hidden
game.save.defeatedTrainers = {}
game.save.objectToggles = game.save.objectToggles or {}
game.save.objectToggles.GAME_CORNER = nil
game.save.player = game.save.player or {}
game.save.player.name = game.save.player.name or "RED"
game.save.money = game.save.money or 3000
-- a tank that one-shots OPP_ROCKET #7, so the mash win below is quick and
-- the same every run whatever the type matchups are
local tank = Pokemon.new(game.data, "MEWTWO", 100)
tank.moves = {
{ id = "PSYCHIC_M", pp = 99 },
{ id = "THUNDERBOLT", pp = 99 },
{ id = "ICE_BEAM", pp = 99 },
{ id = "EARTHQUAKE", pp = 99 },
}
game.save.party = { tank }
U.teleport(game, MAP, STAND.x, STAND.y, STAND.facing)
local ow = game.overworld
local function findGrunt()
for _, n in ipairs(ow.npcs or {}) do
if n.def and n.def.name == NAME then return n end
end
return nil
end
local grunt = findGrunt()
check("GAMECORNER_ROCKET is on the floor", grunt ~= nil)
if grunt then
check("he stands on (9,5)", grunt.cellX == GX and grunt.cellY == GY,
("at (%d,%d)"):format(grunt.cellX, grunt.cellY))
end
-- a map edit or a mod could take (10,5) away; anything east of him keeps
-- the WalkAroundPlayer branch, so fall back to a free walkable neighbour
-- and say which branch that lands on
local function facingGrunt()
local g = findGrunt()
if not g then return false end
local fx, fy = ow.player:facingCell()
return ow:npcAtCell(fx, fy) == g
end
if grunt and not facingGrunt() then
local sides = {
{ 1, 0, "left" }, { 0, 1, "up" }, { -1, 0, "right" }, { 0, -1, "down" },
}
for _, s in ipairs(sides) do
local cx, cy = grunt.cellX + s[1], grunt.cellY + s[2]
if ow.map:isWalkableCell(cx, cy) and not ow:npcAtCell(cx, cy) then
U.log(("(%d,%d) is blocked; standing on"):format(STAND.x, STAND.y),
cx, cy, "facing", s[3])
U.teleport(game, MAP, cx, cy, s[3])
ow = game.overworld
grunt = findGrunt()
break
end
end
end
check("the player is face to face with him", facingGrunt())
local px, py = ow.player.cellX, ow.player.cellY
local around = not (py == 6 or px == 8)
U.log(("talking from (%d,%d): the script should take %s"):format(
px, py, around and "WalkAroundPlayer (down, right, right, up, "
.. "right x4)" or "WalkDirect (right x5)"))
-- the two strings the fix depends on, and the poster cell the pre-fix
-- single UP step walked him into
local t = game.data.text
check("_GameCornerRocketBattleEndText resolves",
type(t._GameCornerRocketBattleEndText) == "string"
and t._GameCornerRocketBattleEndText ~= "",
tostring(t._GameCornerRocketBattleEndText))
check("_GameCornerRocketAfterBattleText resolves",
type(t._GameCornerRocketAfterBattleText) == "string"
and t._GameCornerRocketAfterBattleText ~= "")
check("(9,4) is the poster wall, not a cell he can stand on",
not ow.map:isWalkableCell(POSTER.x, POSTER.y))
-- engageTrainer has to accept the script-supplied loss line; a stale
-- two-parameter copy would silently drop it and print nothing
local info = debug.getinfo(ow.engageTrainer, "S")
local sigOk = false
if info and info.short_src then
local src = io.open((info.short_src:gsub("^@", "")), "r")
if src then
local n = 0
for line in src:lines() do
n = n + 1
if n == info.linedefined then
sigOk = line:find("endBattleText", 1, true) ~= nil
break
end
end
src:close()
end
end
check("engageTrainer takes an endBattleText argument", sigOk)
U.shot(game, DIR .. "/bug862_0_before.png")
-- Talk and mash to a win, recording every battle message in order and
-- pausing on the loss line long enough to photograph it.
local said, battle = {}, nil
local lastSaid, dangShot = nil, false
local function sample()
local top = game.stack:top()
if getmetatable(top) == BattleState then
battle = battle or top
local cur = top.current
local text = type(cur) == "table" and cur.text
if type(text) == "string" and text ~= lastSaid then
lastSaid = text
said[#said + 1] = text
U.log("battle says:", (text:gsub("\n", " ")))
end
end
end
local function pageText()
local top = game.stack:top()
if getmetatable(top) ~= TextBox then return "" end
local parts = {}
for _, page in ipairs(top.pages or {}) do
if type(page) == "table" then
for _, line in ipairs(page) do parts[#parts + 1] = tostring(line) end
end
end
return table.concat(parts, " ")
end
local function idle()
return game.stack:top() == ow and not ow.runner:isRunning()
and #ow.scriptMoves == 0 and not ow.transitioning
end
U.tap(game, "a")
local sawAfter = false
for f = 1, 4000 do
sample()
if pageText():find("hideout", 1, true) then sawAfter = true break end
local top = game.stack:top()
if lastSaid and lastSaid:find("Dang", 1, true) and not dangShot then
-- stop mashing for a moment: the loss line is on the battle screen.
-- The row is picked up the frame it starts typing, so let it finish
-- before the capture or the shot is one letter wide.
dangShot = true
U.wait(60)
U.shot(game, DIR .. "/bug862_1_dang.png")
elseif top and top.phase then
if top.phase == "menu" then top.menuIndex = 1
elseif top.phase == "moveSelect" then top.moveIndex = 1 end
U.tap(game, "a")
if f > 2400 and top.onFinish then
U.log("force-finishing a stalled battle")
top.onFinish("win")
if game.stack:top() == top then game.stack:pop() end
end
else
U.tap(game, "a")
end
U.wait(2)
sample()
end
check("reached the after-battle 'hideout' line", sawAfter)
check("the battle carried the script's loss line",
battle ~= nil and type(battle.endBattleText) == "string"
and battle.endBattleText:find("Dang", 1, true) ~= nil,
battle and tostring(battle.endBattleText) or "no battle seen")
-- PrintEndBattleText sits between TrainerDefeatedText and
-- MoneyForWinningText (engine/battle/core.asm TrainerBattleVictory)
local iDefeat, iDang, iMoney
for i, line in ipairs(said) do
if not iDefeat and line:find("defeated", 1, true) then iDefeat = i end
if not iDang and line:find("Dang", 1, true) then iDang = i end
if not iMoney and line:find("winning", 1, true) then iMoney = i end
end
check("the loss line printed on the battle screen", iDang ~= nil)
check("it printed with the ROCKET: name tag",
iDang ~= nil and said[iDang]:find(":", 1, true) ~= nil,
iDang and said[iDang] or "")
check("order is defeated -> Dang! -> payout",
iDefeat ~= nil and iDang ~= nil and iMoney ~= nil
and iDefeat < iDang and iDang < iMoney,
("defeated=%s dang=%s payout=%s"):format(tostring(iDefeat),
tostring(iDang),
tostring(iMoney)))
U.shot(game, DIR .. "/bug862_2_afterbattle.png")
-- Dismiss the after-battle box and watch the exit walk cell by cell.
U.tap(game, "a")
local visited, order, lowShot = {}, {}, false
local function mark(cx, cy)
local key = cx .. "," .. cy
if not visited[key] then
visited[key] = true
order[#order + 1] = key
end
end
-- the last step's hide_object rides its own onDone, so the grunt leaves
-- ow.npcs on the frame he lands: count the cell he is walking INTO as
-- visited too, or the destination never shows up in the sample
local last = { GX, GY }
for _ = 1, 900 do
local g = findGrunt()
if g then
mark(g.cellX, g.cellY)
last = { g.cellX, g.cellY }
if g.targetX and g.targetY then
mark(g.targetX, g.targetY)
last = { g.targetX, g.targetY }
end
if g.cellY > GY and not lowShot then
lowShot = true
U.shot(game, DIR .. "/bug862_3_walk.png")
end
elseif idle() then
break
end
if game.stack:top() ~= ow then U.tap(game, "a") end
U.wait(1)
end
for _ = 1, 400 do
if idle() then break end
if game.stack:top() ~= ow then U.tap(game, "a") end
U.wait(2)
end
U.wait(5)
U.shot(game, DIR .. "/bug862_4_gone.png")
U.log("cells he stood on:", table.concat(order, " "))
check("he never stood on the poster cell (9,4)",
not visited[POSTER.x .. "," .. POSTER.y])
check("he never stepped north of his start row", (function()
for key in pairs(visited) do
local y = tonumber(key:match(",(%d+)$"))
if y and y < GY then return false end
end
return true
end)())
if around then
check("he stepped down to (9,6) to get past the player", visited["9,6"])
check("he came back up onto row 5 and finished on (15,5)",
last[1] == 15 and last[2] == 5,
("last seen on (%d,%d)"):format(last[1], last[2]))
else
check("he walked straight along row 5 to (15,5)",
last[1] == 15 and last[2] == 5 and not visited["9,6"],
("last seen on (%d,%d)"):format(last[1], last[2]))
end
local toggles = game.save.objectToggles.GAME_CORNER
check("he despawned only after the last step", findGrunt() == nil)
check("his objectToggle is hidden",
toggles ~= nil and toggles.GAMECORNER_ROCKET == false)
check("he is recorded as defeated",
game.save.defeatedTrainers["GAME_CORNER_obj_11"] == true)
U.log(("checks: %d passed, %d failed"):format(pass, fail))
-- Hand the pad over on a clean copy of the same setup so the whole beat
-- can be watched at speed.
game.save.defeatedTrainers = {}
game.save.objectToggles.GAME_CORNER = nil
U.teleport(game, MAP, STAND.x, STAND.y, STAND.facing)
U.log("You are east of the grunt again, facing him. Press A and win.")
U.log("Right looks like: he says his piece on the battle screen after")
U.log("\"RED defeated ROCKET!\" -- one box, \"ROCKET: Dang!\" -- and the")
U.log("¥ payout comes after it, not before. Then the hideout line, then")
U.log("he steps DOWN off row 5, right past you, back up and out east.")
U.log("The near miss to watch for: he steps UP into the poster, or the")
U.log("Dang! box turns up in the overworld after the battle has torn down.")
U.log("Talk to him from (9,6) below instead and he takes the straight")
U.log("five-step version east; both are correct, the branch is your cell.")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,224 @@
-- Giovanni's Silph Co 11F coordinate trigger speaks BEFORE he walks (#869).
-- pokered scripts/SilphCo11F.asm SilphCo11FDefaultScript: DisplayTextID
-- TEXT_SILPHCO11F_GIOVANNI first, then MoveSprite .GiovanniMovement (3x down)
-- and EngageMapTrainer with no second box. Do not set POKEPORT_SPEED: the
-- box-vs-walk ordering is exactly the moment under test.
-- POKEPORT_DRIVER=tests/drivers/giovanni_silph11f_bug869_test.lua POKEPORT_IDENTITY=bug869 POKEPORT_TOUCH=0 POKEPORT_VERSION=red love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local Pokemon = require("src.pokemon.Pokemon")
local TextBox = require("src.render.TextBox")
local BattleTransition = require("src.render.BattleTransition")
local BattleState = require("src.battle.BattleState")
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
-- Positions from ../pokered/data/maps/objects/SilphCo11F.asm: Giovanni
-- object_event (6, 9), SILPHCO11F_ROCKET1 (3, 16). Trigger tiles from
-- ../pokered/scripts/SilphCo11F.asm .PlayerCoordsArray: (6, 13) and
-- (7, 12). data/generated/maps.lua stores the same cells 1:1.
local MAP = "SILPH_CO_11F"
local GIO_HOME = { x = 6, y = 9 }
local GIO_STOP = { x = 6, y = 12 } -- home + 3x NPC_MOVEMENT_DOWN
local failed = 0
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
if not ok then failed = failed + 1 end
return ok
end
-- party strong enough that the human can win the OPP_GIOVANNI#2 fight
-- and watch the unchanged aftermath (victories.lua "Arrgh!!", then the
-- "Blast it all!" speech and the rockets leaving)
game.save.party = {
Pokemon.new(game.data, "MEWTWO", 80),
Pokemon.new(game.data, "SNORLAX", 77),
Pokemon.new(game.data, "CHARIZARD", 70),
}
game.save.player.name = "RED"
-- (6,13) and (7,13) sit in the card-key doorway of the boss room: block
-- (3,6) stays the closed id 32 until EVENT_SILPH_CO_11_UNLOCKED_DOOR is
-- set (stampClosedDoors, mirroring pokered engine/events/card_key.asm),
-- and a closed door refuses the step this test needs. A real player has
-- opened it before the trigger can fire, so open it here too.
game.save.flags.EVENT_SILPH_CO_11_UNLOCKED_DOOR = true
check("EVENT_BEAT_SILPH_CO_GIOVANNI starts unset -- trigger is armed",
not game.save.flags.EVENT_BEAT_SILPH_CO_GIOVANNI)
local opts = game.save.options or {}
if (opts.sfxVol or 0) == 0 then
U.log("sfxVol is 0 -- the evil-trainer sting will be inaudible")
end
if (opts.musicVol or 0) == 0 then
U.log("musicVol is 0 -- the encounter sting and battle theme are muted")
end
local function findNpc(ow, name)
for _, n in ipairs(ow.npcs or {}) do
if n.def and n.def.name == name then return n end
end
return nil
end
local function topBox()
local t = game.stack:top()
if getmetatable(t) == TextBox then return t end
return nil
end
local function boxText(box)
local shown = {}
for _, page in ipairs(box.pages or {}) do
for _, line in ipairs(page) do shown[#shown + 1] = line end
end
return table.concat(shown, " / ")
end
-- Stand next to (tx, ty) and take one real walking step onto it; onStep
-- hooks fire on a finished step, so a bare teleport onto the tile would
-- prove nothing. `sides` are {dx, dy, facing} in preference order, each
-- checked for walkability so a map edit only degrades to the next side.
local function stepOnto(tx, ty, sides)
U.teleport(game, MAP, tx + sides[1][1], ty + sides[1][2], sides[1][3])
U.wait(10)
local ow = game.overworld
for _, s in ipairs(sides) do
local cx, cy = tx + s[1], ty + s[2]
if ow.map:isWalkableCell(cx, cy) and not ow:npcAtCell(cx, cy) then
if ow.player.cellX ~= cx or ow.player.cellY ~= cy then
U.teleport(game, MAP, cx, cy, s[3])
U.wait(10)
end
U.hold(game, s[3], 24)
U.wait(10)
return true
end
end
return false
end
-- Regression on the shared engageTrainer path first: an ordinary trainer
-- with no skipBattleText must still get its normal pre-battle box.
-- ROCKET1 faces up, so talk to him from above.
check("regression: reached ROCKET1's cell",
stepOnto(3, 15, { { 0, 1, "up" }, { 0, -1, "down" },
{ 1, 0, "left" }, { -1, 0, "right" } }))
do
local ow = game.overworld
local rocket = findNpc(ow, "SILPHCO11F_ROCKET1")
check("regression: ROCKET1 object loaded", rocket ~= nil)
if rocket then
-- walk down one so we face him from (3, 15)
local fx, fy = ow.player:facingCell()
if ow:npcAtCell(fx, fy) ~= rocket then
-- stepOnto left us adjacent to (3, 15); face the rocket directly
local dx = rocket.cellX - ow.player.cellX
local dy = rocket.cellY - ow.player.cellY
local face = (dy > 0 and "down") or (dy < 0 and "up")
or (dx > 0 and "right") or "left"
U.tap(game, face)
U.wait(10)
end
U.tap(game, "a")
U.wait(30)
local box = topBox()
check("regression: talking to ROCKET1 still opens the pre-battle box",
box ~= nil)
if box then
local t = boxText(box)
U.log("rocket box reads:", t)
check("regression: it is his battle line (\"Stop right there!\")",
t:find("Stop right there", 1, true) ~= nil)
end
end
end
-- Both trigger tiles must fire with Giovanni still at his desk. The
-- (7, 12) probe is abandoned before the box is dismissed (the teleport
-- rebuilds the map state), so the trigger re-arms for the main run --
-- vanilla re-arms too, since only a win sets the event flag.
do
check("(7,12) approach: stepped onto the trigger from the right",
stepOnto(7, 12, { { 1, 0, "left" }, { 0, 1, "up" },
{ -1, 0, "right" } }))
local box = topBox()
check("(7,12) approach: intro box opened", box ~= nil)
local gio = findNpc(game.overworld, "SILPHCO11F_GIOVANNI")
check("(7,12) approach: Giovanni is still at his desk (6,9)",
gio ~= nil and gio.cellX == GIO_HOME.x and gio.cellY == GIO_HOME.y)
end
-- Main run, the route the issue screenshots show: (6,15) facing up, two
-- steps onto (6,13).
U.teleport(game, MAP, 6, 15, "up")
U.wait(10)
U.hold(game, "up", 24)
U.hold(game, "up", 24)
U.wait(15)
if not topBox() then
-- blocked approach fallback: one step onto (6,13) from any free side
stepOnto(6, 13, { { 0, 1, "up" }, { -1, 0, "right" }, { 1, 0, "left" } })
end
local ow = game.overworld
local gio = findNpc(ow, "SILPHCO11F_GIOVANNI")
check("Giovanni object loaded on " .. MAP, gio ~= nil)
local box = topBox()
check("stepping onto (6,13) opened a text box", box ~= nil)
if box then
local t = boxText(box)
U.log("intro box reads:", t)
check("it is the Giovanni intro (\"So we meet again!\")",
t:find("So we meet again", 1, true) ~= nil)
end
check("the box opened with Giovanni STILL at his desk (6,9) -- the fix",
gio ~= nil and gio.cellX == GIO_HOME.x and gio.cellY == GIO_HOME.y)
U.shot(game, SHOT_DIR .. "/bug869_box_before_walk.png")
U.wait(30)
check("he holds the desk for the whole box, not just its first frame",
gio ~= nil and gio.cellX == GIO_HOME.x and gio.cellY == GIO_HOME.y)
-- dismiss every page; the walk and the battle must follow with NO
-- further dialogue box in between (EngageMapTrainer runs bare in the
-- original, so engageTrainer is called with skipBattleText here)
for _ = 1, 300 do
if not topBox() then break end
U.tap(game, "a")
U.wait(5)
end
check("intro box dismissed", topBox() == nil)
local sawSecondBox, battleReached = false, false
for _ = 1, 900 do
local t = game.stack:top()
local mt = getmetatable(t)
if mt == TextBox and not sawSecondBox then
sawSecondBox = true
U.log("unexpected box reads:", boxText(t))
end
if mt == BattleTransition or mt == BattleState then
battleReached = true
break
end
U.wait(1)
end
check("battle wipe started after the box", battleReached)
check("no second dialogue box between the walk and the battle", not sawSecondBox)
check("Giovanni walked the three tiles down to (6,12) first",
gio ~= nil and gio.cellX == GIO_STOP.x and gio.cellY == GIO_STOP.y)
U.log(failed == 0 and "PASS all machine checks clean"
or ("FAIL " .. failed .. " machine check(s) above"))
U.log("The battle wipe is running now; take the pad and win the fight.")
U.log("Right looks like what just played: his speech opened while he was")
U.log("behind the desk, then he walked down and the fight began straight")
U.log("away, with the evil-trainer sting and no extra dialogue. After the")
U.log("win you should get \"Arrgh!!\" on the battle screen, the \"Blast it")
U.log("all!\" speech, a fade, and every rocket gone. Wrong is the old bug:")
U.log("he crosses the room in silence and only then talks, point-blank.")
while true do
coroutine.yield()
end
end
+177
View File
@@ -0,0 +1,177 @@
-- Manual check of the Rocket Hideout B4F Jessie & James ambush: James walks
-- the full four tiles to the player's side (#865) and their loss line prints
-- on the battle screen before the prize money (#866).
-- pokeyellow scripts/RocketHideoutB4F.asm (MovementData_45605 falls through
-- into _45606) and data/maps/objects/RocketHideoutB4F.asm. No fast-forward:
-- POKEPORT_DRIVER=tests/drivers/jessie_james_bug866_test.lua POKEPORT_VERSION=yellow love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local Pokemon = require("src.pokemon.Pokemon")
local BattleState = require("src.battle.BattleState")
local Commands = require("src.script.Commands")
local GameVersion = require("src.core.GameVersion")
local mapScripts = require("data.scripts.init")
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local MAP = "ROCKET_HIDEOUT_B4F"
local BEAT = "EVENT_BEAT_ROCKET_HIDEOUT_4_JESSIE_JAMES"
local JAMES, JESSIE = "ROCKETHIDEOUTB4F_JAMES", "ROCKETHIDEOUTB4F_JESSIE"
-- RocketHideoutB4FScript_455a5 fires on wYCoord $e with wXCoord $18 or $19.
-- x=24 leaves EVENT_ROCKET_HIDEOUT_4_JESSIE_JAMES_ON_LEFT clear, which is
-- the branch that hands the four-step blob to James (object 2, spawned at
-- 25,10) and the three-step one to Jessie (object 3, at 24,10).
local TRIGGER = { x = 24, y = 14 }
local EXPECT = {
[JAMES] = { x = 25, y = 14, facing = "left" },
[JESSIE] = { x = 24, y = 13, facing = "down" },
}
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
return ok
end
check("running the Yellow cache (the duo exists nowhere else)",
GameVersion.isYellow())
if not GameVersion.isYellow() then
U.log("re-run with POKEPORT_VERSION=yellow; nothing below will be true")
end
local hooks = mapScripts.get(MAP)
check("yellow_jessie_james registered an onStep for " .. MAP,
type(hooks) == "table" and type(hooks.onStep) == "function")
check("their talk entries are registered too",
type(hooks) == "table" and type(hooks.talk) == "table"
and hooks.talk.TEXT_ROCKETHIDEOUTB4F_JAMES ~= nil
and hooks.talk.TEXT_ROCKETHIDEOUTB4F_JESSIE ~= nil)
-- the #866 fix is a new script verb; if a mod shadowed it or the registry
-- never picked it up, the row would silently no-op and the line would come
-- back after the money instead of before it
local verb = Commands.resolve(game.data, "save_end_battle_text")
check("save_end_battle_text resolves as a script verb", type(verb) == "function")
local texts = {}
for i = 1, 4 do
local key = "_RocketHideoutJessieJamesText" .. i
texts[i] = game.data.text[key]
check(key .. " resolves to a string",
type(texts[i]) == "string" and texts[i] ~= "")
end
if type(texts[3]) == "string" then
U.log("the armed loss line reads:", (texts[3]:gsub("\n", " / ")))
end
local objs = (game.data.maps[MAP] or {}).objects or {}
local defs = {}
for _, o in ipairs(objs) do
if o.name == JAMES or o.name == JESSIE then defs[o.name] = o end
end
check("James is object 2 of " .. MAP .. ", hidden at (25,10)",
defs[JAMES] ~= nil and defs[JAMES].index == 2
and defs[JAMES].x == 25 and defs[JAMES].y == 10
and defs[JAMES].hidden == true)
check("Jessie is object 3, hidden at (24,10)",
defs[JESSIE] ~= nil and defs[JESSIE].index == 3
and defs[JESSIE].x == 24 and defs[JESSIE].y == 10
and defs[JESSIE].hidden == true)
local rocket = game.data.trainers.OPP_ROCKET
check("OPP_ROCKET party 43 (the duo's shared team) exists",
rocket ~= nil and rocket.parties ~= nil and rocket.parties[43] ~= nil)
-- arm the site: the ambush is gated only on its beat flag, so no story
-- progress is needed to make it live
game.save.flags[BEAT] = nil
game.save.flags.EVENT_ROCKET_HIDEOUT_4_JESSIE_JAMES_ON_LEFT = nil
check(BEAT .. " cleared, so the trigger is live",
game.save.flags[BEAT] == nil)
-- a real party, because the human has to win the battle for the loss line
-- to print at all
game.save.party = {
Pokemon.new(game.data, "CHARIZARD", 60),
Pokemon.new(game.data, "NIDOKING", 58),
Pokemon.new(game.data, "STARMIE", 58),
}
game.save.player.name = "RED"
-- walk in from the north; the two elevator warps sit on row 15, so the
-- approach cannot come from below
U.teleport(game, MAP, TRIGGER.x, TRIGGER.y - 1, "down")
local ow = game.overworld
if not ow.map:isWalkableCell(TRIGGER.x, TRIGGER.y - 1) then
-- a map edit moved the free cell: any walkable neighbour of the trigger
-- works, the script only reads the tile the player lands on
local sides = { { 0, -1, "down" }, { -1, 0, "right" }, { 1, 0, "left" } }
for _, s in ipairs(sides) do
local cx, cy = TRIGGER.x + s[1], TRIGGER.y + s[2]
if ow.map:isWalkableCell(cx, cy) then
U.log("standing on", cx, cy, "facing", s[3], "instead")
U.teleport(game, MAP, cx, cy, s[3])
ow = game.overworld
U.hold(game, s[3] == "down" and "down" or (s[3] == "right" and "right" or "left"), 20)
break
end
end
else
U.hold(game, "down", 20)
end
U.wait(10)
check("player stepped onto the trigger tile (24,14)",
ow.player.cellX == TRIGGER.x and ow.player.cellY == TRIGGER.y)
check("the ambush script is running", ow.runner:isRunning())
U.log("The cutscene is yours now: press A to read, then fight and win.")
U.log("Right looks like both Rockets closing in -- Jessie stopping one tile")
U.log("above you, James coming all the way down to stand at your right -- and")
U.log("after you win, \"ROCKET: Such a dreadful twerp!\" appearing on the")
U.log("battle screen just before the money line. The near-miss to watch for")
U.log("is James halting three tiles up by the wall, or that line showing up")
U.log("in the overworld box after the payout with no ROCKET: tag on it.")
U.log("Two more checks print below as you get to them.")
local function npcNamed(name)
for _, n in ipairs(game.overworld and game.overworld.npcs or {}) do
if n.def and n.def.name == name then return n end
end
return nil
end
local approachDone, battleSeen = false, false
while true do
if not approachDone then
local j, s = npcNamed(JAMES), npcNamed(JESSIE)
local ow2 = game.overworld
if j and s and not j.moving and not s.moving and ow2
and #(ow2.scriptMoves or {}) == 0
and (j.cellY > 10 or s.cellY > 10) then
approachDone = true
check("James walked the full four tiles to (25,14) facing left",
j.cellX == EXPECT[JAMES].x and j.cellY == EXPECT[JAMES].y
and j.facing == EXPECT[JAMES].facing)
check("Jessie stopped three down at (24,13) facing the player",
s.cellX == EXPECT[JESSIE].x and s.cellY == EXPECT[JESSIE].y
and s.facing == EXPECT[JESSIE].facing)
U.log("James at", j.cellX, j.cellY, j.facing,
"Jessie at", s.cellX, s.cellY, s.facing)
U.shot(game, SHOT_DIR .. "/jj866_approach.png")
end
end
if not battleSeen then
local top = game.stack:top()
if getmetatable(top) == BattleState then
battleSeen = true
-- BattleState prints endBattleText between _TrainerDefeatedText and
-- _MoneyForWinningText, so an armed field IS the ordering fix
check("the battle carries the loss line as its end-battle text",
type(top.endBattleText) == "string" and top.endBattleText ~= ""
and top.endBattleText == texts[3])
if type(top.endBattleText) == "string" then
U.log("armed:", (top.endBattleText:gsub("\n", " / ")))
end
end
end
coroutine.yield()
end
end
@@ -0,0 +1,188 @@
-- Manual check of the ghost MAROWAK send-off on POKEMON_TOWER_6F (#867).
-- PokemonTower6FMarowakDepartedText (pokered scripts/PokemonTower6F.asm) is
-- two texts: the CUBONE's-mother line, then PlayCry RESTLESS_SOUL + 30 frames
-- before the calmed line; the port showed only the calmed line and no cry.
-- Never under POKEPORT_SPEED -- the cry-then-text beat is the thing under test.
-- POKEPORT_DRIVER=tests/drivers/marowak_departed_bug867_test.lua POKEPORT_IDENTITY=bug867 POKEPORT_TOUCH=0 SHOT_DIR=/tmp/shots love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local Pokemon = require("src.pokemon.Pokemon")
local BattleState = require("src.battle.BattleState")
local TextBox = require("src.render.TextBox")
local pass, fail = 0, 0
local function check(label, ok)
if ok then pass = pass + 1 else fail = fail + 1 end
U.log(ok and "PASS" or "FAIL", label)
return ok
end
-- ---- machine checks ----------------------------------------------------
-- Both keys come out of the stock extractor (data/generated/text.lua); a
-- rename there would drop story3.lua onto its hand fallbacks, which still
-- displays but is worth knowing about.
local mother = game.data.text._PokemonTower6FGhostWasCubonesMotherText
local calmed = game.data.text._PokemonTower6FSoulWasCalmedText
check("_PokemonTower6FGhostWasCubonesMotherText extracted",
type(mother) == "string" and mother ~= "")
check("_PokemonTower6FSoulWasCalmedText extracted",
type(calmed) == "string" and calmed ~= "")
if type(mother) == "string" then
U.log("first line reads:", (mother:gsub("[\n\011\012]", " / ")))
end
if type(calmed) == "string" then
U.log("second line reads:", (calmed:gsub("[\n\011\012]", " / ")))
end
check("MAROWAK is a real species (RESTLESS_SOUL EQU MAROWAK)",
game.data.pokemon.MAROWAK ~= nil)
local opts = game.save.options or {}
U.log("sfxVol", tostring(opts.sfxVol), "musicVol", tostring(opts.musicVol))
if opts.sfxVol == 0 then
U.log("sfxVol is 0: raise it in OPTION or the cry cannot be judged")
end
-- ---- reach the trigger -------------------------------------------------
-- pokered scripts/PokemonTower6F.asm PokemonTower6FMarowakCoords:
-- dbmapcoord 10, 16 (a coord array, not an object). Row 17 is solid wall
-- and (9, 16) is the stairwell warp, so the approach is from (10, 15)
-- facing down, same as tests/drivers/ghost_unveil_bug492_test.lua.
local MAP = "POKEMON_TOWER_6F"
local TRIGGER = { x = 10, y = 16 }
local STAND = { x = 10, y = 15, facing = "down", step = "down" }
-- one mon, one damaging move: the A-mash below always picks FIGHT slot 1,
-- and a stat move there stalls the run (route.lua learned this the hard way)
local mon = Pokemon.new(game.data, "MEWTWO", 100)
if game.data.moves.PSYCHIC_M then
mon.moves = { { id = "PSYCHIC_M", pp = 99 } }
end
game.save.party = { mon }
game.save.player.name = "RED"
-- the scope buys the unveil so the ghost can be damaged at all (#492)
game.save.inventory.SILPH_SCOPE = 1
game.save.flags.EVENT_BEAT_GHOST_MAROWAK = nil
U.teleport(game, MAP, STAND.x, STAND.y, STAND.facing)
U.wait(10)
local ow = game.overworld
check("the overworld is up on " .. MAP, ow ~= nil and ow.map ~= nil)
if ow and ow.map and not ow.map:isWalkableCell(STAND.x, STAND.y) then
-- a map edit moved the approach: stand on any walkable neighbour of the
-- trigger that is not the stairwell warp and step back onto it.
-- {dx, dy, facing} is the trigger-to-stand offset plus the direction
-- that walks back onto the trigger cell.
local sides = { { 0, -1, "down" }, { 1, 0, "left" },
{ -1, 0, "right" }, { 0, 1, "up" } }
for _, s in ipairs(sides) do
local cx, cy = TRIGGER.x + s[1], TRIGGER.y + s[2]
if ow.map:isWalkableCell(cx, cy) and not ow.map:warpAtCell(cx, cy) then
U.log(("(%d, %d) is blocked, approaching from"):format(STAND.x, STAND.y),
cx, cy, "stepping", s[3])
STAND = { x = cx, y = cy, facing = s[3], step = s[3] }
U.teleport(game, MAP, cx, cy, s[3])
U.wait(10)
ow = game.overworld
break
end
end
end
-- walk onto the trigger; MapScripts onStep fires on the completed step
U.hold(game, STAND.step, 20)
U.wait(20)
check("the Be-gone text opened", game.stack:top() ~= game.overworld)
-- ---- win the battle ----------------------------------------------------
local sawBattle = false
for _ = 1, 1500 do
-- onFinish sets the flag and queues the departed rows in the same call,
-- so break on the flag BEFORE tapping: a stray A here would eat the
-- CUBONE's-mother box before it is recorded
if game.save.flags.EVENT_BEAT_GHOST_MAROWAK then break end
if getmetatable(game.stack:top()) == BattleState then sawBattle = true end
U.tap(game, "a")
U.wait(4)
end
check("the MAROWAK battle opened", sawBattle)
check("the battle was won (EVENT_BEAT_GHOST_MAROWAK set)",
game.save.flags.EVENT_BEAT_GHOST_MAROWAK == true)
-- ---- record the send-off boxes -----------------------------------------
-- Each box is sampled the frame it is first seen: the calmed box carries
-- the armed cry as opts.auto {sound, wait} (src/script/Commands.lua), and
-- TextBox clears .auto once the cry has played, so a late read looks like
-- no cry at all.
local boxes = {}
local lastBox = nil
local budget = 1200
while budget > 0 do
local top = game.stack:top()
if getmetatable(top) == TextBox then
if top ~= lastBox then
lastBox = top
local shown = {}
for _, page in ipairs(top.pages or {}) do
for _, line in ipairs(page) do shown[#shown + 1] = line end
end
boxes[#boxes + 1] = {
text = table.concat(shown, " / "),
cry = top.auto ~= nil and top.auto.sound ~= nil,
}
U.log(("box %d reads:"):format(#boxes), boxes[#boxes].text)
-- let the typewriter finish before the shot so the capture shows the
-- line; the auto sample above already happened on the open frame
for _ = 1, 240 do
if top.waiting or top.done or game.stack:top() ~= top then break end
U.wait(1)
budget = budget - 1
end
U.shot(game, DIR .. ("/bug867_box%d.png"):format(#boxes))
end
U.tap(game, "a")
U.wait(3)
budget = budget - 4
else
if #boxes >= 2 then break end
U.wait(1)
budget = budget - 1
end
end
check("the send-off is two boxes, not one (#867)", #boxes == 2)
check("box 1 is the CUBONE's-mother line",
boxes[1] ~= nil and boxes[1].text:find("CUBONE", 1, true) ~= nil)
check("box 1 opens silent (the asm plays no cry before it)",
boxes[1] ~= nil and not boxes[1].cry)
check("box 2 is the calmed line",
boxes[2] ~= nil and boxes[2].text:find("calmed", 1, true) ~= nil)
check("box 2 opens with the MAROWAK cry armed",
boxes[2] ~= nil and boxes[2].cry == true)
-- ---- the trigger is spent ----------------------------------------------
-- step off and back onto (10, 16): with the flag set, onStep must pass
local back = ({ down = "up", up = "down", left = "right", right = "left" })
[STAND.step]
U.hold(game, back, 20)
U.wait(10)
U.hold(game, STAND.step, 20)
U.wait(20)
check("re-stepping the trigger cell stays quiet",
getmetatable(game.stack:top()) ~= TextBox)
U.shot(game, DIR .. "/bug867_after.png")
U.log(("machine checks: %d passed, %d failed"):format(pass, fail))
-- ---- hand off ----------------------------------------------------------
U.log("The pad is yours on 6F with the ghost already sent off. What should")
U.log("have happened: after the win, \"The GHOST was the / restless soul of /")
U.log("CUBONE's mother!\" first, then the MAROWAK cry sounds as the second box")
U.log("opens with \"The mother's soul / was calmed.\" The old bug jumped")
U.log("straight to the calmed line, no mother line and no cry at all.")
U.log("Screenshots: " .. DIR .. "/bug867_*.png")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,164 @@
-- Manual check that a warp arrival hides Pikachu under the player (#863):
-- pokeyellow spawns on the player's own coords and the follow buffer walks
-- it out, but before the fix it popped in already beside him.
-- Warp cells: pokered data/maps/objects/RedsHouse1F.asm / RedsHouse2F.asm.
-- POKEPORT_DRIVER=tests/drivers/pikachu_warp_spawn_bug863_test.lua POKEPORT_IDENTITY=bug863 POKEPORT_TOUCH=0 POKEPORT_VERSION=yellow love .
-- Never add POKEPORT_SPEED; the identity needs an imported Yellow cache.
return function(game)
local U = dofile("tests/drivers/util.lua")
local Pokemon = require("src.pokemon.Pokemon")
local GameVersion = require("src.core.GameVersion")
local PF = require("src.world.PikachuFollower")
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
return ok
end
check("running as Yellow (needs POKEPORT_VERSION=yellow)",
GameVersion.isYellow())
-- the follower only spawns behind EVENT_GOT_STARTER with a healthy
-- PIKACHU in the party (PikachuFollower shouldSpawn)
game.save.flags = game.save.flags or {}
game.save.flags.EVENT_GOT_STARTER = true
game.save.party = { Pokemon.new(game.data, "PIKACHU", 20) }
game.save.onBike = false
game.save.player.name = "bryan"
-- pokered RedsHouse1F.asm: warp_event 7, 1 -> REDS_HOUSE_2F, and
-- RedsHouse2F.asm: warp_event 7, 1 back down. Read the live map data
-- so a hack or mod that moved the stairs still points us at them.
local function warpTo(fromMap, destMap)
local def = game.data.maps[fromMap]
for _, w in ipairs(def and def.warps or {}) do
if w.destMap == destMap then return w.x, w.y end
end
return nil
end
local wx, wy = warpTo("REDS_HOUSE_1F", "REDS_HOUSE_2F")
check("REDS_HOUSE_1F has a warp to REDS_HOUSE_2F", wx ~= nil)
wx, wy = wx or 7, wy or 1
local follower = function() return PF.current(game.overworld) end
local function overlapsPlayer()
local npc = follower()
local p = game.overworld and game.overworld.player
return npc and p and npc.cellX == p.cellX and npc.cellY == p.cellY
end
-- press-and-hold dir until the map flips, releasing the instant it
-- does so no queued step drags the player off the arrival warp cell
local function walkUntilMap(dir, targetMap, maxFrames)
for _ = 1, maxFrames do
local ow = game.overworld
if ow and ow.map and ow.map.id == targetMap then break end
table.insert(game.input.pressQueue, dir)
game.input.state[dir] = true
coroutine.yield()
end
game.input.state[dir] = false
U.wait(45) -- warp fade + arrival settle
local ow = game.overworld
return ow and ow.map and ow.map.id == targetMap
end
-- stand two below the stairs facing up; fall back to any walkable cell
-- below the warp if a mod reshaped the room
local sx, sy = wx, wy + 2
U.teleport(game, "REDS_HOUSE_1F", sx, sy, "up")
U.wait(10)
local ow = game.overworld
if not ow.map:isWalkableCell(sx, sy) then
for dy = 1, 3 do
if ow.map:isWalkableCell(wx, wy + dy) then
sx, sy = wx, wy + dy
U.teleport(game, "REDS_HOUSE_1F", sx, sy, "up")
U.wait(10)
break
end
end
end
-- U.teleport is itself a fresh map load, so the fixed spawn already
-- parks Pikachu on the player's cell here
check("follower spawned on map load", follower() ~= nil)
check("map-load spawn is on the player's own cell", overlapsPlayer())
-- climb the stairs
check("walked up into REDS_HOUSE_2F",
walkUntilMap("up", "REDS_HOUSE_2F", 240))
check("warp arrival upstairs: Pikachu hidden under the player",
overlapsPlayer())
U.shot(game, SHOT_DIR .. "/bug863_2f_arrival.png")
-- the draw sort tie-break (#863): sharing the player's py must list the
-- follower first so he draws over it. The sort runs in draw, and the
-- shot above rendered a frame, so entities order is post-sort here.
do
local npc = follower()
local p = game.overworld.player
if npc and p and npc.py == p.py then
local ni, pi
for i, e in ipairs(game.overworld.entities) do
if e == npc then ni = i elseif e == p then pi = i end
end
check("draw sort puts the hidden follower under the player",
ni ~= nil and pi ~= nil and ni < pi)
end
end
-- walk off the stairs: the trail should pull Pikachu out one behind
U.hold(game, "down", 20)
U.wait(20)
U.hold(game, "down", 20)
U.wait(30)
do
local npc = follower()
local p = game.overworld.player
check("two steps later Pikachu trails one cell behind",
npc and p and npc.cellX == p.cellX and npc.cellY == p.cellY - 1)
check("and it faces down, walking out of the stairwell",
npc and npc.facing == "down")
end
U.shot(game, SHOT_DIR .. "/bug863_2f_trailing.png")
-- back down the same stairs: descent must hide it the same way
check("walked back down into REDS_HOUSE_1F",
walkUntilMap("up", "REDS_HOUSE_1F", 240))
check("warp arrival downstairs: Pikachu hidden under the player",
overlapsPlayer())
U.shot(game, SHOT_DIR .. "/bug863_1f_return.png")
-- regression: a connection seam is the keepPikachu path (#427), not a
-- respawn, so the follower must ride across it, not vanish or repark
U.teleport(game, "PALLET_TOWN", 10, 2, "up")
U.wait(10)
check("crossed the Pallet Town north seam into ROUTE_1",
walkUntilMap("up", "ROUTE_1", 300))
do
local npc = follower()
local p = game.overworld.player
check("follower survived the connection crossing", npc ~= nil)
check("and stayed within trailing range of the player",
npc and p and math.abs(npc.cellX - p.cellX)
+ math.abs(npc.cellY - p.cellY) <= 2)
end
U.shot(game, SHOT_DIR .. "/bug863_route1_seam.png")
local sfx = game.save.options and game.save.options.sfxVol
if sfx == 0 then
U.log("note: sfxVol is 0, Pikachu's steps and voice will be silent")
end
U.log("The shots above tell the story: on both stair arrivals only the")
U.log("player should be visible, Pikachu is tucked under him until he")
U.log("steps away, then it follows one cell behind facing his way.")
U.log("If a Pikachu sits beside him the moment a warp lands, that is")
U.log("the old bug. The pad is yours; warp around and watch spawns.")
while true do
coroutine.yield()
end
end
@@ -0,0 +1,149 @@
-- Manual check of the title main menu + CONTINUE info box colors (#870):
-- both must follow the COLORS display mode (CLASSIC pea greens) instead of
-- staying a raw white trueColor hole, while gbc keeps #133's white paper /
-- black ink (pokered engine/menus/main_menu.asm RunDefaultPaletteCommand).
-- Palette shading is the moment under test, so POKEPORT_SPEED stays unset.
-- POKEPORT_DRIVER=tests/drivers/title_menu_palette_bug870_test.lua POKEPORT_IDENTITY=bug870 POKEPORT_TOUCH=0 POKEPORT_VERSION=red love .
return function(game)
local U = dofile("tests/drivers/util.lua")
local P = require("src.render.PaletteFX")
local SHOT_DIR = os.getenv("SHOT_DIR") or "/tmp/shots"
local fails = 0
local function check(label, ok)
U.log(ok and "PASS" or "FAIL", label)
if not ok then fails = fails + 1 end
return ok
end
-- Count near-white pixels in a captured frame. CLASSIC's lightest shade
-- is (155,188,15) and no blend of the four pea greens (or the letterbox)
-- reaches 250+, so any white here can only be an unshaded region -- the
-- exact white hole #870 is about. Reads the PNG back through
-- love.image so the check sees what actually hit the window.
local function whiteCount(path)
local f = io.open(path, "rb")
if not f then return nil end
local bytes = f:read("*a")
f:close()
local ok, img = pcall(function()
return love.image.newImageData(
love.filesystem.newFileData(bytes, "shot.png"))
end)
if not ok or not img then return nil end
local n = 0
for y = 0, img:getHeight() - 1 do
for x = 0, img:getWidth() - 1 do
local r, g, b = img:getPixel(x, y)
if r > 0.98 and g > 0.98 and b > 0.98 then n = n + 1 end
end
end
return n
end
-- A real save on disk first: hasSave in TitleState:openMenu checks the
-- save FILE, not the in-memory table, and only then lists CONTINUE.
-- No map coordinates anywhere in this test -- the bug lives on the title
-- screen, before any map.
U.newGame(game)
check("reached the overworld", game.overworld ~= nil)
check("save written so the menu lists CONTINUE",
require("src.core.SaveData").save(game.save))
-- flip COLORS the way the options screen does, then power-cycle to the
-- title (returnToTitle skips the intro movie, unlike a cold boot)
game.save.options.colors = "classic"
P.applyOptions(game.save.options)
game:returnToTitle()
U.wait(30)
local TitleState = require("src.ui.TitleState")
local title = game.stack:top()
check("back on the title screen", getmetatable(title) == TitleState)
U.tap(game, "start")
U.wait(10)
local menu = game.stack:top()
check("main menu opened and set a titleUiBox",
menu ~= title and menu ~= nil and menu.titleUiBox ~= nil)
-- The fix itself: the box overlay must be a GRAYS palette zone the shade
-- shader runs on. A colors == false zone would make Renderer:blitCanvas
-- re-blit the rect with NO shader, so effectiveColors never substitutes
-- the mono/inverted modes there -- the pre-#870 white hole.
local zones = title.sgbPalettes and title:sgbPalettes(game)
local boxZone, bare = nil, false
for _, z in ipairs(zones or {}) do
if z.colors == false then bare = true end
if z.colors == P.GRAYS then boxZone = z end
end
check("no trueColor (colors == false) zone over the menu box", not bare)
check("the titleUiBox rides a GRAYS palette zone", boxZone ~= nil)
-- effectiveColors under classic substitutes CLASSIC; the trailing
-- permute is the identity while no shade map is armed, so == holds
check("CLASSIC substitutes the GRAYS box zone",
P.effectiveColors(P.GRAYS) == P.CLASSIC)
local shot1 = SHOT_DIR .. "/bug870_menu_classic.png"
if U.shot(game, shot1) then
local n = whiteCount(shot1)
U.log("white pixels in the menu shot:", tostring(n))
check("CLASSIC main menu shot has zero raw-white pixels",
n ~= nil and n == 0)
end
-- with a save present CONTINUE is first, so the cursor is already on it
U.tap(game, "a")
U.wait(10)
local info = game.stack:top()
check("CONTINUE info box open with its titleUiBox",
info ~= nil and info ~= menu and info.titleUiBox ~= nil
and info.titleUiBox[1] == 4 and info.titleUiBox[2] == 7)
local shot2 = SHOT_DIR .. "/bug870_info_classic.png"
if U.shot(game, shot2) then
local n = whiteCount(shot2)
U.log("white pixels in the info shot:", tostring(n))
check("CLASSIC CONTINUE info shot has zero raw-white pixels",
n ~= nil and n == 0)
end
-- #133 regression gate: under gbc the GRAYS zone must pass through the
-- shader unchanged, so the box comes back white paper / black ink while
-- the LOGO zones keep the title colored around it
P.applyOptions({ colors = "gbc" })
U.wait(5)
check("gbc leaves the GRAYS box zone alone (the #133 white box)",
P.effectiveColors(P.GRAYS) == P.GRAYS)
local shot3 = SHOT_DIR .. "/bug870_info_gbc.png"
if U.shot(game, shot3) then
local n = whiteCount(shot3)
U.log("white pixels in the gbc shot:", tostring(n))
check("gbc info box paper is white again", n ~= nil and n > 0)
end
-- the inverted modes must now invert the box with the screen too
P.applyOptions({ colors = "og_inv" })
U.wait(5)
local inv = P.effectiveColors(P.GRAYS)
check("OG INV inverts the box paper to black",
inv ~= nil and inv[1] ~= nil and inv[1][1] == 0)
U.shot(game, SHOT_DIR .. "/bug870_info_oginv.png")
-- hand over in the bug's own mode
game.save.options.colors = "classic"
P.applyOptions(game.save.options)
U.wait(2)
U.log(fails == 0 and "PASS all machine checks"
or ("FAIL " .. fails .. " machine check(s), see above"))
U.log("The CONTINUE info box on screen is in CLASSIC now; its paper should")
U.log("be the same pea green as the title behind it, with dark green ink,")
U.log("just like the in-game START menu. Before #870 this box and the")
U.log("main menu were a pure white rectangle over the green title.")
U.log("B backs out to the menu; OPTION flips COLORS to eyeball the rest.")
while true do
coroutine.yield()
end
end
+211
View File
@@ -0,0 +1,211 @@
-- Disable blocks the move the slower mon ALREADY selected, on the very
-- turn the Disable lands (#860). pokered runs the test at execution
-- time, not at selection time: CheckPlayerStatusConditions
-- .TriedToUseDisabledMoveCheck (engine/battle/core.asm:3437-3447) compares
-- wPlayerDisabledMoveNumber against wPlayerSelectedMove and jumps to
-- ExecutePlayerMoveDone when they match -- "prevents a disabled move that
-- was selected before being disabled from being used", in the asm's own
-- comment. The enemy copy is .checkIfTriedToUseDisabledMove
-- (core.asm:5752+). The port only refused a disabled move at menu time,
-- so the second mover still fired the move it had latched before the
-- Disable resolved.
--
-- The check sits after the confusion block and before the paralysis roll,
-- so this suite also pins the neighbours: the counter tick that clears an
-- expired Disable still runs first, and a move that was never disabled is
-- untouched.
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.modkit")
local Data = T.fixtures.fresh()
local Font = require("src.render.Font")
Font.load(Data)
local BattleState = require("src.battle.BattleState")
local Pokemon = require("src.pokemon.Pokemon")
local SaveData = require("src.core.SaveData")
local TypeChart = require("src.battle.TypeChart")
TypeChart.load(Data)
-- the fixture dataset has no status move; this dataset is this file's own
-- copy (fixtures.fresh), so registering one here cannot leak into another
-- case. Accuracy 100 keeps DisableEffect's MoveHitTest out of the way.
Data.moves.FIX_DISABLE = {
id = "FIX_DISABLE", index = 90, name = "FIX DISABLE",
type = "NORMAL", power = 0, accuracy = 100, pp = 20,
effect = "DISABLE_EFFECT",
}
-- Deterministic rolls: the minimum of every range, except DisableEffect's
-- own "1-8 turns disabled" roll (effects.asm:1343-1345), which is pinned
-- at 4. A rolled 1 would be spent by the disabled mon's own counter tick
-- in the same CheckStatusConditions pass -- vanilla behaviour, but it
-- clears the disable before .TriedToUseDisabledMoveCheck can see it, so it
-- is not the case this suite is about. rng(0, 255) -> 0 makes every
-- accuracy roll hit.
local function rolls(disableTurns)
return function(a, b)
if a == 1 and b == 8 then return disableTurns end
if a then return a end
return 0
end
end
-- playerFirst decides who lands the Disable; the other side is the one
-- whose already-selected move has to die. Both mons get FIX_TACKLE in
-- slot 1 (the slot DisableEffect picks with the min roll) and FIX_SCRATCH
-- in slot 2 as the never-disabled control.
local function newBattle(playerFirst, disableTurns)
local save = SaveData.newGame()
save.party = { Pokemon.new(Data, "FIXMON_A", 30) }
local game = { data = Data, save = save,
stack = { top = function() return nil end, push = function() end } }
local battle = BattleState.newWild(game, "FIXMON_C", 30)
battle.rng = rolls(disableTurns or 4)
local function loadout(battler)
battler.mon.moves = {
{ id = "FIX_TACKLE", pp = 35 },
{ id = "FIX_SCRATCH", pp = 35 },
{ id = "FIX_DISABLE", pp = 20 },
}
battler.curMoves = battler.mon.moves
end
loadout(battle.player)
loadout(battle.enemy)
-- no speed tie to resolve: the disabler outruns its target outright
battle.player.curStats.speed = playerFirst and 200 or 1
battle.enemy.curStats.speed = playerFirst and 1 or 200
return battle
end
-- the move instances the sides actually own, so PP decrements land on
-- the party copy the way DecrementPP mutates wBattleMonPP
local function slot(battler, i) return battler.curMoves[i] end
-- consume the queue the way updateQueue does, minus the presentation
local function drain(battle)
local rows = {}
for _ = 1, 400 do
local item = table.remove(battle.queue, 1)
if not item then return rows end
if item.text then rows[#rows + 1] = { text = item.text } end
if item.fn then
battle.nextInsert = 0
item.fn()
end
end
error("the turn queue never drained")
end
local function saidWith(rows, needle)
for i, row in ipairs(rows) do
if row.text and row.text:find(needle, 1, true) then return i end
end
return nil
end
-- "X's / MOVE is / disabled!" (PrintMoveIsDisabledText) versus
-- DisableEffect's own "MOVE was / disabled!" -- the two lines differ only
-- in that verb, so match on it
local function blocked(rows) return saidWith(rows, "is\ndisabled!") end
local function landed(rows) return saidWith(rows, "was\ndisabled!") end
local function usedTackle(rows) return saidWith(rows, "used FIX TACKLE!") end
-- ---------------------------------------------------------------------
-- the player Disables first; the foe's latched FIX TACKLE dies this turn
-- ---------------------------------------------------------------------
do
local battle = newBattle(true)
battle.enemyAction = function() return slot(battle.enemy, 1) end
local hpBefore = battle.player.mon.hp
battle:resolveTurn(slot(battle.player, 3))
local rows = drain(battle)
T.check(landed(rows) ~= nil, "the Disable lands")
T.eq(battle.enemy.disabledSlot, 1, "and latches onto the foe's slot 1")
T.check(blocked(rows) ~= nil,
"the foe's already-selected move reports as disabled")
T.check(landed(rows) and blocked(rows) and landed(rows) < blocked(rows),
"in that order: disabled first, then the blocked attempt")
T.check(usedTackle(rows) == nil,
"the disabled move is never announced, so it never executed")
T.eq(battle.player.mon.hp, hpBefore, "and it deals no damage")
T.eq(battle.enemy.disabledTurns, 3,
"the counter ticked once for this turn and the disable is still live")
end
-- ---------------------------------------------------------------------
-- the same, mirrored: the foe Disables first and the player's latched
-- move dies (core.asm:5752 .checkIfTriedToUseDisabledMove)
-- ---------------------------------------------------------------------
do
local battle = newBattle(false)
battle.enemyAction = function() return slot(battle.enemy, 3) end
local hpBefore = battle.enemy.mon.hp
local ppBefore = slot(battle.player, 1).pp
battle:resolveTurn(slot(battle.player, 1))
local rows = drain(battle)
T.check(landed(rows) ~= nil, "the foe's Disable lands")
T.eq(battle.player.disabledSlot, 1, "on the player's slot 1")
T.check(blocked(rows) ~= nil, "the player's latched move reports as disabled")
T.check(usedTackle(rows) == nil, "and is never announced")
T.eq(battle.enemy.mon.hp, hpBefore, "the foe takes no damage")
T.eq(slot(battle.player, 1).pp, ppBefore,
"and the move that never executed spends no PP (DecrementPP is inside "
.. "the move, past the status gauntlet)")
end
-- ---------------------------------------------------------------------
-- no regression on the turns after: the disable keeps blocking that move
-- while its counter runs, and a different move still works
-- ---------------------------------------------------------------------
do
local battle = newBattle(true)
battle.enemyAction = function() return slot(battle.enemy, 1) end
battle:resolveTurn(slot(battle.player, 3))
drain(battle)
T.eq(battle.enemy.disabledTurns, 3, "the disable is live going into turn 2")
-- turn 2: the foe picks the disabled move with no Disable in flight
local hpBefore = battle.player.mon.hp
battle:resolveTurn(slot(battle.player, 2))
local rows = drain(battle)
T.check(blocked(rows) ~= nil, "turn 2 still blocks the disabled move")
T.check(usedTackle(rows) == nil, "still no execution")
T.eq(battle.player.mon.hp, hpBefore, "still no damage")
T.eq(battle.enemy.disabledTurns, 2, "and the counter keeps ticking down")
-- turn 3: the foe picks its OTHER move, which was never disabled
battle.enemyAction = function() return slot(battle.enemy, 2) end
hpBefore = battle.player.mon.hp
rows = (function() battle:resolveTurn(slot(battle.player, 2)); return drain(battle) end)()
T.check(blocked(rows) == nil, "an undisabled move is not blocked")
T.check(saidWith(rows, "used FIX SCRATCH!") ~= nil, "it is announced")
T.check(battle.player.mon.hp < hpBefore, "and it deals damage")
end
-- ---------------------------------------------------------------------
-- the counter tick still runs ahead of the check: a disable that expires
-- on this turn frees the move it was holding (.DisabledCheck precedes
-- .TriedToUseDisabledMoveCheck)
-- ---------------------------------------------------------------------
do
local battle = newBattle(true)
battle.enemy.disabledSlot, battle.enemy.disabledTurns = 1, 1
battle.enemyAction = function() return slot(battle.enemy, 1) end
local hpBefore = battle.player.mon.hp
battle:resolveTurn(slot(battle.player, 2))
local rows = drain(battle)
T.check(saidWith(rows, "disabled no more!") ~= nil, "the disable expires")
T.check(blocked(rows) == nil, "so the move is not blocked")
T.check(usedTackle(rows) ~= nil, "it executes")
T.check(battle.player.mon.hp < hpBefore, "and deals damage")
end
T.finish("disable blocks the already-selected move (#860)")
@@ -0,0 +1,112 @@
-- One-column launcher reach (#852) and the safe-area launcher anchor (#810).
-- No pokered cite: the launcher is port-only chrome.
--
-- #852: minPanelHeight in src/import/LauncherView.lua was a flat 460*s tuned
-- for the two-column layout. A one-column window (portrait phone, squat 4:3
-- device) stacks title + actions card + slot card + the pinned
-- Play/Reset-rebinds/Touch-Controls block, which needs more room; the flat
-- threshold read "tall enough", so the short-window page scroll never
-- engaged, buildSlotCard was cut by Kit.pushClip against the pinned block,
-- and Kit's clip-bounded hit-testing (src/ui/kit/Kit.lua) left every slot
-- row, the pager and "+ New save slot" drawn-but-inert. The fix makes the
-- threshold column-aware, so those windows scroll instead of clipping.
--
-- The seam is LauncherView.draw itself: it publishes the page-scroll extent
-- on the importer (imp._pageScroll / imp._pageScrollMax, the values the
-- touch-drag and wheel paths feed), so a headless draw shows whether the
-- scroll engaged without reading any file-local constant. The 480x900
-- window below is the discriminator: its natural panel space satisfies the
-- old flat threshold (inert, slot card clipped) but not the one-column one.
--
-- #810 gets its unit-conversion pin in tests/engine/safe_area_units_test.lua;
-- here the complementary end-to-end anchor: Layout.metrics must place the
-- launcher at the corrected safe-area origin, not a DPI-inflated band down
-- the screen.
-- luajit tests/engine/launcher_one_column_reach_bug852.lua
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.harness")
local check, eq = T.check, T.eq
love = love or require("tests.love_stub")
-- The launcher touches two graphics calls the shared stub does not carry
-- (focus-ring joins, the footer's BCG invert shader); both are draw-only, so
-- inert fills are enough for the layout arithmetic under test.
love.graphics.setLineJoin = love.graphics.setLineJoin or function() end
love.graphics.newShader = love.graphics.newShader or function() return {} end
local Layout = require("src.ui.kit.Layout")
local RomImporter = require("src.import.RomImporter")
local LauncherView = require("src.import.LauncherView")
local function window(w, h)
love.graphics.getDimensions = function() return w, h end
love.graphics.getPixelDimensions = function() return w, h end
end
-- A fresh launcher on the Red tab; no cache exists headless, so every
-- version sits in its "ROM required" state, which still lays out the full
-- one-column pile (title, actions card, slot card, pinned block).
local function freshLauncher()
return RomImporter.new(function() end, { launcher = true })
end
-- ------------------------------------------------ #852: the scroll engages
-- 480x900 one column: enough room for the old flat 460*s threshold, not for
-- the one-column stack. Before the fix draw() left _pageScrollMax at 0 here
-- and the slot card sat clipped inert against the pinned buttons.
window(480, 900)
local m = Layout.metrics(1200)
eq(m.twoCol, false, "480-wide window lays out one column")
local imp = freshLauncher()
LauncherView.draw(imp)
check((imp._pageScrollMax or 0) > 0,
"one-column window short of the stack engages the page scroll")
eq(imp._pageScroll, 0, "a fresh page starts at the top")
-- The wheel moves the page (the same offset the touch drag feeds), and the
-- offset clamps to the extent, so the whole stack down to "+ New save slot"
-- and the footer is reachable rather than clipped away.
local extent = imp._pageScrollMax
imp._wheelY = -1
LauncherView.draw(imp)
eq(imp._pageScroll, math.min(math.floor(48 * m.s), extent),
"one wheel notch scrolls the page down by its step")
imp._pageScroll = 1e6
LauncherView.draw(imp)
eq(imp._pageScroll, imp._pageScrollMax,
"an offset past the end clamps to the extent, so the bottom is reachable")
-- The reporter's portrait phone (360x780 units) is shorter still and must
-- also scroll; before the fix its slot list was unreachable.
window(360, 780)
local phone = freshLauncher()
LauncherView.draw(phone)
check((phone._pageScrollMax or 0) > 0,
"portrait-phone one-column window engages the page scroll")
-- A one-column window tall enough for the whole stack stays inert: the
-- column-aware minimum is a floor, not a permanent scroll.
window(480, 1200)
local tall = freshLauncher()
LauncherView.draw(tall)
eq(tall._pageScrollMax, 0,
"a tall one-column window does not scroll for nothing")
-- --------------------------------------- #810: launcher anchored in units
-- Layout.metrics anchors the launcher at SafeArea.rect's origin. Feed it
-- the iOS 16 portrait frame that reported the safe rect in framebuffer
-- pixels (3x DPI): the launcher must start at the 44-unit notch inset, not
-- 132 units down with the top of the window black (the #810 report). The
-- rescale itself is pinned in tests/engine/safe_area_units_test.lua.
love.graphics.getDimensions = function() return 375, 812 end
love.graphics.getPixelDimensions = function() return 1125, 2436 end
local oldSafe = love.window.getSafeArea
love.window.getSafeArea = function() return 0, 132, 1125, 2232 end
local ios = Layout.metrics(1200)
eq(ios.top, 44, "launcher anchors at the unit-space notch inset")
eq(ios.h, 744, "launcher gets the full unit-space safe height")
love.window.getSafeArea = oldSafe
T.finish("launcher one-column reach")
@@ -0,0 +1,109 @@
-- #828, the revert half: after the launcher's OG -> WIDE toggle, a play
-- session rewrites options.lua with byte-identical content (play() re-stamps
-- an unchanged lastVersion, SaveData.save flushes the attached table, and
-- SaveSerializer's key-sorted encode makes equal tables equal bytes), so
-- saveOptions' conditional pre-write roll skips and options.lua.bak kept the
-- PRE-change file all session. Android and Steam Deck end sessions with a
-- hard teardown (HostShell.restart restartApp kill / AppImage execv) that can
-- eat the main file, and loadOptions then promoted that stale backup: the
-- reported "launcher-only persists, going in-game reverts". The fix rolls
-- the backup forward to the just-verified bytes after every landed write;
-- this suite pins that at-rest invariant. ROM-free (T2 engine tier), same
-- injected-fs shape as tests/engine/options_write_readback_bug828.lua, where
-- these checks should eventually fold in.
-- luajit tests/engine/options_backup_rollforward_bug828.lua
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.harness")
local check, eq = T.check, T.eq
love = love or require("tests.love_stub")
local SaveData = require("src.core.SaveData")
local OPTIONS = "options.lua"
local BAK = OPTIONS .. ".bak"
local TMP = OPTIONS .. ".tmp"
-- In-memory love.filesystem stub, the { getInfo, read, write, remove } shape
-- SaveData.persistFs accepts. `dropping` is mutable so one fs can serve a
-- healthy session and then a write that reports success without landing.
local function memfs()
local files = {}
local fs
fs = {
files = files,
dropping = false,
write = function(path, content)
if fs.dropping then return true end
files[path] = content
return true
end,
read = function(path) return files[path] end,
remove = function(path) files[path] = nil return true end,
getInfo = function(path)
if files[path] ~= nil then return { type = "file" } end
return nil
end,
}
return fs
end
-- ---- at rest, the backup holds the newest verified bytes
local fs = memfs()
SaveData.saveOptions({ battleLayout = "wide" }, fs)
check(fs.files[BAK] ~= nil, "the very first verified write already leaves a backup")
eq(fs.files[BAK], fs.files[OPTIONS],
"after a verified write the backup equals the main file (#828 roll-forward)")
check(fs.files[TMP] == nil, "the staged witness is still dropped after verification")
-- ---- the reported session, write for write
-- Launcher toggles OG -> WIDE, then two rewrites whose bytes match the file
-- on disk: RomImporter:play re-stamping the same lastVersion (#835) and the
-- in-game SaveData.save flush of the attached, unchanged table. Both go
-- through loadOptions first, exactly as the shipping callers do, so the
-- encoder sees identical tables and the conditional pre-roll skips.
local live = memfs()
SaveData.saveOptions({ battleLayout = "og", lastVersion = "red" }, live)
local toggled = SaveData.loadOptions(live)
toggled.battleLayout = "wide"
SaveData.saveOptions(toggled, live)
local wideBytes = live.files[OPTIONS]
local stamped = SaveData.loadOptions(live)
stamped.lastVersion = "red"
SaveData.saveOptions(stamped, live)
eq(live.files[OPTIONS], wideBytes,
"the play() lastVersion re-stamp is a byte-identical rewrite (sorted encode)")
SaveData.saveOptions(SaveData.loadOptions(live), live)
eq(live.files[OPTIONS], wideBytes, "the in-game flush is byte-identical too")
eq(live.files[BAK], wideBytes,
"identical rewrites still carry the backup forward past the skipped pre-roll")
-- the hard teardown eats the main file; recovery must answer the toggle
live.files[OPTIONS] = nil
eq(SaveData.loadOptions(live).battleLayout, "wide",
"a lost main file recovers to WIDE, not the pre-toggle OG backup (#828)")
check(live.files[OPTIONS] ~= nil, "and the main file is healed from that copy")
-- ---- a write that does not land must not poison the backup
-- The roll-forward has to sit AFTER the readback verification: if the bytes
-- never reached disk (the #828 external-storage failure mode) the backup
-- keeps the last state that verifiably did.
local flaky = memfs()
SaveData.saveOptions({ battleLayout = "wide" }, flaky)
local verified = flaky.files[BAK]
flaky.dropping = true
eq(SaveData.saveOptions({ battleLayout = "og" }, flaky), nil,
"the vanished write still reports failure")
flaky.dropping = false
eq(flaky.files[BAK], verified,
"a write that never landed leaves the backup at the last verified bytes")
flaky.files[OPTIONS] = nil
eq(SaveData.loadOptions(flaky).battleLayout, "wide",
"so recovery after the failed write still answers the verified state")
T.finish("options_backup_rollforward_bug828")
@@ -110,4 +110,117 @@ local last = Logger.history[#Logger.history]
check(last and last:find("options save failed", 1, true) ~= nil,
"the last failure logged is the false-return one, not the readback one")
-- ---- an interrupted write no longer resets every setting
-- The launcher wrote WIDE and a later write dies partway through (the
-- process replaced by HostShell.restart on the way back to the launcher, an
-- external-storage flush that never happened), leaving a corrupt
-- options.lua. loadOptions must promote the staged/backup copy instead of
-- answering defaults, which is what "closing the game reset all my
-- settings" looked like.
local live = memfs("honest")
SaveData.saveOptions({ battleLayout = "wide" }, live)
SaveData.saveOptions({ battleLayout = "wide", textSpeed = 1 }, live)
check(live.files[OPTIONS .. ".bak"] ~= nil,
"the previous good options.lua is rolled aside before the rewrite")
check(live.files[OPTIONS .. ".tmp"] == nil,
"the staged witness is dropped once the main write is verified")
live.files[OPTIONS] = "return { battleLayout = " -- died mid-rewrite
local healed = SaveData.loadOptions(live)
eq(healed and healed.battleLayout, "wide",
"a corrupt options.lua is recovered from the rolled-aside copy")
check(live.files[OPTIONS] ~= "return { battleLayout = ",
"the main options file is healed from the copy that parsed")
-- ---- a lost main file must recover to the NEWEST verified write
-- The platforms that lose options.lua do it on the hard teardown out of a
-- game session (HostShell.restart's restartApp kill on Android, execv on a
-- SteamOS AppImage), after rewrites whose bytes matched the file already on
-- disk: play()'s lastVersion stamp and the in-game save flush re-encode the
-- same table, and the key-sorted encoder makes those byte-identical, so the
-- conditional pre-write roll skips them. The backup is therefore rolled
-- forward after every verified write; otherwise recovery handed back the
-- file from BEFORE the launcher's change, which is exactly the reported
-- "set BATTLE LAYOUT to WIDE, go in game, close, and it is OG again" (#828).
local lost = memfs("honest")
SaveData.saveOptions({ battleLayout = "og", lastVersion = "red" }, lost)
local editedOpts = SaveData.loadOptions(lost)
editedOpts.battleLayout = "wide"
SaveData.saveOptions(editedOpts, lost) -- the launcher's toggle
local replay = SaveData.loadOptions(lost)
replay.lastVersion = "red" -- play() re-stamps the same value
SaveData.saveOptions(replay, lost) -- byte-identical rewrite
SaveData.saveOptions(SaveData.loadOptions(lost), lost) -- in-game save flush, identical too
lost.files[OPTIONS] = nil -- the platform ate the main file
local promoted = SaveData.loadOptions(lost)
eq(promoted.battleLayout, "wide",
"a lost main file recovers to the newest verified write, not the "
.. "pre-change backup (#828)")
local gone = memfs("honest")
SaveData.saveOptions({ battleLayout = "wide" }, gone)
gone.files[OPTIONS] = nil
gone.files[OPTIONS .. ".bak"] = nil
gone.files[OPTIONS .. ".tmp"] = nil
eq(SaveData.loadOptions(gone).battleLayout,
SaveData.defaultOptions().battleLayout,
"with no copy left the defaults are still the answer")
-- ---- the reported sequence end to end: launcher setting -> play -> quit
-- #828 as the reporter walks it (issue steps 2-7, and the "so its partly
-- fixed" comment): change BATTLE LAYOUT from OG to WIDE in the launcher, go
-- in game, close, reopen the launcher. Every options write is a whole-file
-- rewrite out of the caller's table (saveOptions above), so the only thing
-- keeping the launcher's key alive across a game-side write is WHEN the game
-- took its copy: SaveData.load re-attaches a fresh loadOptions() to the save
-- it just read (src/core/SaveData.lua:1108, and SaveData.newGame does the
-- same at :1458), which is after the launcher's last write because
-- RomImporter:play hands off only once the settings modal has saved
-- (src/import/LauncherSettings.lua open/save, src/import/RomImporter.lua
-- play). This pins that ordering: it is the invariant, not the merge, that
-- makes the launcher's change survive.
local hop = memfs("honest")
SaveData.saveOptions({ battleLayout = "og" }, hop)
-- launcher: the gear menu's edited table, persisted on close
local launcherOpts = SaveData.loadOptions(hop)
launcherOpts.battleLayout = "wide"
launcherOpts.lastVersion = "blue" -- #835 rides the same file
SaveData.saveOptions(launcherOpts, hop)
-- boot: the game's copy is taken here, never earlier
local gameOpts = SaveData.loadOptions(hop)
eq(gameOpts.battleLayout, "wide",
"the game boots on the value the launcher just wrote")
-- play: an in-game OPTION menu change writes the whole table back
gameOpts.textSpeed = 1
check(SaveData.saveOptions(gameOpts, hop) ~= nil, "the game-side write lands")
local reopened = SaveData.loadOptions(hop)
eq(reopened.battleLayout, "wide",
"the launcher's BATTLE LAYOUT survives a game-side options write (#828)")
eq(reopened.textSpeed, 1, "and the in-game change is persisted alongside it")
eq(reopened.lastVersion, "blue",
"launcher-only keys the game never reads are carried through its write")
-- The corollary, and the reason the copy has to come from loadOptions: a
-- caller that writes a partial literal instead of a loaded table drops every
-- key it does not mention, because mergeOptions only fills DEFAULTS in around
-- what it is handed (SaveData.mergeOptions). Nothing on the boot path does
-- this today; the assertion is the guard rail if someone shortcuts it.
SaveData.saveOptions({ battleLayout = "og" }, hop)
eq(SaveData.loadOptions(hop).lastVersion, nil,
"a partial write drops launcher-only keys, so the game must write the "
.. "table loadOptions handed it")
-- Known gap, deliberately not asserted: a copy taken BEFORE the launcher's
-- write and flushed after it still wins, because saveOptions merges only
-- modOptions from disk and every other key is last-writer-wins. Measured,
-- not guessed (og beats a newer wide). No shipping path holds an options
-- table across a launcher write -- HostShell.restart replaces the process on
-- the way back to the launcher (#785, #575) and LauncherSettings.open notes
-- its own cached table is only true while its modal covers the launcher --
-- so closing that gap needs a three-way merge (baseline vs caller vs disk),
-- not a straight "disk wins", which would throw away real in-game changes.
T.finish("options_write_readback_bug828")
+51
View File
@@ -0,0 +1,51 @@
-- SafeArea.rect unit sanity (#810): the iOS build reported the portrait
-- safe rect in framebuffer PIXELS while love.graphics works in DPI-scaled
-- units, and the old clamp kept the inflated top inset -- the launcher
-- started a band down the screen and left the top of it black. A rect
-- that cannot fit the unit window is converted back to units with
-- per-axis ratios (the axes can disagree, #208). No pokered cite: the
-- launcher is port-only chrome.
-- luajit tests/engine/safe_area_units_test.lua
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.harness")
local eq = T.eq
love = love or require("tests.love_stub")
local SafeArea = require("src.core.SafeArea")
local oldDims = love.graphics.getDimensions
local oldPix = love.graphics.getPixelDimensions
local oldSafe = love.window.getSafeArea
local function frame(uw, uh, pw, ph, sx, sy, sw, sh)
love.graphics.getDimensions = function() return uw, uh end
love.graphics.getPixelDimensions = function() return pw, ph end
love.window.getSafeArea = function() return sx, sy, sw, sh end
return SafeArea.rect()
end
-- a pixel-based rect on a 3x portrait phone comes back in units (#810)
local x, y, w, h = frame(375, 812, 1125, 2436, 0, 132, 1125, 2232)
eq(x, 0, "pixel-unit safe x rescales")
eq(y, 44, "pixel-unit top inset rescales to the real notch")
eq(w, 375, "pixel-unit safe width rescales")
eq(h, 744, "pixel-unit safe height rescales")
-- a correct unit rect passes through untouched
x, y, w, h = frame(375, 812, 1125, 2436, 0, 44, 375, 734)
eq(y, 44, "a unit rect keeps its top inset")
eq(h, 734, "a unit rect keeps its height")
-- dpi 1: no rescale, the oversized rect still clamps to the window
x, y, w, h = frame(640, 576, 640, 576, 0, 100, 900, 900)
eq(y, 100, "no rescale when units are pixels")
eq(w, 640, "width clamps to the drawable window")
eq(h, 476, "height clamps to the drawable window")
love.graphics.getDimensions = oldDims
love.graphics.getPixelDimensions = oldPix
love.window.getSafeArea = oldSafe
T.finish("safe area units")
@@ -0,0 +1,187 @@
-- Gen1 save codec (src/save_convert/GenSave.lua) for wToggleableObjectFlags
-- (ram/wram.asm, flag_array $100): the ShowObject/HideObject persistence the
-- codec used to skip entirely, so an import resurrected both Mt Moon fossils
-- (#857) and reverted Cerulean's GUARD1/GUARD2/ROCKET swap so the officer
-- blocked the robbed-house door again (#763). Bit numbering comes from
-- ../pokered/data/maps/toggleable_objects.asm entry order (bit set = hidden,
-- engine/overworld/toggleable_objects.asm IsObjectHidden), and the offset is
-- re-derived here from the wram walk rather than read out of GenSave.OFFSETS.
-- Also covers the Yellow-only wPikachuHappiness byte (#763, #838): the
-- 0x271C offset is pinned from the pokeyellow symbol file, not a local
-- pokeyellow checkout, so it still wants a confirmation against a real
-- emulator-written Yellow .sav.
-- luajit tests/engine/save_convert_toggle_objects.lua
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.harness")
local check, eq = T.check, T.eq
love = love or require("tests.love_stub")
local bit = require("bit")
local GenSave = require("src.save_convert.GenSave")
local SaveData = require("src.core.SaveData")
-- the codec crosswalks need the real dataset; CI has no ROM
local loadPokemon = loadfile("data/generated/pokemon.lua")
if not loadPokemon then
print("save_convert_toggle_objects skipped (needs data/generated/ for the Gen1 save codec)")
os.exit(0)
end
GenSave.setCharmap(loadfile("src/save_convert/data/charmap.lua")())
local toggles = loadfile("src/save_convert/data/toggle_objects.lua")()
local data = {
pokemon = loadPokemon(),
moves = loadfile("data/generated/moves.lua")(),
items = loadfile("data/generated/items.lua")(),
maps = loadfile("data/generated/maps.lua")(),
eventFlags = loadfile("src/save_convert/data/event_flags.lua")(),
toggleObjects = toggles,
}
-- ------------------------------------------------------------------
-- offset pins, independent of the codec's own arithmetic: wram.asm places
-- wToggleableObjectFlags 2 bytes (wPlayerCoins) past wPlayerCoins' label,
-- i.e. sav absolute 0x2852; the pokeyellow symbol file places
-- wPikachuHappiness at d46f - wMainDataStart d2f6 = 377, absolute 0x271C
-- ------------------------------------------------------------------
local OFF = GenSave.OFFSETS
eq(OFF.toggleObjectFlags, OFF.coins + 2,
"wToggleableObjectFlags sits 2 bytes (wPlayerCoins) past O.coins")
eq(OFF.toggleObjectFlags, 0x2852, "wToggleableObjectFlags is sav byte 0x2852")
eq(OFF.pikachuHappiness, 0x271C, "wPikachuHappiness is sav byte 0x271C")
-- independent flag_array read (byte = index / 8, bit = index % 8), so nothing
-- below trusts the writer it is checking
local function flagGet(bytes, base, index)
local byte = bytes:byte(base + math.floor(index / 8) + 1)
return bit.band(bit.rshift(byte, index % 8), 1) == 1
end
-- ------------------------------------------------------------------
-- crosswalk <-> maps.lua contract: every named toggle entry must resolve
-- to a real object_event, or encode's itemsTaken/defeatedTrainers fold
-- (which looks the object up by name) silently misses it
-- ------------------------------------------------------------------
local entries = 0
for _, e in pairs(toggles.byBit) do
entries = entries + 1
local found
for _, obj in ipairs((data.maps[e[1]] or {}).objects or {}) do
if obj.name == e[2] then found = obj break end
end
check(found ~= nil, e[1] .. " has an object_event named " .. e[2])
end
-- toggleable_objects.asm has 228 rows; two are placeholders with no
-- object_event in this port (SILPHCO7F_UNUSED, the UNUSED_MAP_F4 entry)
eq(entries, 226, "the crosswalk carries every real toggle bit and no more")
-- the bits under test, straight from the crosswalk's own numbering
eq(toggles.byBit[109][2], "MTMOONB2F_DOME_FOSSIL", "bit 109 is the dome fossil")
eq(toggles.byBit[110][2], "MTMOONB2F_HELIX_FOSSIL", "bit 110 is the helix fossil")
eq(toggles.byBit[7][2], "CERULEANCITY_GUARD1", "bit 7 is the door guard")
eq(toggles.byBit[9][2], "CERULEANCITY_GUARD2", "bit 9 is the roof guard")
eq(toggles.byBit[104][2], "MTMOON1F_MOON_STONE", "bit 104 is the moon stone")
-- ------------------------------------------------------------------
-- round trip: templateless export of a save past the fossil pickup
-- (data/scripts/story2.lua hides both balls) and the Cerulean robbery
-- resolution (data/scripts/story5.lua rocketRows shows GUARD1, hides
-- GUARD2/ROCKET), plus a taken overworld item, which vanilla folds into
-- these same bits (engine/events/pick_up_item.asm)
-- ------------------------------------------------------------------
local function seedSave()
local save = SaveData.newGame({ playerName = "RED", rivalName = "BLUE" })
save.party = { {
species = "SQUIRTLE", level = 6, exp = 200,
dvs = { hp = 1, attack = 2, defense = 3, speed = 4, special = 5 },
statExp = { hp = 0, attack = 0, defense = 0, speed = 0, special = 0 },
stats = { hp = 22, attack = 12, defense = 13, speed = 11, special = 12 },
hp = 22,
moves = { { id = "TACKLE", pp = 35, ppUps = 0 } },
nickname = "SQ", ot = "RED", otId = save.player.id, catchRate = 45,
} }
return save
end
local set = seedSave()
set.objectToggles = {
MT_MOON_B2F = {
MTMOONB2F_DOME_FOSSIL = false,
MTMOONB2F_HELIX_FOSSIL = false,
},
CERULEAN_CITY = {
CERULEANCITY_GUARD1 = true,
CERULEANCITY_GUARD2 = false,
},
}
-- the moon stone rides itemsTaken (src/world/OverworldController.lua
-- force-hides picked items), never objectToggles, so encode must fold it in
set.itemsTaken = { MT_MOON_1F_obj_9 = true }
local setBytes = GenSave.encode(set, data, nil)
eq(#setBytes, GenSave.SAVE_SIZE, "the export is a 32768-byte save")
local TOG = OFF.toggleObjectFlags
check(flagGet(setBytes, TOG, 109), "the taken dome fossil is hidden (bit 109)")
check(flagGet(setBytes, TOG, 110), "the taken helix fossil is hidden (bit 110)")
check(flagGet(setBytes, TOG, 9), "the swapped-out roof guard is hidden (bit 9)")
check(not flagGet(setBytes, TOG, 7),
"the officer now beside the door stays visible (bit 7 clear)")
check(flagGet(setBytes, TOG, 104),
"the taken moon stone folds from itemsTaken into bit 104")
-- untouched entries fall back to their compiled-in defaults, not to zero
check(flagGet(setBytes, TOG, 0), "PALLETTOWN_OAK defaults hidden (bit 0 set)")
check(not flagGet(setBytes, TOG, 1),
"VIRIDIANCITY_OLD_MAN_SLEEPY defaults visible (bit 1 clear)")
local back = GenSave.decode(setBytes, data)
eq(#(back.warnings or {}), 0, "the export decodes with no warnings")
local reTog = back.objectToggles
check(type(reTog) == "table", "an import populates save.objectToggles")
eq(reTog.MT_MOON_B2F.MTMOONB2F_DOME_FOSSIL, false,
"the dome fossil stays taken across export -> import")
eq(reTog.MT_MOON_B2F.MTMOONB2F_HELIX_FOSSIL, false,
"the helix fossil stays taken across export -> import")
eq(reTog.CERULEAN_CITY.CERULEANCITY_GUARD1, true,
"the officer stays beside the door across export -> import")
eq(reTog.CERULEAN_CITY.CERULEANCITY_GUARD2, false,
"the roof guard stays gone across export -> import")
eq(reTog.PALLET_TOWN.PALLETTOWN_OAK, false,
"Oak's roaming sprite imports at its hidden default")
eq(reTog.VIRIDIAN_CITY.VIRIDIANCITY_OLD_MAN_SLEEPY, true,
"the sleepy old man imports at his visible default")
eq(reTog.MT_MOON_1F.MTMOON1F_MOON_STONE, false,
"the folded moon stone imports hidden too")
-- ------------------------------------------------------------------
-- Yellow starter friendship: gated on the data set's game because the
-- byte is current-map scratch in Red/Blue (see O.pikachuHappiness)
-- ------------------------------------------------------------------
check(not flagGet(setBytes, OFF.pikachuHappiness, 0)
and setBytes:byte(OFF.pikachuHappiness + 1) == 0,
"a Red/Blue export leaves the scratch byte at 0x271C zeroed")
eq(back.pikachuHappiness, nil, "a Red/Blue import never invents a happiness")
local dataYellow = {
pokemon = data.pokemon, moves = data.moves, items = data.items,
maps = data.maps, toggleObjects = toggles,
eventFlags = loadfile("src/save_convert/data/event_flags_yellow.lua")(),
gameVersion = "yellow",
}
local ySave = seedSave()
ySave.pikachuHappiness = 200
local yBytes = GenSave.encode(ySave, dataYellow, nil)
eq(yBytes:byte(OFF.pikachuHappiness + 1), 200,
"pikachuHappiness = 200 reaches sav byte 0x271C")
local yBack = GenSave.decode(yBytes, dataYellow)
eq(yBack.pikachuHappiness, 200,
"the follower's happiness survives export -> import on Yellow")
T.finish("save_convert_toggle_objects")
+37
View File
@@ -188,6 +188,43 @@ local leftover = 0
for _ in pairs(stagedTemps) do leftover = leftover + 1 end
eq(leftover, 0, "fallback cleans staged temp after install")
-- #801: a same-id copy under a different folder name is replaced too, so the
-- update cannot leave a shadow copy for discover()'s first-id-wins race
resetFs()
files["mods/WildsOfKanto-1.5.0/manifest.json"] =
('{"id":"%s","name":"Old Copy","version":"0.9.0","entry":"main.lua"}')
:format(MOD_ID)
files["mods/WildsOfKanto-1.5.0/main.lua"] = "return function() end\n"
files["imports/mods/update.zip"] = "PK\3\4update"
ok, err = LauncherMods.installZip("imports/mods/update.zip",
{ replace = true, expectId = MOD_ID })
check(ok == true, "replace install succeeds over an odd-named copy ("
.. tostring(err) .. ")")
check(files["mods/WildsOfKanto-1.5.0/manifest.json"] == nil,
"odd-named same-id folder is removed by the replace")
check(files["mods/" .. MOD_ID .. "/manifest.json"] ~= nil,
"replace still lands in mods/<id>")
-- #834: a manifest-less mods/<id> tree (interrupted copy debris) must not
-- block a plain re-import as "already installed"
resetFs()
files["mods/" .. MOD_ID .. "/gfx/a.bin"] = "x"
files["imports/mods/again.zip"] = "PK\3\4again"
ok, err = LauncherMods.installZip("imports/mods/again.zip")
check(ok == true, "debris tree does not block re-import ("
.. tostring(err) .. ")")
check(files["mods/" .. MOD_ID .. "/gfx/a.bin"] == nil,
"debris is cleared by the re-import")
-- a real installed copy still refuses a plain duplicate import
resetFs()
files["mods/" .. MOD_ID .. "/manifest.json"] = ARCHIVE[MOD_ID .. "/manifest.json"]
files["imports/mods/dup.zip"] = "PK\3\4dup"
ok, err = LauncherMods.installZip("imports/mods/dup.zip")
check(not ok, "a listed install still refuses a plain duplicate import")
check(tostring(err):find("already installed", 1, true),
"duplicate refusal still names already installed")
-- Restore
love.filesystem = savedFs
SaveData.portableBaseDir = savedSaveDataPortable
@@ -0,0 +1,225 @@
-- #801 / #834: what the PLAYER sees after an update over a shadow copy.
-- The tier file (launcher_mods_install_zip_test.lua) asserts which folders
-- survive installZip; this one asserts the panel-facing contracts built on
-- top of them: LauncherMods.list() must report the NEW version after a
-- replace even when a same-id copy sits under an archive-named folder that
-- enumerates first (#801, "Updated ... to X" yet the old version kept
-- loading), and uninstall()/re-import must both recover a manifest-less
-- mods/<id> debris tree left by an interrupted copy (#834, "already
-- installed" with nothing showing in the panel).
package.path = "./?.lua;./?/init.lua;" .. package.path
if not _G.love then _G.love = require("tests.love_stub") end
local S = require("tests.harness").suite("launcher mods shadow copy #801/#834")
local eq = S.eq
local check = S.check
-- The real-world shape from the #801 report: a hand-unzipped copy kept the
-- archive's folder name. "W" sorts before "o" in the stub's sorted
-- enumeration, so the shadow folder enumerates first -- the exact ordering
-- that made discover()'s first-id-wins dedupe resolve the stale copy.
local MOD_ID = "overworld_wild_spawns"
local SHADOW = "mods/WildsOfKanto-1.5.0"
local NEW_VERSION = "1.7.1"
local ARCHIVE = {
[MOD_ID .. "/manifest.json"] =
('{"id":"%s","name":"Wilds of Kanto","version":"%s","entry":"main.lua"}')
:format(MOD_ID, NEW_VERSION),
[MOD_ID .. "/main.lua"] = "return function() end\n",
}
local files, dirs, arch = {}, {}, {}
local function resetFs()
for k in pairs(files) do files[k] = nil end
for k in pairs(dirs) do dirs[k] = nil end
for k in pairs(arch) do arch[k] = nil end
end
local function dirChild(key, name)
if name == nil or name == "" then return key:match("^[^/]+") end
local prefix = name .. "/"
if key:sub(1, #prefix) ~= prefix then return nil end
return key:sub(#prefix + 1):match("^[^/]+")
end
local function mapInfo(map, name, kind)
if map[name] ~= nil then return { type = kind or "file" } end
for key in pairs(map) do
if dirChild(key, name) then return { type = "directory" } end
end
return nil
end
local vfs = {}
function vfs.write(name, data)
files[name] = data
return true
end
function vfs.read(name)
if arch[name] ~= nil then return arch[name] end
return files[name]
end
function vfs.remove(name)
files[name] = nil
dirs[name] = nil
return true
end
function vfs.createDirectory(name)
dirs[name] = true
return true
end
function vfs.getInfo(name, kind)
local info = mapInfo(arch, name)
or mapInfo(files, name)
or mapInfo(dirs, name, "directory")
if info and kind and info.type ~= kind then return nil end
return info
end
function vfs.getDirectoryItems(name)
local seen, items = {}, {}
local function add(child)
if child and not seen[child] then
seen[child] = true
items[#items + 1] = child
end
end
for key in pairs(arch) do add(dirChild(key, name)) end
for key in pairs(files) do add(dirChild(key, name)) end
for key in pairs(dirs) do add(dirChild(key, name)) end
table.sort(items)
return items
end
function vfs.mount(_, point)
for rel, body in pairs(ARCHIVE) do
arch[point .. "/" .. rel] = body
end
return true
end
function vfs.unmount()
for k in pairs(arch) do arch[k] = nil end
return true
end
function vfs.newFileData(data, name)
return { __filedata = true, data = data, name = name }
end
function vfs.getSaveDirectory()
return "/tmp/pokeport-shadow-copy-test"
end
function vfs.getSource()
return nil
end
local savedFs = love.filesystem
local savedCacheFs = package.loaded["src.import.CacheFs"]
local savedLauncherMods = package.loaded["src.mods.LauncherMods"]
local SaveData = require("src.core.SaveData")
local savedPortableBase = SaveData.portableBaseDir
local savedPortableFs = SaveData.portableFs
love.filesystem = vfs
package.loaded["src.import.CacheFs"] = nil
package.loaded["src.mods.LauncherMods"] = nil
-- Portable mode off: loadOptions/uninstall must stay on the stub vfs, or the
-- checkout's real save directory would leak into the test.
SaveData.portableBaseDir = function() return nil end
SaveData.portableFs = function() return nil end
local LauncherMods = require("src.mods.LauncherMods")
local function versionOf(id)
for _, row in ipairs(LauncherMods.list()) do
if row.id == id then return row.version end
end
return nil
end
-- #801: the shadow copy alone resolves as the mod (sanity for the setup),
-- and after a replace-install the panel row flips to the zip's version.
-- Pre-fix, installZip returned success but only rewrote mods/<id>; the
-- shadow folder enumerated first and list() kept answering 1.5.0 forever.
resetFs()
files[SHADOW .. "/manifest.json"] =
('{"id":"%s","name":"Wilds of Kanto","version":"1.5.0","entry":"main.lua"}')
:format(MOD_ID)
files[SHADOW .. "/main.lua"] = "return function() end\n"
eq(versionOf(MOD_ID), "1.5.0", "shadow copy resolves before the update")
files["imports/mods/update.zip"] = "PK\3\4update"
local ok, err = LauncherMods.installZip("imports/mods/update.zip",
{ replace = true, expectId = MOD_ID })
check(ok == true, "replace over a shadow copy succeeds (" .. tostring(err) .. ")")
eq(err, MOD_ID, "replace reports the manifest id")
eq(versionOf(MOD_ID), NEW_VERSION,
"list() reports the zip's version after the replace")
check(files[SHADOW .. "/manifest.json"] == nil,
"shadow folder is gone, so no stale copy can win first-id-wins later")
eq(#LauncherMods.list(), 1, "the update leaves exactly one panel row")
-- #801: Delete from the panel must take the shadow copy with it, or the
-- next boot resurrects the mod from the odd-named folder.
resetFs()
files[SHADOW .. "/manifest.json"] = ARCHIVE[MOD_ID .. "/manifest.json"]
files["mods/" .. MOD_ID .. "/manifest.json"] = ARCHIVE[MOD_ID .. "/manifest.json"]
ok, err = LauncherMods.uninstall(MOD_ID)
check(ok == true, "uninstall succeeds with a shadow copy present ("
.. tostring(err) .. ")")
check(files[SHADOW .. "/manifest.json"] == nil,
"uninstall removes the same-id shadow folder too")
check(files["mods/" .. MOD_ID .. "/manifest.json"] == nil,
"uninstall removes mods/<id>")
eq(#LauncherMods.list(), 0, "nothing is left for the panel to show")
-- #834: interrupted-copy debris (mods/<id> with no manifest.json) is
-- invisible to list() yet used to hard-block every plain re-import with
-- "a mod named '<id>' is already installed". Both recovery paths the
-- player can reach must work: plain re-import, and Delete.
resetFs()
files["mods/" .. MOD_ID .. "/gfx/a.bin"] = "x"
eq(#LauncherMods.list(), 0, "debris tree shows no panel row")
files["imports/mods/again.zip"] = "PK\3\4again"
ok, err = LauncherMods.installZip("imports/mods/again.zip")
check(ok == true, "plain re-import over debris succeeds ("
.. tostring(err) .. ")")
check(files["mods/" .. MOD_ID .. "/gfx/a.bin"] == nil,
"re-import clears the debris file")
eq(versionOf(MOD_ID), NEW_VERSION, "re-import yields a listable mod")
resetFs()
files["mods/" .. MOD_ID .. "/gfx/a.bin"] = "x"
ok, err = LauncherMods.uninstall(MOD_ID)
check(ok == true, "uninstall clears a debris-only tree ("
.. tostring(err) .. ")")
check(files["mods/" .. MOD_ID .. "/gfx/a.bin"] == nil,
"debris file is gone after uninstall")
-- guard rail: with a healthy install and NO debris, the duplicate gate
-- still refuses a plain import with the same wording the panel shows
resetFs()
files["mods/" .. MOD_ID .. "/manifest.json"] = ARCHIVE[MOD_ID .. "/manifest.json"]
files["imports/mods/dup.zip"] = "PK\3\4dup"
ok, err = LauncherMods.installZip("imports/mods/dup.zip")
check(not ok, "healthy duplicate import is still refused")
check(tostring(err):find("already installed", 1, true),
"refusal keeps the already installed wording")
-- Restore
love.filesystem = savedFs
SaveData.portableBaseDir = savedPortableBase
SaveData.portableFs = savedPortableFs
package.loaded["src.import.CacheFs"] = savedCacheFs
package.loaded["src.mods.LauncherMods"] = savedLauncherMods
S.finish()
+11 -5
View File
@@ -700,8 +700,14 @@ do
end
-- issue #133: title menu / continue overlays must not inherit LOGO2/LOGO1
-- (blue/red UI ink). A trailing trueColor zone covers the overlay box.
-- (blue/red UI ink). A trailing GRAYS zone covers the overlay box: through
-- the shade-remap shader it is the identity for the box's DMG shades, so
-- pass-through modes keep #133's white paper / black ink, while the mono
-- and inverted display modes still recolor it with the rest of the screen
-- (a trueColor rect skipped the shader and left a raw white hole over a
-- CLASSIC pea-green title, #870).
do
local PaletteFX = require("src.render.PaletteFX")
local logo2 = {
{ 255, 255, 255 }, { 230, 197, 0 }, { 148, 156, 148 }, { 41, 99, 181 },
}
@@ -730,8 +736,8 @@ do
menu.titleUiBox = { 0, 0, 12, 3 }
game.stack:push(menu)
local withMenu = TitleState.sgbPalettes(title, game)
check(withMenu and #withMenu == 4 and withMenu[4].colors == false,
"title menu adds a trueColor overlay zone")
check(withMenu and #withMenu == 4 and withMenu[4].colors == PaletteFX.GRAYS,
"title menu adds a DMG-grays overlay zone (#870)")
check(withMenu[4].x == 0 and withMenu[4].y == 0
and withMenu[4].w == 13 * 8 and withMenu[4].h == 4 * 8,
"menu overlay covers the CONTINUE/NEW GAME box")
@@ -739,8 +745,8 @@ do
game.stack:pop()
game.stack:push({ titleUiBox = { 4, 7, 19, 16 } })
local withCont = TitleState.sgbPalettes(title, game)
check(withCont and #withCont == 4 and withCont[4].colors == false,
"continue-info overlay adds a trueColor zone")
check(withCont and #withCont == 4 and withCont[4].colors == PaletteFX.GRAYS,
"continue-info overlay adds a DMG-grays zone (#870)")
check(withCont[4].x == 4 * 8 and withCont[4].y == 7 * 8
and withCont[4].w == 16 * 8 and withCont[4].h == 10 * 8,
"continue overlay matches DisplayContinueGameInfo's box")
@@ -0,0 +1,101 @@
-- screen.render_visible through the public mod API: a mirrored native screen
-- may leave the main render without leaving the active state stack.
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.modkit")
local Game = require("src.core.Game")
local Runtime = require("src.mods.Runtime")
local StateStack = require("src.core.StateStack")
local Renderer = require("src.render.Renderer")
local TouchControls = require("src.core.TouchControls")
local FIXTURE = {
["mods/fix_screen_mirror/manifest.json"] = [[{
"id": "fix_screen_mirror",
"name": "Fixture Screen Mirror",
"version": "1.0.0",
"entry": "main.lua",
"api": 2
}]],
["mods/fix_screen_mirror/main.lua"] = [[
local mod = ...
mod.hooks:wrap("screen.render_visible", function(nextFn, state)
if state.screenId == "BagMenu" then return false end
return nextFn(state)
end)
]],
}
local savedSetUISize, savedBegin, savedEnd, savedTouch =
Renderer.setUISize, Renderer.beginFrame, Renderer.endFrame,
TouchControls.draw
local presentedZones
Renderer.setUISize = function() end
Renderer.beginFrame = function() end
Renderer.endFrame = function(_, zones)
presentedZones = zones
return {}
end
TouchControls.draw = function() end
local function scene()
local stack = setmetatable({}, { __index = StateStack })
stack:init()
local base = {
isOpaque = true,
draws = 0,
draw = function(self) self.draws = self.draws + 1 end,
sgbPalettes = function() return "base zones" end,
}
local menu = {
screenId = "BagMenu",
isOpaque = true,
draws = 0,
updates = 0,
draw = function(self) self.draws = self.draws + 1 end,
update = function(self) self.updates = self.updates + 1 end,
sgbPalettes = function() return "menu zones" end,
}
stack:push(base)
stack:push(menu)
return { stack = stack, overworld = base, save = { options = {} } },
base, menu
end
-- no-mod parity
do
local run = T.sdk.loadNone({})
local game, base, menu = scene()
T.eq(Runtime.wantsHook("screen.render_visible"), false,
"no subscriber leaves the render hook cold")
Game.draw(game)
T.eq(base.draws, 0, "the opaque menu still covers the state beneath")
T.eq(menu.draws, 1, "the opaque menu still draws")
T.eq(presentedZones, "menu zones", "the visible menu still owns palettes")
run.release()
end
-- subscribed path, registered by a real fixture mod
do
local run = T.sdk.loadMods({ "mods/fix_screen_mirror" },
{ fs = T.sdk.memfs(FIXTURE) })
T.eq(#run.errors, 0,
"the fixture mod loads clean (" .. tostring(run.errors[1]) .. ")")
local game, base, menu = scene()
Game.draw(game)
T.eq(base.draws, 1, "the state beneath the hidden menu draws")
T.eq(menu.draws, 0, "the mirrored menu is omitted from the main draw")
T.eq(presentedZones, "base zones",
"a hidden state cannot own the main-screen palette")
T.check(game.stack:top() == menu,
"the hidden menu remains the active top state")
game.stack:update(1 / 60)
T.eq(menu.updates, 1, "the hidden menu keeps its update ownership")
run.release()
end
Renderer.setUISize, Renderer.beginFrame, Renderer.endFrame,
TouchControls.draw = savedSetUISize, savedBegin, savedEnd, savedTouch
T.finish("screen_render_visible")
+71
View File
@@ -0,0 +1,71 @@
-- #781: Linux launcher mouse-dead behind the pad cursor. Reproduces the
-- X11 multi-monitor failure mode (polled love.mouse.getPosition frozen on
-- desktop-virtual coords, so the motion yield in _updatePadCursor never
-- fires) and asserts a host-forwarded mousepressed reclaims the pointer.
-- Self-contained: `luajit tests/rom_importer_cursor_bug781_test.lua`.
-- Should eventually merge into tests/rom_importer_cursor_test.lua (dofile'd
-- by tests/run_tests.lua).
package.path = "./?.lua;./?/init.lua;" .. package.path
if not _G.love then _G.love = require("tests.love_stub") end
local S = require("tests.harness").suite("rom importer pad cursor #781")
local eq = S.eq
local RomImporter = require("src.import.RomImporter")
-- Bare importer with just the pad-cursor state new() would build; isNX
-- false keeps _updatePadCursor on the desktop path (polled motion yield),
-- _flex nil keeps the right-stick branch out of LauncherView.
local function makeImporter()
return setmetatable({
android = false,
isNX = false,
_flex = nil,
_padCursor = { x = 320, y = 260 },
_padCursorActive = false,
_padAxis = { leftx = 0, lefty = 0, righty = 0 },
_padDir = {},
_padInited = true,
}, RomImporter)
end
-- Failure mode: SDL's polled mouse state stuck on coordinates outside the
-- window (primary display away from desktop 0,0). Successive samples are
-- identical, so the motion yield sees zero delta and never releases the
-- pad cursor no matter how much the real mouse moves.
local ri = makeImporter()
love.mouse.getPosition = function() return 2960, 4130 end
ri._padCursorActive = true
ri:_updatePadCursor(1 / 60) -- seeds _lastMouseX/_lastMouseY
ri:_updatePadCursor(1 / 60)
ri:_updatePadCursor(1 / 60)
eq(ri._padCursorActive, true,
"frozen polled coords starve the motion yield (the #781 trap)")
-- The fix: the host-forwarded real press must win the pointer back, same
-- contract as PadCursor.yieldToPointer in the overlay hosts. This is the
-- half that un-gates LauncherView.update's click minting.
ri:mousepressed(10, 10, 1)
eq(ri._padCursorActive, false,
"mousepressed reclaims the pointer even when the yield is starved (#781)")
-- A reclaimed pointer must stay reclaimed: the next pad-cursor tick with
-- still-frozen polled coords may not re-arm it by itself.
ri:_updatePadCursor(1 / 60)
eq(ri._padCursorActive, false,
"an idle pad tick does not re-steal the pointer after reclaim")
-- Regression guard for the healthy desktop path: when polled coords do
-- move (window-relative, single monitor), the existing motion yield still
-- releases the pad cursor without needing a click.
local ri2 = makeImporter()
local px = 100
love.mouse.getPosition = function() return px, 100 end
ri2._padCursorActive = true
ri2:_updatePadCursor(1 / 60)
px = 140
ri2:_updatePadCursor(1 / 60)
eq(ri2._padCursorActive, false,
"real mouse motion still yields the pad cursor on sane polled coords")
S.finish()
+8
View File
@@ -45,4 +45,12 @@ ri:play("red")
eq(booted, "red", "unsupported system cursors still allow boot")
eq(currentCursor, "hand", "unsupported system cursors leave the existing cursor alone")
-- #781: a host-forwarded real mouse press must win the pointer back from
-- the pad cursor. While it is active LauncherView.update refuses to mint
-- mouse clicks, so a stuck motion yield (X11 multi-monitor polled coords)
-- left the Linux launcher mouse-dead until this reclaim existed.
ri._padCursorActive = true
ri:mousepressed(10, 10, 1)
eq(ri._padCursorActive, false, "mouse press yields the pad cursor (#781)")
S.finish()
+208
View File
@@ -0,0 +1,208 @@
-- Yellow save export/import checks for #838: the codec used to run the
-- Red/Blue tables unmodified for Yellow, so (1) event flags went through
-- pokered's bit numbering even though pokeyellow renumbers wEventFlags,
-- and (2) wPikachuHappiness (pokeyellow d46f, absolute 0x271C in SRAM)
-- was never encoded or decoded. Yellow offsets are verified against the
-- pokeyellow symbol file -- no local pokeyellow checkout exists, so
-- ../pokered can only vouch for the shared R/B layout, which pokeyellow's
-- sram.asm matches byte for byte. Needs data/generated/, same as
-- tests/save_convert_tests.lua (its natural eventual home).
--
-- Run: luajit tests/save_convert_yellow_bug838_test.lua
package.path = "./?.lua;" .. package.path
_G.love = require("tests.love_stub")
local GenSave = require("src.save_convert.GenSave")
local SaveConvert = require("src.save_convert.SaveConvert")
local SaveData = require("src.core.SaveData")
local checks, failures = 0, 0
local function check(cond, msg)
checks = checks + 1
if not cond then
failures = failures + 1
print("FAIL: " .. msg)
end
end
GenSave.setCharmap(loadfile("src/save_convert/data/charmap.lua")())
local redFlags = loadfile("src/save_convert/data/event_flags.lua")()
local yellowFlags = loadfile("src/save_convert/data/event_flags_yellow.lua")()
-- Red/Blue and Yellow crosswalk sets over the same generated tables; the
-- only differences the codec keys off are the event-flag numbering and the
-- gameVersion tag (SaveConvert.ensureData stamps the same shape, #838).
local shared = {
pokemon = loadfile("data/generated/pokemon.lua")(),
moves = loadfile("data/generated/moves.lua")(),
items = loadfile("data/generated/items.lua")(),
maps = loadfile("data/generated/maps.lua")(),
}
local redData = {
pokemon = shared.pokemon, moves = shared.moves, items = shared.items,
maps = shared.maps, eventFlags = redFlags,
}
local yellowData = {
pokemon = shared.pokemon, moves = shared.moves, items = shared.items,
maps = shared.maps, eventFlags = yellowFlags, gameVersion = "yellow",
}
local OFF = GenSave.OFFSETS
-- ------------------------------------------------------------------
-- the Yellow event-flag table itself: pokeyellow's renumbering, not a
-- copy of the Red table under a new filename
-- ------------------------------------------------------------------
check(yellowFlags.count == 2560,
"yellow table covers the full 2560-bit wEventFlags array")
check(type(yellowFlags.byName) == "table" and type(yellowFlags.byBit) == "table",
"yellow table has the byName/byBit shape the codec reads")
-- shared names on DIFFERENT bits: Yellow inserts events ahead of them
check(redFlags.byName.EVENT_GOT_DOME_FOSSIL == 1406
and yellowFlags.byName.EVENT_GOT_DOME_FOSSIL == 1400,
"EVENT_GOT_DOME_FOSSIL sits on red bit 1406 vs yellow bit 1400")
check(redFlags.byName.EVENT_BEAT_MT_MOON_3_TRAINER_0 == 1402
and yellowFlags.byName.EVENT_BEAT_MT_MOON_3_TRAINER_0 == 1403,
"the Mt Moon 3 trainer block shifts +1 in yellow (Jessie & James insert)")
check(redFlags.byName.EVENT_BEAT_SILPH_CO_11F_TRAINER_0 == 1924
and yellowFlags.byName.EVENT_BEAT_SILPH_CO_11F_TRAINER_0 == 1925,
"the Silph Co 11F trainer block shifts +1 in yellow")
-- yellow-only names the port's Yellow scripts set (data/scripts/
-- yellow_jessie_james.lua and the catch-training tutorial): absent from
-- the Red table, so exporting through it silently dropped them
check(yellowFlags.byName.EVENT_BEAT_MT_MOON_3_JESSIE_JAMES == 1402
and redFlags.byName.EVENT_BEAT_MT_MOON_3_JESSIE_JAMES == nil,
"EVENT_BEAT_MT_MOON_3_JESSIE_JAMES is yellow bit 1402, unknown to red")
check(yellowFlags.byName.EVENT_COMPLETED_CATCH_TRAINING == 45
and redFlags.byName.EVENT_COMPLETED_CATCH_TRAINING == nil,
"EVENT_COMPLETED_CATCH_TRAINING is yellow bit 45, unknown to red")
check(yellowFlags.byName.EVENT_GOT_SQUIRTLE_FROM_OFFICER_JENNY ~= nil
and redFlags.byName.EVENT_GOT_SQUIRTLE_FROM_OFFICER_JENNY == nil,
"the Officer Jenny Squirtle event exists only in the yellow table")
-- byBit/byName agree on the renumbered entries
check(yellowFlags.byBit[1400] == "EVENT_GOT_DOME_FOSSIL"
and yellowFlags.byBit[1402] == "EVENT_BEAT_MT_MOON_3_JESSIE_JAMES",
"yellow byBit resolves the renumbered bits back to their names")
-- ------------------------------------------------------------------
-- wPikachuHappiness offset: d46f - wMainDataStart d2f6 = 377 past
-- sMainData, absolute 0x271C (per the pokeyellow symbol file)
-- ------------------------------------------------------------------
check(OFF.pikachuHappiness == 10012,
"OFFSETS.pikachuHappiness is absolute 0x271C (got "
.. tostring(OFF.pikachuHappiness) .. ")")
check(OFF.pikachuHappiness == OFF.mainData + 377,
"pikachuHappiness sits 377 bytes past sMainData (wram d46f - d2f6)")
-- the byte is INSIDE the checksummed main-data window, so writing it
-- without recomputing the checksum would brick the save on a cartridge
check(OFF.pikachuHappiness >= OFF.checksumStart
and OFF.pikachuHappiness < OFF.checksumEnd,
"pikachuHappiness lies inside the main checksum window")
-- ------------------------------------------------------------------
-- encode/decode gate: yellow data writes and reads the byte, R/B data
-- leaves it alone (in Red/Blue it is current-map scratch)
-- ------------------------------------------------------------------
local save = SaveData.newGame({ playerName = "RED", rivalName = "BLUE" })
save.pikachuHappiness = 200
-- the follower seeds happiness at 90 (src/world/PikachuFollower.lua), so
-- 200 can only come from this table -- no default could fake the check
local yBytes = GenSave.encode(save, yellowData, nil)
check(#yBytes == GenSave.SAVE_SIZE, "yellow encode produces exactly 32768 bytes")
check(yBytes:byte(OFF.pikachuHappiness + 1) == 200,
"yellow encode writes pikachuHappiness to 0x271C (got "
.. yBytes:byte(OFF.pikachuHappiness + 1) .. ")")
check(GenSave.mainChecksumValid(yBytes),
"yellow encode still emits a valid main-data checksum")
local yDec = GenSave.decode(yBytes, yellowData)
check(yDec.pikachuHappiness == 200,
"yellow decode reads pikachuHappiness back (got "
.. tostring(yDec.pikachuHappiness) .. ")")
-- a yellow save whose table never held the field falls back to the
-- follower's seed value instead of exporting friendship 0
local noHap = SaveData.newGame({ playerName = "RED", rivalName = "BLUE" })
noHap.pikachuHappiness = nil
local seedBytes = GenSave.encode(noHap, yellowData, nil)
check(seedBytes:byte(OFF.pikachuHappiness + 1) == 90,
"a missing pikachuHappiness exports as the follower seed 90, not 0")
-- R/B output unchanged: same save through the red data set leaves the
-- scratch byte zero-filled and decode never invents the field
local rBytes = GenSave.encode(save, redData, nil)
check(rBytes:byte(OFF.pikachuHappiness + 1) == 0,
"red/blue encode leaves the 0x271C scratch byte zero-filled")
check(GenSave.decode(rBytes, redData).pikachuHappiness == nil,
"red/blue decode does not fabricate a pikachuHappiness field")
-- ------------------------------------------------------------------
-- event flags land on pokeyellow bits. Independent LSB-first flag_array
-- read (pokered home FlagAction convention: byte N/8, bit N%8) so the
-- assertions cannot inherit a codec bit-order bug.
-- ------------------------------------------------------------------
local bit = require("bit")
local function flagBit(bytes, index)
local b = bytes:byte(OFF.eventFlags + math.floor(index / 8) + 1)
return bit.band(bit.rshift(b, index % 8), 1) == 1
end
local fsave = SaveData.newGame({ playerName = "ASH", rivalName = "GARY" })
fsave.flags = {
EVENT_GOT_DOME_FOSSIL = true,
EVENT_BEAT_MT_MOON_3_JESSIE_JAMES = true,
EVENT_COMPLETED_CATCH_TRAINING = true,
}
local yfBytes = GenSave.encode(fsave, yellowData, nil)
check(flagBit(yfBytes, 1400) and not flagBit(yfBytes, 1406),
"yellow export puts EVENT_GOT_DOME_FOSSIL on bit 1400, not red's 1406")
check(flagBit(yfBytes, 1402),
"yellow export carries EVENT_BEAT_MT_MOON_3_JESSIE_JAMES on bit 1402")
check(flagBit(yfBytes, 45),
"yellow export carries EVENT_COMPLETED_CATCH_TRAINING on bit 45")
local yfDec = GenSave.decode(yfBytes, yellowData)
check(yfDec.flags.EVENT_GOT_DOME_FOSSIL
and yfDec.flags.EVENT_BEAT_MT_MOON_3_JESSIE_JAMES
and yfDec.flags.EVENT_COMPLETED_CATCH_TRAINING,
"yellow-numbered flags round-trip through decode")
-- the pre-fix failure mode, pinned so it can never quietly return: the
-- red table lands the fossil on the wrong yellow bit and drops the
-- yellow-only names entirely
local rfBytes = GenSave.encode(fsave, redData, nil)
check(flagBit(rfBytes, 1406) and not flagBit(rfBytes, 1400),
"the red table writes the fossil on 1406, which yellow reads as another event")
check(not flagBit(rfBytes, 1402) and not flagBit(rfBytes, 45),
"the red table silently drops both yellow-only flags")
-- ------------------------------------------------------------------
-- SaveConvert.ensureData substitutes the yellow flag table (and stamps
-- gameVersion) when the caller names yellow; the versionless set still
-- resolves red numbering, per-version cached separately (#420 pattern)
-- ------------------------------------------------------------------
local yData, yErr = SaveConvert.loadData("yellow")
check(yData ~= nil, "SaveConvert.loadData('yellow') resolves (" .. tostring(yErr) .. ")")
check(yData and yData.gameVersion == "yellow",
"loadData('yellow') stamps gameVersion for the codec's byte gate")
check(yData and yData.eventFlags.byName.EVENT_GOT_DOME_FOSSIL == 1400
and yData.eventFlags.byName.EVENT_BEAT_MT_MOON_3_JESSIE_JAMES == 1402,
"loadData('yellow') serves the pokeyellow flag numbering")
local dData = SaveConvert.loadData()
check(dData and dData.eventFlags.byName.EVENT_GOT_DOME_FOSSIL == 1406
and dData.gameVersion == nil,
"versionless loadData still serves the red numbering, untagged")
print(string.format("save convert yellow #838: %d/%d checks passed",
checks - failures, checks))
if failures > 0 then os.exit(1) end