Files
tmerrittandClaude Opus 4.8 49e117bfcc Fix Pass 3 symbol application and add promotion criteria to PROMPTS.md
- Apply symbols.inc hardware register names to Defender 2 (U) (51 operands)
- Apply symbols.inc hardware register names to Donkey Kong 3 (JUE) (36 operands)
- Add APU register symbols (-) to Defender 2 (U) and Donkey Kong 3 (JUE) symbols.inc
- Apply symbols to Donkey Kong Jr. Math (U) (80 operands: 11 single + 69 hardware)
- Apply symbols to Excitebike (JU) (786 operands: 785 single + 1 hardware)
- Add promotion criteria to PROMPTS.md: symbol/local substitution,
  ROM-specific semantic naming, and verification checklist

Add branch/jump target naming requirement to PROMPTS.md

All branches and jumps must target symbolic labels with descriptive names
derived from program flow role (e.g., _Loop, _Next, _Done, _Store, _Return),
never raw address literals. Adds criterion 8 to verification checklist.

Rename all OVERVIEW.md to README.md; add root README content to top-level

- Rename all OVERVIEW.md files to README.md throughout the repo (47 files)
- Prepend README.md content to top-level OVERVIEW.md before rename
- Fix apply_symbols.py NAME_RE regex to handle spaced assignments
- Apply symbols.inc to Defender 2 (U) (51 hardware operands)
- Apply symbols.inc to Donkey Kong 3 (JUE) (36 hardware operands)
- Apply symbols.inc to Donkey Kong Jr. Math (U) (80 operands: 11 single + 69 hardware)
- Apply symbols.inc to Excitebike (JU) (786 operands: 785 single + 1 hardware)
- Add missing Zp18/FrameCounter aliases to Excitebike prg.s
- Build all 27 top-level projects: byte-identical

Promote Donkey Kong Jr. Math back to _wip tier

Moves code from `copilot` folder and verifies each builds after

Add pre-commit hook for byte-identical verification

Add .git/hooks/pre-commit that runs 'make' then 'make clean' in each
project directory before committing. This ensures every project builds
byte-identical before any commit is accepted.

Also includes all file moves from the Donkey Kong Jr. Math (U) demotion
and other file restructuring from the session.

moves code out of copilot folder, its all AI generated.
Moves NROM games into NROM folder

removes copilot folder from Lunar Pool
Adds makefile to build all projects recursively

Updates docs to reflect changes in layout

Repromotes Donkey Kong Jr Math
Repromotes Excitebike
Promotes Popeye (JU) (PRG 1)
Updates Makefile to provide summary of build failure/success

Promote Raid on Bungeling Bay (U): Pass 2/3 partial, whole-ROM byte-identical

Move _wip/NROM/Raid on Bungeling Bay (U) to NROM/ and switch the build
from a PRG-only compare to a whole-ROM one:

  - header.s/chr.s added (one-line .incbin of header.bin / chr.bin)
  - linker.cfg gains HEADER ($0000, $0010) and CHR ($0000, $2000)
    areas ahead of PRG ($C000, $4000)
  - rom.nes symlink to the space-containing original ROM name
  - Makefile builds header.o/prg.o/chr.o into reconstructed.nes and
    compares it against rom.nes ('Byte-identical ROM verified.')
  - one leftover neutral indirect operand jmp (Zp01) at $E2EC becomes
    jmp (IndDispatch01); apply_symbols.py reports 0 substitutions pending

README.md / TODO.md / AGENTS.md updated: 29 promoted, 7 in _wip/.

Pac-Man (U): Pass 2 complete (label renaming) + Pass 3 partial (ZP aliases, table names)

Pass 2 — fresh map derived from the committed split, not from any drafted
map (the drafted maps in other projects were audited and found not
applicable):

  - all 194 address-derived Label_XXXX definitions renamed to semantic
    routine-entry names plus <Routine>_<Role>_<addr> internal branch
    targets; zero Label_ remains
  - all 49 jsr/jmp call sites resolved from raw $XXXX to labels; zero
    raw $XXXX call operands remain
  - routinemap.tsv / derived_names.tsv record the derivation

Pass 3 (partial):

  - 15 proven semantic zero-page aliases added to locals.inc
    (GameState, NmiFlag, ScrollX/Y, PpuCtrlShadow, OamDmaPage,
    CocktailModeFlag, ActivePlayerFlag, GameplaySuspended, FrameCounter,
    StateTimer, Player1/2Input, ActiveInput, CopyrightVerified)
  - 112 operands substituted into prg.s (11 single + 101 hardware)
  - key data tables named: ProgrammerSig ($C0EB), GameStateDispatchTable
    ($C253), TitleScreenData ($C2FD), EntityPtrTable ($D912),
    AudioCommandTable ($EFDD)

Also corrects the README's claim that the RESET vector points at padding:
$FF00 holds real boot code (sei/cld, PPU off, double vblank wait, then
jmp ColdStart at $C042).

.gitignore: ignore reconstructed_prg.bin (build artifact of the _wip
Makefiles; '**/reconstructed.*' does not match the underscore form).

Promote Pac-Man (U): Pass 2/3 complete, whole-ROM byte-identical

Move _wip/NROM/Pac-Man (U) to NROM/ and switch the build from a PRG-only
compare to a whole-ROM one:

  - header.s/chr.s added (one-line .incbin of header.bin / chr.bin)
  - linker.cfg gains HEADER ($0000, $0010) and CHR ($0000, $2000)
    areas ahead of PRG ($C000, $4000)
  - rom.nes symlink to 'Pac-Man (U) [!].nes' (the original ROM name
    contains a space and brackets)
  - Makefile builds header.o/prg.o/chr.o into reconstructed.nes and
    compares it against rom.nes
  - reconstructed.nes is 24,592 bytes, MD5 a69d310f8cae9397fbd39f204672b5c7
    - equal to the original ROM; the header/prg/chr splits were checked
    against the original before promotion and are byte-exact

