chore: version Zelda 1 port and engineering records

This commit is contained in:
Nilton Constantino
2026-11-16 15:22:13 +00:00
commit 6f2fa420c2
4282 changed files with 822198 additions and 0 deletions
+28
View File
@@ -0,0 +1,28 @@
# Save guest qualification
Generate with `python3 tools/generate_save_fixture.py --action N`. It never
installs itself. Use disposable images under `.tmp`, never the user's card.
Append inventory/store/menu/game helpers to their respective module main.pbs,
export the helper services temporarily, and use the generated root entry.
Keep Init and MemcardBoot. Back up and restore all modified production files.
Actions: 0 saves a seeded profile when empty, or verifies reload when present;
1 also attempts Save after loading an existing profile (read-only test);
2 writes bad magic; 3 writes an unsupported schema; 4 commits only 12 bytes.
Actions 2..4 intentionally publish invalid game data in a valid disposable
container. A later boot must reject it, keep live game defaults, and preserve
its payload. Host metadata may change on admission; compare slot bytes rather
than equating a whole-container hash with payload preservation.
Markers after game rendering: pixel (0,0) is green on pass; pixel (3,0) encodes
phase and role; (6,0) is the SaveStore outcome. The 180 raw slot bytes can be
read from red values at (400,20+i); (401,0) contains the used length. Those
markers/columns are fixture-only and never belong in production.
A durable test must end the runtime process and reopen the same image. Check
00/7f/80/ff, native inventory/world flags, life normalization, clock clearing,
and a project-version change with stable app_id. Memory-only commits must
show NOT SAVED TO CARD. Explicitly discard only disposable memory-test RAM
when shutdown refuses dirty data. `tools/validate_save.py` verifies captures
against independent Python bytes, Adler-32 and native CHR pixel composition.
+75
View File
@@ -0,0 +1,75 @@
import { WorldFlags } from @zelda1:world;
import { SaveMenuChecks } from @zelda1:screens/continue_menu;
import { Inventory } from @zelda1:inventory;
import { Link } from @zelda1:link;
import { SaveStore, SaveStoreChecks } from @zelda1:save;
import { SaveInventoryChecks } from @zelda1:inventory;
import { Gfx } from @sdk:gfx;
import { Color } from @core:color;
declare const SAVE_TEST_ACTION: int=0;
declare global save_test_phase: int=0;
declare global save_test_failed: int=0;
declare global save_test_role: int=0;
declare global save_test_wait: int=0;
declare service SaveGameChecks {
fn frame() -> void {
if save_test_phase==0 {
let menu=SaveMenuChecks.verify(); if !menu { save_test_failed=7; }
let available=SaveStore.available(); save_test_role=if available { 1 } else { 0 };
game.update(false,false,false,false,false,false,true,false); save_test_phase=1;
let issue=SaveStore.load_issue();
if !available && issue!=0 {
save_test_role=2; save_test_phase=9; let loaded=SaveStore.load();
let sword=Inventory.sword_level(); let taken=WorldFlags.room_item_taken(119);
if loaded || sword!=0 || taken { save_test_failed=9; }
}
} else if save_test_phase==1 {
game.update(false,false,false,false,false,false,true,false);
for i: int from 0 until 76 { game.update(false,false,false,false,false,false,false,false); }
if save_test_role==1 {
let inventory=SaveInventoryChecks.verify(); let world=SaveStoreChecks.verify_world();
if !inventory || !world || game.mode!=5 { save_test_failed=1; }
save_test_phase=if SAVE_TEST_ACTION==1 { 2 } else { 8 };
} else {
SaveInventoryChecks.seed(); SaveStoreChecks.seed_world();
let codec=SaveStoreChecks.codec_checks(); if codec!=0 { save_test_failed=10+codec; }
save_test_phase=2;
}
} else if save_test_phase==2 {
game.update(false,false,false,false,false,false,false,true);
if game.mode!=12 { save_test_failed=2; }
let old_x=Link.x(); let old_y=Link.y(); let old_life=Inventory.read_slot(24); let old_partial=Inventory.read_slot(25);
game.update(false,false,false,false,false,false,true,false);
for i: int from 0 until 64 { game.update(false,false,false,false,false,false,false,false); }
let x=Link.x(); let y=Link.y(); let life=Inventory.read_slot(24); let partial=Inventory.read_slot(25);
if game.mode!=5 || x!=old_x || y!=old_y || life!=old_life || partial!=old_partial { save_test_failed=8; }
game.update(false,false,false,false,false,false,false,true); save_test_phase=3;
} else if save_test_phase==3 {
if SAVE_TEST_ACTION>=2 {
let injected=SaveStoreChecks.publish_bad(SAVE_TEST_ACTION); if !injected { save_test_failed=9; }
game.mode=13; save_test_phase=4;
} else {
game.update(false,false,false,false,false,false,false,true);
game.update(false,false,false,false,false,false,true,false);
for i: int from 0 until 64 { game.update(false,false,false,false,false,false,false,false); }
if game.mode!=13 { save_test_failed=3; } save_test_phase=4;
}
} else if save_test_phase==4 {
game.update(false,false,false,false,false,false,false,false);
let state=SaveStore.last_state(); let pending=SaveStore.busy(); save_test_wait+=1;
if state!=1 && !pending {
if state!=2 && state!=3 && state!=4 && state!=6 { save_test_failed=4; }
if state==2 { let durable=SaveStoreChecks.durable_valid(if SAVE_TEST_ACTION==4 { 12 } else { 180 }); if !durable { save_test_failed=6; } }
save_test_phase=5;
}
if save_test_wait>500 { save_test_failed=5; }
} else if save_test_phase==5 {
// Retain the result screen for capture; test driver ends this process.
SaveStore.poll();
}
game.draw(); SaveStoreChecks.draw_raw();
Gfx.fill_rect(0,0,3,3,if save_test_failed==0 { Color.rgb(0,255,0) } else { Color.rgb(save_test_failed as long,0,0) });
Gfx.fill_rect(3,0,3,3,Color.rgb(save_test_phase as long,save_test_role as long,0));
let state=SaveStore.last_state(); Gfx.fill_rect(6,0,3,3,Color.rgb(state as long,0,0));
}
}
+15
View File
@@ -0,0 +1,15 @@
declare service SaveInventoryChecks {
fn seed() -> void {
Inventory.reset(); let sword=Inventory.take_sword(1); let bombs=Inventory.take_drop(0);
let heart=Inventory.take_life_item(26); let damage=Inventory.damage_life(128);
inventory_slots[20]=1; inventory_slots[21]=1; inventory_slots[22]=5;
inventory_slots[33]=127; inventory_slots[34]=128; inventory_slots[35]=255; inventory_slots[36]=0;
}
fn verify() -> bool {
let sword=Inventory.sword_level(); let bombs=Inventory.read_slot(1); let life=Inventory.read_slot(24); let fraction=Inventory.read_slot(25);
if sword!=1 || bombs!=4 || life!=50 || fraction!=255 { return false; }
let clock=Inventory.read_slot(21); let fairy=Inventory.read_slot(20); let rupees=Inventory.read_slot(22); if clock!=0 || fairy!=1 || rupees!=5 { return false; }
let b0=Inventory.read_slot(36); let b1=Inventory.read_slot(33); let b2=Inventory.read_slot(34); let b3=Inventory.read_slot(35);
return b0==0 && b1==127 && b2==128 && b3==255;
}
}
+11
View File
@@ -0,0 +1,11 @@
declare service SaveMenuChecks {
fn verify() -> bool {
let test=new ContinueState(new ContinueData(),0,0,false);
let choice=test.advance(true,false); if test.selection!=1 { return false; }
choice=test.advance(true,false); if test.selection!=2 { return false; }
choice=test.advance(true,false); if test.selection!=0 { return false; }
choice=test.advance(true,true); if test.selection!=0 || !test.confirming { return false; }
for i: int from 0 until 63 { let pending_choice=test.advance(true,true); if pending_choice!= -1 { return false; } }
let final_choice=test.advance(false,false); return final_choice==0;
}
}
+56
View File
@@ -0,0 +1,56 @@
import { Gfx } from @sdk:gfx;
import { Color } from @core:color;
import { Inventory } from @zelda1:inventory;
import { WorldFlags } from @zelda1:world;
declare service SaveStoreChecks {
fn codec_checks() -> int {
let bytes=new MemcardBuffer(180); save_codec.snapshot(bytes);
let good=save_codec.validate(bytes); if good!=0 { return 1; }
if bytes.read(8)!=142 || bytes.read(9)!=6 || bytes.read(10)!=246 || bytes.read(11)!=217 { return 8; }
bytes.write(0,0); let bad_magic=save_codec.validate(bytes); if bad_magic!=1 { return 2; }
bytes.write(0,90); bytes.write(4,2); let unknown=save_codec.validate(bytes); if unknown!=2 { return 3; }
bytes.write(4,1); let old=bytes.read(13); bytes.write(13,old+1); let corrupt=save_codec.validate(bytes); if corrupt!=1 { return 4; }
bytes.write(13,old); bytes.write(49,0); save_codec.checksum(bytes); let bad_bombs=save_codec.validate(bytes); if bad_bombs!=1 { return 5; }
save_codec.snapshot(bytes); bytes.write(36,255); save_codec.checksum(bytes); let full=save_codec.validate(bytes); if full!=0 { return 6; }
bytes.write(36,15); save_codec.checksum(bytes); let bad_life=save_codec.validate(bytes); if bad_life!=1 { return 7; }
return 0;
}
fn seed_world() -> void {
WorldFlags.reset(); let values=new array<int>(128);
values[119]=16; values[100]=128; values[103]=146;
values[20]=0; values[21]=127; values[22]=128; values[23]=255;
WorldFlags.restore_slots(values);
}
fn verify_world() -> bool {
let sword=WorldFlags.room_item_taken(119); let secret=WorldFlags.secret_found(100); let partial=WorldFlags.kill_count(103);
if !sword || !secret || partial!=2 { return false; }
let b0=WorldFlags.read_slot(20); let b1=WorldFlags.read_slot(21); let b2=WorldFlags.read_slot(22); let b3=WorldFlags.read_slot(23);
if b0!=0 || b1!=127 || b2!=128 || b3!=255 { return false; }
// History is absent after reload: native $07 resets on the next visit.
let count=WorldFlags.enter_room(23,4); let flags=WorldFlags.read_slot(23);
return count==4 && flags==248;
}
fn durable_valid(expected_size: int) -> bool {
let stat=Mem.slot_stat(save_context,0); if stat.status!=0 as long { return false; }
return stat.has_payload==1 as long && stat.used_bytes==expected_size as long && !stat.dirty;
}
fn publish_bad(kind: int) -> bool {
let bytes=new MemcardBuffer(180); save_codec.snapshot(bytes);
if kind==2 { bytes.write(0,0); } else if kind==3 { bytes.write(4,2); }
let count=if kind==4 { 12 } else { 180 };
for i: int from 0 until 180 { save_staging[i]=bytes.read(i); }
let write=Mem.slot_write(save_context,0,0,bytes,0,count); if write.status!=0 as long { return false; }
let commit=Mem.slot_commit(save_context,0); if commit.status!=0 as long { return false; }
save_request=commit.request; save_result=1; return true;
}
fn draw_raw() -> void {
let stat=Mem.slot_stat(save_context,0); if stat.status!=0 as long { return; }
let count=stat.used_bytes as int; if count<=0 || count>180 { return; }
let bytes=new MemcardBuffer(180); let read=Mem.slot_read(save_context,0,0,bytes,0,count); if read.status!=0 as long { return; }
Gfx.fill_rect(401,0,1,1,Color.rgb(count as long,0,0));
for i: int from 0 until count { let value=bytes.read(i); Gfx.fill_rect(400,i+20,1,1,Color.rgb(value as long,0,0)); }
}
fn cache_signature() -> int {
let sum=0; for i: int from 0 until 180 { let value=save_cache[i] else 0; sum=(sum*31+value)%65521; } return sum;
}
}