Pass 3 residue closed.  The last 7 multi-alias zero-page operands are
resolved per site through a new sites.tsv, each proven from context
rather than guessed:

  - jmp ($0010) at $C250/$D3CA/$D90F/$D9B6 -> (DispatchPtrLo); each
    is immediately preceded by sta DispatchPtrLo/sta DispatchPtrHi
  - jmp ($00FE) at $EFDA -> (AudioHandlerPtrLo); preceded by
    sta AudioHandlerPtrLo/sta AudioHandlerPtrHi
  - sta a:$0000,y at $C048/$C089 -> a:Zp00,y; the literal zero-page
    base in the two ZP clear loops, so the neutral name is used rather
    than the semantic WorkPtrLo.  The 'a:' prefix survives the
    substitution, so the bytes stay 99 00 00 (sta abs,Y)

apply_symbols.py now reports 119 operands substituted (101 hardware,
11 single-name, 7 site) and 0 residue.

New tool _tools/align_audit_comments.py: re-aligns the audit comment to
column 35 after a substitution lengthens an operand (nesdis.py pads each
instruction to 31 characters).  Whitespace-only, so the byte identity
cannot change.  405 lines re-aligned in this project; all 2,387 audit
comments still match prg.bin at the stated PRG offset, 0 mismatches.

Docs: root README.md / TODO.md / AGENTS.md updated - 30 promoted, 6 in
_wip/; a per-project detail entry for Pac-Man (U) added; the stale
'Donkey Kong 3 (JUE) has no README.md' claim corrected (it has a
318-line one).

Promote Raid on Bungeling Bay (U) [a2]: Pass 3 complete, whole-ROM byte-identical

Move _wip/NROM/Raid on Bungeling Bay (U) [a2] to NROM/ and switch the build
from a PRG-only compare to a whole-ROM one:

  - header.s/chr.s added (one-line .incbin of header.bin / chr.bin)
  - linker.cfg gains HEADER ($0000, $0010) and CHR ($0000, $2000)
    areas ahead of PRG ($C000, $4000)
  - rom.nes symlink to 'Raid on Bungeling Bay (U) [a2].nes' (the original
    ROM name contains spaces and brackets)
  - reconstructed.nes is 24,592 bytes, MD5 659d340a1e9d420eee28df13319b0094
    - equal to the original ROM; the header/prg/chr splits were checked
    against the original before promotion and are byte-exact

Pass 3 - 15 semantic zero-page aliases, each applied only at the sites
where its role is proven:

  - PpuCtrlShadow ($C2), 15 sites: the reset entry primes it right after
    'sta PPUCTRL', and every other use is an ora/and/eor followed by
    'sta PPUCTRL'
  - NmiPathSelector ($C4), 5 sites: written 1 at $C3E9 and 0 at $C962
  - GameState ($D6), 6 sites: 'cmp #$02' and used as an index at $C4C7
  - FrameSubCounter ($55), 6 sites: set to $0A at $C520, decremented per
    NMI at $C07B
  - PrngPeriodCounter ($EA) / PrngSeedB ($EB) / PrngState ($EC), 13 sites:
    the PRNG state
  - PtrLo ($00) / PtrHi ($01), 8 sites: the 16-bit pair $1C13 and $1610
    compared at $E785/$E791
  - IndDispatch01 ($01) / IndDispatch02 ($02), 3 sites: the computed
    dispatch at $E2EC
  - IndDispatch1B ($1B) / IndDispatch1C ($1C), 6 sites: the dispatch at
    $E7A3
  - IndDispatch17 ($17) / IndDispatch19 ($19): the dispatches at $E79D
    and $E7A0

Addresses that carry two names keep the neutral ZpXX name where the other
role applies - $01 is PtrHi at the 16-bit compare and IndDispatch01 at the
dispatch; $17 is IndDispatch17 at the dispatch and Zp17 for the absolute
RAM $0017 store in the copy loop at $E895/$E8D0.

New tool _tools/apply_zp_aliases.py does the per-site substitution:
apply_symbols.py only rewrites *numeric* operands, so it cannot rename an
operand that is already written as a neutral ZpXX name.  The tool keeps the
ca65 'a:' prefix (dropping it would turn 'sta a:Zp17,y' into a zero-page
store and change the bytes) and rewrites only the operand token, so the
audit comment survives byte for byte.

Naming correction in the promoted sibling.  Finishing this dump showed that
$EA was misnamed 'VBlankWaitCounter': the routine at $C412 is the game's
pseudo-random generator (the classic eor/asl/php/lsr/plp/rol scrambler,
called from thirteen gameplay sites, twice in a row at $CDF4/$CDF9 with the
second result masked #$07), so $EA is the scrambler's phase counter.
Renamed PrngPeriodCounter in both dumps and named $EB/$EC PrngSeedB /
PrngState.  The sibling's two 'sta a:IndDispatch17,y' operands were also
wrong - they are absolute stores to RAM $0017, not the dispatch pointer -
and are now 'a:Zp17,y', matching the file's 'a:' = absolute convention.

Audit-comment alignment re-done with _tools/align_audit_comments.py (1,040
lines here, 1,080 in the sibling).  Both files still match prg.bin at every
stated PRG offset: 5,467 and 5,483 audit comments, 0 mismatches.

Docs: root README.md / TODO.md / AGENTS.md updated - 31 promoted, 5 in
_wip/; per-project detail entries added for both Raid dumps.

Promote Pac-Man (Tengen) (U): Pass 2/3 from scratch, whole-ROM byte-identical

Move _wip/NROM/Pac-Man (Tengen) (U) to NROM/ and switch the build from a
PRG-only compare to a whole-ROM one:

  - header.s/chr.s added (one-line .incbin of header.bin / chr.bin)
  - linker.cfg gains HEADER ($0000, $0010) and CHR ($0000, $2000)
    areas ahead of PRG ($C000, $4000)
  - rom.nes symlink to 'Pac-Man (Tengen) (U) [!].nes'
  - reconstructed.nes is 24,592 bytes, MD5 d34e7a74d8d2c231b6cc601210e28ad0
    - equal to the original ROM; the header/prg/chr splits were checked
    against the original before promotion and are byte-exact

Disassembled from scratch.  No name, map or file was carried over from the
sibling 'Pac-Man (U)' dump; the map was derived from this dump's own
committed split and the two were only compared afterwards.

Pass 2 (new tool _tools/apply_pass2_map.py):
  - all 194 Label_XXXX definitions renamed to semantic routine entries plus
    <Routine>_<Role> branch targets; zero Label_ remains
  - all 48 raw $XXXX jsr/jmp operands resolved to labels; zero raw $XXXX
    call or branch operands remain
  - the map is in routinemap.tsv

Pass 3:
  - 30 semantic zero-page aliases, each applied only at the sites where its
    role is proven (per-site choice in sites.tsv; the addresses that carry
    two roles keep the neutral ZpXX name elsewhere).  _tools/
    derive_zp_aliases.py records how the set was derived, and locals.inc
    records the reason for every remaining neutral slot
  - 28 data tables named (new tool _tools/name_data_region.py), including
    CharacterDataTable ($C66A) and CharacterNameStrings ($C67E), where the
    ROM itself names Blinky, Pinky, Inky and Clyde - which is why the four
    indexed entities are called ghosts and not 'actors'
  - apply_symbols.py reports 0 substitutions pending and 0 residue
  - audit-comment alignment re-done with _tools/align_audit_comments.py;
    all 2,479 audit comments still match prg.bin at the stated PRG offset

Pass 1 correction - six command handlers recovered (new tool
_tools/recode_region.py).  ScriptCommandTable ($EFDD) is read by the traced
instruction at $EFCC, and six of its entries point at $F00A, $F022, $F03A,
$F052, $F062 and $F072 - all of which the tracer had left as data, and two
of which it had mis-split across the 'jmp $EF61' at $F01F and $F04F.
Those 120 bytes are code here, decoded straight from the ROM; the six
handlers tile $F00A-$F081 exactly.  The same gap exists in the promoted
'Pac-Man (U)' dump, which has not been corrected - recorded in both READMEs.

Residue (documented, not guessed): the unreached main game logic at
$C45A-$C55F is still .byte data.  It is code - the tracer's own decoder
walks it cleanly and the dispatch table at $C511 points into it - but
nothing reaches it, so it cannot be entered without a guess.  The same gap
exists in the promoted 'Pac-Man (U)' dump.  Re-deriving it is a Pass 1 job;
a Mesen Code Data Logger capture is the tool the repo uses for it.

Docs: root README.md / TODO.md / AGENTS.md updated - 32 promoted, 4 in
_wip/; a per-project detail entry added for the Tengen dump.

Promote Pyramid (U): Pass 1 corrected, Pass 2/3 complete, whole-ROM byte-identical

Move _wip/NROM/Pyramid (U) to NROM/ and switch the build from a PRG-only
compare to a whole-ROM one:

  - header.s/chr.s added (one-line .incbin of header.bin / chr.bin)
  - linker.cfg gains HEADER ($0000, $0010) and CHR ($0000, $2000)
    areas ahead of PRG ($C000, $4000)
  - rom.nes symlink to 'Pyramid (U) (Sachen).nes'
  - reconstructed.nes is 24,592 bytes, MD5 aa285ff17f25dd05da5996b7466c59e2
    - equal to the original ROM; the header/prg/chr splits were checked
    against the original before promotion and are byte-exact

Pass 1 correction - the committed split was a strict subset of the correct
one.  This game dispatches through 'jmp' trampoline tables that live
*inside* the data regions, and the tracer cannot follow a jmp there, so
828 bytes of code were still marked as data.  Four such tables were found
($C01E 3 entries, $C02A 6, $C042 2, $C054 5) plus ten more entries at
$C000-$C01B; all sixteen targets decode as valid instructions.  Seeding
them, the $C800 boot mainline and six further code starts recovers the
whole lot, plus a five-byte stub at $DF89 (lda $33 / jmp $DECB) that sat
in a hole between two routines.  The re-trace loses NO committed code byte
and takes the split from 34.5% to 39.6% (3,130 instructions / 6,493 code
bytes).  'make regen' reproduces it, so the split stays verifiable.

Pass 2 - a fresh map derived from this dump's own committed split:
  - 428 Label_XXXX definitions renamed; zero Label_ residue
  - 320 raw $XXXX jsr/jmp operands resolved; zero raw $XXXX branch
    operands remain
  - 431 routine entries and the 32 data blocks named from the code
  - the internal branch-target names are derived mechanically from the
    branch that reaches them by the new _tools/derive_branch_names.py
    (beq -> OnZero, bne -> OnNonzero, bcc/bcs -> the carry cases, a
    backwards branch -> Loop)
  - recorded in routinemap.tsv

Pass 3:
  - 24 semantic zero-page aliases, each applied only where its role is
    proven; the 57 slots that stay neutral are each listed with the reason
    in locals.inc (the neutral set lives in zp_aliases.inc so that
    'make regen' can rebuild locals.inc from prg.bin)
  - 32 data tables named - TaskVectorTable1/2, LevelScriptData,
    MusicPeriodTable, SoundEnvelopeTable, the actor tables - recorded in
    data_region_names.tsv
  - apply_symbols.py reports 0 substitutions pending and 0 residue; no
    hardware register is left as a raw literal
  - the audit comments are now canonical on every line, data included
    (the old file carried only 'PRG:$xxxx' on its 1,358 data lines);
    all 3,762 audit comments match prg.bin at their stated PRG offset

Kept as-is, not 'cleaned up':
  - sta $4100 stays a raw operand.  The iNES header claims mapper 0 but
    the boot code writes past the NES register space; the ROM does not
    explain it, so it is recorded rather than guessed
  - the 'A'/'V' check on RAM $0120/$0121 and its seed/clear routines
    are named for what they do, not for what they are for
  - the ninth entry of the $C3A6 task vector table ($D820) is a junk
    slot and stays data

Docs: root README.md / TODO.md / AGENTS.md updated - 33 promoted, 3 in
_wip/; a per-project detail entry added.

Hogan's Alley (JU): Pass 1 correction, Pass 2, Pass 3, promoted to NROM/

The light-gun game whose engine dispatches through *inline* tables:
`IndirectCall` at $C34D pops the return address of the `jsr` that called
it and reads a 16-bit handler pointer from the word that follows, so all
six handler tables ($C124 19 entries, $C219 4, $C89C 14, $CDD1 1, $D234 2,
$D3D6 14) live inside the code stream and the static tracer cannot follow
them.

Pass 1 correction.  The committed split was a strict subset of the correct
one -- 41.8% of the PRG was classified as code.  A fresh Mesen Code Data
Logger capture was merged with the four captures already in the folder
(hogans_merged.cdl, the OR of five per-byte flag arrays, 6,544 code bytes)
and _tools/cdl_reclass.py rewrote the split to match what the CPU actually
fetched: 1,216 bytes moved from data to code, five the other way, 59 labels
emitted.  The split is now 49.1% code (3,950 instructions, 8,041 bytes).
The four branch targets the reclassifier could not prove were turned into
labels by the new _tools/resolve_raw_branches.py.

Pass 2.  206 routine entries hand-named from this dump's own code and 413
internal branch targets derived mechanically by _tools/derive_branch_names.py:
630 Label_XXXX definitions gone, 484 raw $XXXX call operands resolved, 15
call targets the tracer had never labelled given a label.  Recorded in
routinemap.tsv.  No SubC<addr> residue was needed -- every entry the engine
reaches is named after what it does.

Pass 3.  60 semantic zero-page aliases, each applied only where its role is
proven (zp_aliases.inc, zp_alias_sites.tsv); the slots that stay neutral are
each listed with the reason.  All 34 data blocks named
(data_region_names.tsv).  apply_symbols.py reports 1 residue: `sta a:$00B4,y`
at $C203, the same address as Zp40/ActorPalette but forced to absolute
addressing, so it must stay numeric.

Promotion.  header.s, chr.s and a HEADER/PRG/CHR linker.cfg added, rom.nes
symlinked to the original ROM; the whole-ROM cmp passes on the first
promoted build.  There is deliberately no `make regen` target: the Pass 1
split here is the static trace corrected by a CDL capture, and the base the
correction was applied to is not what the current _tools/nesdis.py
produces, so prg.s is the maintained source of truth.

Tools changed:
  nesdis.py             --split/--note/--provenance options, so a data
                          region can carry its own name and explanation;
                          a forced-data address is no longer reported as a
                          recovered routine entry
  apply_pass2_map.py    can create the label for a call target the tracer
                          left unlabelled; no longer double-labels it
  apply_zp_aliases.py   --at-file, an address-based per-site list
  derive_branch_names.py keeps the map's own header instead of writing a
                          fixed one
  resolve_raw_branches.py  new: turns `bXX *+$NN` operands into labels
  build_hogans_map.py   new: the hand-written Pass 2 map builder

The existing regen pipelines (MUSCLE (U), Urban Champion (JU)) still
reproduce prg.s byte for byte.

Apply the symbols.inc register names at Pass 1; fix a dropped byte in cdl_reclass

nesdis.py now names the hardware registers as it renders the operands, so a
project's Pass 1 output already reads `lda PPUSTATUS` instead of `lda $2002`
and the Pass 3 apply_symbols.py step has nothing left to do for them.

  * nesdis.py --symbols FILE reads a symbols.inc-style file and substitutes
    the register names.  Only unambiguous entries in the $2000-$4017 window
    are used: $4017 is both JOY2 and APUFRAMECOUNTER, so it stays numeric
    and apply_symbols.py reports it as multi-alias residue, exactly as
    before.  The default is the symbols.inc next to --out, so a new project
    gets the names without asking; --no-symbols opts out.
  * The renderer records the operand's numeric value on the Insn, because
    operand_value() used to re-parse the operand text and could no longer
    read a name.
  * The controller bit masks in symbols.inc (PAD_A and friends) are
    constants, not addresses, and are still never substituted.

MUSCLE (U) and Urban Champion (JU) keep --no-symbols: their committed
prg.s was produced with the registers named by the Pass 3 apply_symbols.py
step, and the columns in those files reflect the in-place substitution.
Adding the missing apply_symbols.py step to both regen pipelines makes
them reproduce their committed prg.s byte for byte again - neither did
before this change (MUSCLE was 440 lines out, Urban Champion 772).

cdl_reclass.py had a bug that cost a byte: a region whose last source row
straddled the region's end was replaced by a regeneration of the region
only, so the tail of that row was dropped.  Mario Bros (JU) hit it at
$C595, where the rebuild came out one byte short and every label after it
shifted.  A region now covers the whole rows it replaces.

pass2.py reflow takes an optional column argument; the default is
unchanged (the ';' lands on the same column as before).

Mario Bros (JU): Pass 1 correction, Pass 2, Pass 3, promoted to NROM/

A two-player platformer whose handler tables are *inline*: the pointers sit
in the middle of the code stream, right after the `jsr` that reads them, so
the static tracer could never follow them.

Pass 1 correction.  The committed split was a strict subset of the correct
one -- only 72.0% of the PRG was classified as code.  A Mesen Code Data
Logger capture of this ROM (mario_mesen.cdl, 10,915 code bytes) showed
1,010 bytes the tracer had left as data were code; two branch targets the
capture never reached ($E4CB and $E639) were forced with --override for 57
more, so 1,067 bytes moved from data to code and 22 moved the other way.
The split is now 78.4% code (6,210 instructions, 12,847 bytes).  The three
branch targets the reclassifier could not prove were turned into labels by
_resolve_raw_branches.py, which now refuses to put a label on a `.byte` row.

Pass 2.  206 routine entries and 519 internal branch targets: 931
Label_XXXX definitions gone, 51 raw $XXXX call operands resolved and 12 call
targets the tracer had never labelled given a label.  Zero SubC residue --
the 185 entries a previous session had left as address-derived residue were
all named from this dump's own code.  Recorded in routinemap.tsv.

Pass 3.  25 semantic zero-page aliases, each applied only where its role is
proven (zp_aliases.inc); the slots that stay neutral are each listed with the
reason.  35 data tables named -- GameStateHandlerTable, EnemyBehaviourTable,
EnemyScriptTable, EnemyTypePointerTable, SoundRoutineTable,
NoteFrequencyTable and the rest -- and recorded in
data_region_names.tsv.  apply_symbols.py reports 0 residue.

Promotion.  header.s, chr.s and a HEADER/PRG/CHR linker.cfg added, rom.nes
symlinked to the original ROM; the whole-ROM cmp passes on the first
promoted build.  There is deliberately no `make regen` target: the Pass 1
split here is the static trace corrected by a CDL capture, and the base the
correction was applied to is not what the current _tools/nesdis.py
produces, so prg.s is the maintained source of truth.

Tools:
  apply_pass2_map.py     renames a label of any spelling -- SubC<addr> is
                          the honest residue form -- and its references
                          follow it; one combined pattern, so a 16,000-line
                          file does not need a substitution per label
  resolve_raw_branches.py refuses to label a data row
  build_mario_map.py      new: the hand-written Pass 2 map builder

Remove the old _wip/NROM/Mario Bros (JU) folder (promoted to NROM/)

Mario Bros (JU): add the promoted-tier header, CHR, rom.nes symlink and zero-page aliases

Moves _ROMS/<ROM> into _wip/<MAPPER>/<ROM>

Sync the docs and the skeleton tool with the 857-project _wip tier

The _wip/ tier now holds 857 projects across 30 mapper folders, all
building byte-identical for the whole ROM.  README.md, TODO.md and
AGENTS.md still described the old 39-project tier, so bring them in line
with WIP.md, which carries the tier's index.

The tier is no longer 39 projects of NROM-256 with a 16/32 KB PRG:
only two projects have a 16 KB PRG, 151 have 32 KB, 523 have 128 KB and
one has 1.5 MB, so most of it is a banked mapper whose image does not fit
the 6502's address space.  Those projects link their MEMORY areas at .nes
file offsets rather than CPU addresses, which is the only option and the
honest model; the 39 older projects keep the CPU-address layout because
their PRG really is one contiguous window.

make_skeleton.py gains the two layouts (--layout flat|cpu), the board
name for the mapper, and a fix for find_rom() mistaking the build
output reconstructed.nes for the source ROM.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-10-20 16:44:06 -04:00

12 KiB

1labelLabel_C79EReset
2labelLabel_C7E1MainGameLoop
3labelLabel_C7E7InitPPU_1
4labelLabel_C7E1GameLoopEntry
5labelLabel_C7E7InitPPURegisters
6labelLabel_C85FNmiHandler
7labelLabel_C8C1NmiFrameUpdate
8labelLabel_C8CBNmiFrameUpdate2
9labelLabel_C8D4NmiFrameUpdate3
10labelLabel_C8D7NmiFrameUpdate4
11labelLabel_C8E8NmiFrameEnd
12labelLabel_C8F3InitAPURegisters
13labelLabel_C8F3InitAPU
14labelLabel_C8FEInitSound_1
15labelLabel_C914InitLevel
16labelLabel_C940UpdateGameState
17labelLabel_C95DUpdateGameState2
18labelLabel_C98AUpdateGameState3
19labelLabel_CA30UpdateSprites
20labelLabel_CA53UpdateSprites2
21labelLabel_CA56CallCBAE
22labelLabel_CA5CCallCBB7
23labelLabel_CAA9CopyToOAM
24labelLabel_CAB9CopyFromOAM
25labelLabel_CAC9UpdateSpriteData
26labelLabel_CB1BHandleController
27labelLabel_CBAEClearZeropage
28labelLabel_CBB7WaitVBlank_1
29labelLabel_CBBDUpdateScroll
30labelLabel_CBCAUpdateScroll2
31labelLabel_CBF4UpdateScroll3
32labelLabel_CBF5UpdateOAM
33labelLabel_CBF7UpdateOAM2
34labelLabel_CC03UpdateOAM3
35labelLabel_CC04UpdateScroll4
36labelLabel_CC23UpdateScroll5
37labelLabel_CC34UpdateScroll6
38labelLabel_CC47InitScroll
39labelLabel_CCC1UpdateScroll7
40labelLabel_CCD6UpdateScroll8
41labelLabel_CCF4CheckGameState_1
42labelLabel_CD22UpdateGameTimer
43labelLabel_CD6FUpdateSpritePosition
44labelLabel_CD76UpdateSpritePosition2
45labelLabel_CD7FUpdateSpritePosition3
46labelLabel_CD89UpdateSpritePosition4
47labelLabel_CD9DUpdateSpritePosition5
48labelLabel_CDB1UpdateSpritePosition6
49labelLabel_CDCAUpdateSpritePosition7
50labelLabel_CE0EUpdateSpritePosition8
51labelLabel_CE24UpdateSpritePosition9
52labelLabel_CE7CUpdateSpritePosition10
53labelLabel_CED6UpdateSpritePosition11
54labelLabel_CF13UpdateSpritePosition12
55labelLabel_CF19UpdateSpritePosition13_1
56labelLabel_CF1CUpdateSpritePosition13_3
57labelLabel_CF2BUpdateSpritePosition14
58labelLabel_CF42UpdateSpritePosition15
59labelLabel_CF87UpdateSpritePosition16
60labelLabel_CFA8UpdateSpritePosition17
61labelLabel_CFC6UpdateSpritePosition18
62labelLabel_D008UpdateSpritePosition19
63labelLabel_D032UpdateSpritePosition20
64labelLabel_D041UpdateSpritePosition21_1
65labelLabel_D04CUpdateSpritePosition21_3
66labelLabel_D086UpdateSpritePosition22_1
67labelLabel_D0B5UpdateSpritePosition22_3
68labelLabel_D0C0UpdateSpritePosition23
69labelLabel_D11FUpdateSpritePosition24
70labelLabel_D169UpdateSpritePosition25
71labelLabel_D175UpdateSpritePosition26
72labelLabel_D19AUpdateSpritePosition27
73labelLabel_D1A4UpdateSpritePosition28
74labelLabel_D1AAUpdateSpritePosition29
75labelLabel_D1CFUpdateSpritePosition30
76labelLabel_D208UpdateSpritePosition31
77labelLabel_D25DUpdateSpritePosition32
78labelLabel_D275UpdateSpritePosition33
79labelLabel_D28BUpdateSpritePosition34
80labelLabel_D2CBUpdateSpritePosition35
81labelLabel_D2DFUpdateSpritePosition36
82labelLabel_D2FDUpdateSpritePosition37
83labelLabel_D323UpdateSpritePosition38
84labelLabel_D326UpdateSpritePosition39
85labelLabel_D32FUpdateSpritePosition40
86labelLabel_D360UpdateSpritePosition41
87labelLabel_D36AUpdateSpritePosition42_1
88labelLabel_D37BUpdateSpritePosition42_3
89labelLabel_D37EUpdateSpritePosition43
90labelLabel_D38EUpdateSpritePosition44
91labelLabel_D3AAUpdateSpritePosition45
92labelLabel_D3CCUpdateSpritePosition46
93labelLabel_D4A1UpdateSpritePosition47
94labelLabel_D4B9UpdateSpritePosition48
95labelLabel_D4CFUpdateSpritePosition49
96labelLabel_D4F0UpdateSpritePosition50
97labelLabel_D5C1UpdateSpritePosition51
98labelLabel_D5D1UpdateSpritePosition52
99labelLabel_D5F5UpdateSpritePosition53
100labelLabel_D6A8UpdateSpritePosition54
101labelLabel_D730UpdateSpritePosition55
102labelLabel_D739UpdateSpritePosition56
103labelLabel_DBB6UpdateSpritePosition57
104labelLabel_DBC8UpdateSpritePosition58
105labelLabel_DBE3UpdateSpritePosition59
106labelLabel_DBFAUpdateSpritePosition60
107labelLabel_DC0DUpdateSpritePosition61
108labelLabel_DC11UpdateSpritePosition62
109labelLabel_DC3EUpdateSpritePosition63
110labelLabel_DCAAUpdateSpritePosition64
111labelLabel_DCDDUpdateSpritePosition65
112labelLabel_DCE3UpdateSpritePosition66
113labelLabel_DCECUpdateSpritePosition67
114labelLabel_DD32UpdateSpritePosition68
115labelLabel_DD5DUpdateSpritePosition69
116labelLabel_DD75UpdateSpritePosition70
117labelLabel_DD78UpdateSpritePosition71
118labelLabel_DD8FUpdateSpritePosition72
119labelLabel_DD92UpdateSpritePosition73
120labelLabel_DDA3UpdateSpritePosition74
121labelLabel_DDACUpdateSpritePosition75
122labelLabel_DDBEUpdateSpritePosition76
123labelLabel_DDBEUpdateSpritePosition77
124labelLabel_DDC7UpdateSpritePosition78
125labelLabel_DDF1UpdateSpritePosition79
126labelLabel_DE30UpdateSpritePosition80
127labelLabel_DE41UpdateSpritePosition81
128labelLabel_DE63UpdateSpritePosition82
129labelLabel_DE75UpdateSpritePosition83
130labelLabel_DE7EUpdateSpritePosition84
131labelLabel_DE30UpdateSoundEngine
132labelLabel_E023WaitVBlank_3
133labelLabel_E025WaitVBlank2
134labelLabel_E02CWaitVBlank3
135labelLabel_E035WaitPPUReady
136labelLabel_E046WaitFrame
137labelLabel_E049InitPPU_3
138labelLabel_E09BInitSprites
139labelLabel_E0E3DrawSprite
140labelLabel_E0EFWritePPU
141labelLabel_E0F6WritePPU2
142labelLabel_E0FDInitGame
143labelLabel_E278UpdateBallTrajectory
144labelLabel_E28AInitSound_3
145labelLabel_E293InitSprites2
146labelLabel_E2A6UpdateBallPhysics
147labelLabel_E3E2UpdateGameMode
148labelLabel_E403CheckGameState_3
149labelLabel_E40EUpdateDisplay
150labelLabel_E459UpdateDisplay2
151labelLabel_E48CUpdateSprites3
152labelLabel_E497UpdateDisplay3
153labelLabel_E4E2UpdateDisplay4
154labelLabel_E506PlaySound
155labelLabel_E535PlaySoundEffect
156labelLabel_E54APlayMusic
157labelLabel_E5B2UpdateMusic
158labelLabel_E609UpdateMusicEngine
159labelLabel_E68FUpdateMusicChannel
160labelLabel_E7ACUpdateMusicChannel2
161labelLabel_E94DUpdateSoundEffects
162labelLabel_E96AUpdateSoundChannel2
163labelLabel_E9EDUpdateSoundChannel3
164labelLabel_EA2FUpdateSoundChannels
165labelLabel_EA50UpdateSoundEffect
166labelLabel_EA58UpdateSoundEffect2
167labelLabel_EAD1UpdateSoundChannel4
168labelLabel_EAE5UpdateSoundChannel5
169labelLabel_EB0DUpdateSoundChannel6
170labelLabel_EB27UpdateSoundChannel7
171labelLabel_EB9DUpdateSoundChannel8
172labelLabel_EBF9UpdateSoundChannel9
173labelLabel_EC80UpdateMusic2
174labelLabel_EC8DUpdateMusicChannel10
175labelLabel_ED06UpdateMusicChannel11
176labelLabel_EDB0UpdateMusicChannel12
177labelLabel_EDEDUpdateMusicChannel13
178labelLabel_EDF2UpdateMusicChannel14
179labelLabel_EE3DUpdateMusicChannel15
180labelLabel_EE4DUpdateMusicChannel16
181labelLabel_EF28UpdateMusicChannel17
182labelLabel_EF79UpdateMusicChannel18
183labelLabel_EFD3UpdateMusicChannel19
184labelLabel_EFDCUpdateMusicChannel20
185labelLabel_F03FUpdateMusicChannel21
186labelLabel_F06FUpdateMusicChannel22
187labelLabel_F0C4UpdateMusicChannel23
188labelLabel_F0DFUpdateMusicChannel24_1
189labelLabel_F0E7UpdateMusicChannel24_3
190labelLabel_F138UpdateMusicChannel25
191labelLabel_F140UpdateMusicChannel26_1
192labelLabel_F1FBUpdateMusicChannel26_3
193labelLabel_F226UpdateMusicChannel27
194labelLabel_F2F0UpdateMusicChannel28
195labelLabel_F321UpdateMusicChannel29
196labelLabel_F3B9UpdateMusicChannel30
197labelLabel_F3E8UpdateMusicChannel31
198labelLabel_F41EUpdateMusicChannel32
199labelLabel_F44BUpdateMusicChannel33
200labelLabel_FB2CUpdateAPU
201labelLabel_FB40UpdateAPU2
202labelLabel_FB43UpdateAPU3
203labelLabel_FB46UpdateAPU4
204labelLabel_FB49UpdateAPU5
205labelLabel_FB5DUpdateAPU6
206labelLabel_FB6EUpdateAPU7
207labelLabel_FBDDUpdateAPU8
208labelLabel_FC0FUpdateAPU9
209labelLabel_FC2BUpdateAPU10
210labelLabel_FC72UpdateAPU11
211labelLabel_FCE2UpdateAPU12
212labelLabel_FD0DUpdateAPU13
213labelLabel_FD55UpdateAPU14
214labelLabel_FD91UpdateAPU15
215labelLabel_FFDCUpdateAPU16
216labelLabel_FFE3UpdateAPU17
217labelLabel_FFE9UpdateAPU18
218labelLabel_FFF0UpdateAPU19
219labelLabel_FFF7ResetVector
220zpZp00TempPtrLo
221zpZp01TempPtrHi
222zpZp02TempReg
223zpZp03TempReg2
224zpZp04TempReg3
225zpZp05TempReg3
226zpZp06TempReg4
227zpZp07TempReg5
228zpZp08TempReg6
229zpZp09TempReg7
230zpZp0ATempReg8
231zpZp0BTempReg9
232zpZp0CTempReg10
233zpZp0DTempReg11
234zpZp0ETempReg12
235zpZp0FTempReg13
236zpZp10PPUCtrlShadow
237zpZp11PPUMaskShadow
238zpZp12PPUScrollX
239zpZp13PPUScrollY
240zpZp10PPUCtrlShadow
241zpZp11PPUMaskShadow
242zpZp12PPUScrollX
243zpZp13PPUScrollY
244zpZp14TempReg14
245zpZp15TempReg15
246zpZp16TempReg16
247zpZp17TempReg17
248zpZp18TempReg18
249zpZp19TempReg19
250zpZp1ATempReg20
251zpZp1BTempReg21
252zpZp1CTempReg22
253zpZp1DTempReg23
254zpZp1ETempReg24
255zpZp1FTempReg25
256zpZp20TempReg26
257zpZp21TempReg27
258zpZp22TempReg28
259zpZp23TempReg29
260zpZp24TempReg30
261zpZp25TempReg31
262zpZp26TempReg32
263zpZp27TempReg33
264zpZp28TempReg34
265zpZp29TempReg35
266zpZp2ATempReg36
267zpZp2BTempReg37
268zpZp2CTempReg38
269zpZp2DTempReg39
270zpZp2ETempReg40
271zpZp2FTempReg41
272zpZp2FTempReg42
273zpZp30TempReg43
274zpZp31TempReg44
275zpZp32TempReg45
276zpZp33TempReg46
277zpZp34TempReg47
278zpZp35TempReg48
279zpZp36TempReg49
280zpZp37TempReg50
281zpZp38TempReg51
282zpZp39TempReg52
283zpZp3ATempReg53
284zpZp3BTempReg54
285zpZp3CTempReg55
286zpZp3DTempReg56
287zpZp3ETempReg57
288zpZp3FTempReg58
289zpZp40TempReg59
290zpZp41TempReg60
291zpZp42TempReg61
292zpZp43TempReg62
293zpZp44TempReg63
294zpZp45TempReg64
295zpZp46TempReg65
296zpZp47TempReg66
297zpZp48TempReg67
298zpZp49TempReg68
299zpZp4ATempReg69
300zpZp4BTempReg70
301zpZp4CTempReg71
302zpZp4DTempReg72
303zpZp4ETempReg73
304zpZp4FTempReg74
305zpZp50TempReg75
306zpZp51TempReg76
307zpZp52TempReg77
308zpZp53TempReg78
309zpZp54TempReg79
310zpZp55TempReg80
311zpZp56TempReg81
312zpZp57TempReg82
313zpZp58TempReg83
314zpZp59TempReg84
315zpZp5ATempReg85
316zpZp5BTempReg86
317zpZp5CTempReg87
318zpZp5DTempReg88
319zpZp5ETempReg89
320zpZp5FTempReg90
321zpZp5FTempReg91
322zpZp60TempReg92
323zpZp61TempReg93
324zpZp62TempReg94
325zpZp63TempReg95
326zpZp64TempReg96
327zpZp65TempReg96
328zpZp66TempReg97
329zpZp67TempReg98
330zpZp68TempReg99
331zpZp69TempReg100
332zpZp6ATempReg101
333zpZp6BTempReg102
334zpZp6CTempReg103
335zpZp6DTempReg104
336zpZp6ETempReg105
337zpZp6FTempReg106
338zpZp70TempReg107
339zpZp71TempReg108
340zpZp72TempReg109
341zpZp73TempReg110
342zpZp74TempReg111
343zpZp75TempReg111
344zpZp76TempReg112
345zpZp77TempReg113
346zpZp78TempReg114
347zpZp79TempReg115
348zpZp7ATempReg116
349zpZp7BTempReg117
350zpZp7CTempReg118
351zpZp7DTempReg119
352zpZp7ETempReg120
353zpZp7FTempReg121
354zpZp80TempReg122
355zpZp81TempReg123
356zpZp82TempReg124
357zpZp83TempReg125
358zpZp84TempReg126
359zpZp85TempReg127
360zpZp86TempReg128
361zpZp87TempReg129
362zpZp88TempReg130
363zpZp89TempReg131
364zpZp8ATempReg132
365zpZp8BTempReg133
366zpZp8CTempReg134
367zpZp8DTempReg135
368zpZp8ETempReg136
369zpZp8FTempReg137
370zpZp90TempReg138
371zpZp91TempReg139
372zpZp92TempReg140
373zpZp93TempReg141
374zpZp94TempReg141
375zpZp95TempReg142
376zpZp96TempReg143
377zpZp97TempReg144
378zpZp98TempReg145
379zpZp99TempReg146
380zpZp9ATempReg147
381zpZp9BTempReg148
382zpZp9CTempReg149
383zpZp9DTempReg150
384zpZp9ETempReg151
385zpZp9FTempReg152
386zpZpA0TempReg153
387zpZpA1TempReg154
388zpZpA2TempReg155
389zpZpA3TempReg156
390zpZpA4TempReg157
391zpZpA5TempReg158
392zpZpA6TempReg159
393zpZpA7TempReg160
394zpZpA8TempReg161
395zpZpA9TempReg162
396zpZpAATempReg163
397zpZpABTempReg164
398zpZpACTempReg165
399zpZpADTempReg166
400zpZpAETempReg167
401zpZpAFTempReg168
402zpZpB0TempReg169
403zpZpB1TempReg170
404zpZpB2TempReg171
405zpZpB3TempReg172
406zpZpB4TempReg173
407zpZpB5TempReg174
408zpZpB6TempReg175
409zpZpB7TempReg176
410zpZpB8TempReg177
411zpZpB9TempReg177
412zpZpBATempReg178
413zpZpBBTempReg179
414zpZpBCTempReg180
415zpZpBDTempReg181
416zpZpBETempReg182
417zpZpBFTempReg183
418zpZpC0TempReg184
419zpZpC1TempReg185
420zpZpC2TempReg186
421zpZpC3TempReg187
422zpZpC4TempReg188
423zpZpC5TempReg189
424zpZpC6TempReg190
425zpZpC7TempReg191
426zpZpC8TempReg192
427zpZpC9TempReg193
428zpZpCATempReg194
429zpZpCBTempReg195
430zpZpCCTempReg196
431zpZpCDTempReg197
432zpZpCETempReg198
433zpZpCFTempReg199
434zpZpD0TempReg185
435zpZpD1TempReg186
436zpZpD2TempReg187
437zpZpD3TempReg188
438zpZpD4TempReg189
439zpZpD5TempReg190
440zpZpD6TempReg191
441zpZpD7TempReg192
442zpZpD8TempReg193
443zpZpD9TempReg194
444zpZpDATempReg195
445zpZpDBTempReg196
446zpZpDCTempReg197
447zpZpDDTempReg198
448zpZpDETempReg199
449zpZpDFTempReg200
450zpZpE0TempReg201
451zpZpE1TempReg202
452zpZpE2TempReg203
453zpZpE3TempReg204
454zpZpE4TempReg205
455zpZpE5TempReg206
456zpZpE6TempReg207
457zpZpE7TempReg208
458zpZpE8TempReg209
459zpZpE9TempReg210
460zpZpEATempReg211
461zpZpEBTempReg212
462zpZpECTempReg213
463zpZpEDTempReg214
464zpZpEETempReg215
465zpZpEFTempReg216
466zpZpF0TempReg217
467zpZpF1TempReg218
468zpZpF2TempReg219
469zpZpF3TempReg220
470zpZpF4TempReg221
471zpZpF5TempReg222
472zpZpF6TempReg223
473zpZpF7TempReg224
474zpZpF8TempReg225
475zpZpF9TempReg226
476zpZpFATempReg227
477zpZpFBTempReg228
478zpZpFCTempReg229
479zpZpFDTempReg230
480zpZpFETempReg231
481zpZpFFTempReg232