Files
disasm/NROM/Volleyball (U)
tmerritt 691b2bc23c Xevious (U): Pass 1 disassembly
The first _wip project to get a real disassembly.  4,165 instructions /
8,444 code bytes (25.8%), 24,324 data bytes, 0 unclassified -- every byte
of the 32 KB PRG is now classified as code or data.

The split needed three stages, all recorded in prg.s's header:

  * nesdis.py --undocumented --auto-seed at base $8000 gave 3,272
    instructions / 6,555 bytes.  The undocumented opcodes matter here: the
    trace stops dead at the first one it cannot decode.
  * Four hand-seeded entries ($C08B, $DC1E, $E0D5, $E134).  Each is a
    branch target from decoded code that sat inside an untraced data run,
    so the tracer never reached it.
  * A merged four-session Mesen Code Data Logger capture (kept as
    xevious_mesen.cdl) promoted 1,902 bytes from data to code and
    demoted 22 the trace had called code.

Two tool bugs fell out and are fixed here:

  * nesdis.py emitted the undocumented single-byte NOPs ($1A/$3A/$5A/
    $7A/$DA/$FA) as `nop`, which ca65 assembles as the *official* $EA --
    the rebuild stopped being byte-identical at $DF82.  The check now
    keys on the opcode byte, not just the addressing mode.  All three
    `make regen` pipelines (MUSCLE, Pyramid, Urban Champion) are
    unaffected and still reproduce prg.s byte for byte.

  * cdl_reclass.py left the original data-block header in place when the
    CDL split that block, so the file ended up with two region headers
    describing overlapping spans (20 of them here).  The header is now
    dropped with the block it describes; the promoted projects that use
    the tool are byte-for-byte unchanged.

The project README has the power-on flow analysis.  The most interesting
find is at $FC45: the reset path compares RAM $0100-$0107 against the
ASCII string "Kei Cros", and the copyright text at $FF1E reads
"MAIN: KEI CROSS.  SOUND: UHOHOY OHNOGI."  The OAM is at $0700, not
$0200 -- the NMI handler does LDA #$07 / STA $4014.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Add explicit `make wip` / `make wipclean` targets for the _wip tier

The root Makefile's all / clean / <MAPPER> targets deliberately name only
the promoted mapper folders, so nothing in them reaches into _wip/.  Give
the pre-promotion tier its own opt-in targets instead of the manual
`for d in _wip/*/*/; do make -C "$d"; done` loop:

  make wip          # build + verify every _wip/<MAPPER>/<Project>/
  make wipclean     # clean the build artifacts in that tier

Both the Makefile and the four documents that describe the tier (README,
TODO, WIP, AGENTS) are updated together, so the tree stays consistent.

The same commit records Xevious (U) reaching Pass 2 in those documents:
all 487 labels named, every branch and call symbolic, zero Label_XXXX and
zero raw $XXXX operands left.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Update the _wip/ tier documentation; fix the make wip target and the mirroring bug

The WIP tier's four documents (WIP.md, README.md, TODO.md, AGENTS.md) had
drifted away from the tree.  Every number in them was re-derived from the
ROMs and the folder layout rather than carried forward.

Counts and structure
  - The tier holds 854 projects across 29 mapper folders, not "856 across
    30".  Xevious (U) and Zanac (U) were promoted on 2026-10-20 and their
    _wip/ folders were left behind as residue -- "git mv" moves only the
    tracked files, so the old folder survived with its build artifacts and a
    stale README.  Both are removed now; the promotion procedure documents
    the step so it does not recur.
  - _wip/MAPPER8/ holds a copy of the already-promoted Mermaids of
    Atlantis (U) and is excluded from every count and table.
  - Pass 0 skeletons: 852 (was 855).  Xevious (U) left the tier, so the
    two projects with a real disassembly are Golf (JU) and Volleyball (U).
  - PRG sizes 2 / 150 / 42 / 522 / 127 / 10 / 1; 226 projects with no CHR;
    38 keep the CPU-address linker layout; 37 are mapper 0.
  - Every inventory row was re-checked against its ROM: PRG/CHR size,
    mirroring, all three vectors, and the battery / four-screen / footer
    notes.  854 of 854 rows now match.

Fixes
  - The root Makefile used $(WIP) but never defined it, so "make wip" and
    "make wipclean" expanded to "for m in /*/" -- they walked the
    filesystem root instead of the tier.  "WIP := _wip" is now defined, and
    "make wip" builds and verifies the whole tier: 855 of 855 passed, 0
    failures.
  - make_skeleton.py masked header byte 6 with 0x03, so the battery bit
    (bit 1) leaked into the mirroring value and 56 battery-backed ROMs'
    READMEs claimed "Four-screen" while their own "Four-screen VRAM" row
    said "no".  The mask is now 0x01 and the 56 READMEs are corrected.
  - Golf (JU)'s README still described the pre-flatten copilot/ folder and
    the old PRG-only compare; it now describes the whole-ROM build.
  - Pyramid (U)'s audit comments are canonical again, so Golf (JU) is the
    only project in the tree still on the pre-canonical spelling.

New in WIP.md
  - Byte 7's lower nybble is non-zero on 58 of the ROMs -- 55 carry the
    literal "DiskDude!" watermark, two "DisNi0330", one "byKH+KEN".  Only
    the upper nybble carries mapper bits, so the noise is harmless.
  - The twelve ROMs that set the four-screen bit, split by whether their
    board actually supports four-screen VRAM.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Promote Volleyball (U) from _wip/NROM/ to NROM/

Volleyball (U) reached Pass 3 before promotion, so this is a promotion of a
finished disassembly rather than a Pass 0 skeleton.

The disassembly
  - 11,395 instructions / 23,926 code bytes (73.0 % of the PRG image),
    8,842 data bytes, 0 unclassified.
  - The split needed the game-state dispatch table at $85E1 declared to the
    tracer (--table 85E1:11) -- without it only 66 % of the image traced --
    plus a Mesen Code Data Logger capture taken while a random-input bot
    played the attract demo, which promoted 1,757 bytes from data to code.
  - Pass 2 named all 1,989 labels: 730 read out of the code by hand, 1,221
    internal branch targets derived mechanically.  Zero Label_XXXX, zero raw
    $XXXX call or branch operands, zero SubC residue.
  - Pass 3 named the zero page, the $0500 ball structure and all 37 data
    blocks.  apply_symbols.py --report: 0 pending substitutions, 0
    multi-alias residue.  align_audit_comments.py: no column drift.
  - cdl_check.py cross-checks the finished prg.s against the capture: 0
    CDL-code bytes not covered by an instruction, 0 CDL-data bytes that
    start one.
  - 29 neutral ZpXX zero-page slots remain, each with its reason recorded
    in locals.inc, as the promotion rules allow.

The promotion
  - git mv "_wip/NROM/Volleyball (U)" "NROM/Volleyball (U)".  Mapper 0, so
    it lands in NROM/.  The whole-ROM build was already in place, so there
    was no build surgery; the project builds byte-identically at its new
    home and the old folder is gone (git mv moves the untracked build
    artifacts too, so no residue was left behind).
  - Root README.md: new inventory row 39 and a per-project detail section,
    plus the WIP-tier counts.  The detail sections for Xevious (U) and
    Zanac (U) were numbered one too high against the inventory rows and
    are now aligned; a leftover editing note in the same place is gone.
  - WIP.md: the Volleyball row leaves the inventory, and the tier is now
    853 projects across 29 mapper folders (36 in _wip/NROM/), 852 of them
    Pass 0 skeletons.  Golf (JU) is the only project left in the tier with
    a real disassembly.
  - TODO.md and AGENTS.md: the same counts, and the promoted tier is now
    40 projects (39 under NROM/).

Verified: make wip builds and verifies the whole tier (854 of 854 passed,
0 failures) and make builds the promoted tier (39 of 39 passed).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Rename NROM/Pyramid (U) to NROM/Pyramid (U) (Sachen)

The promoted inventory row had read "Pyramid (U) (Sachen)" since the
project was promoted on 2026-10-20, but the folder was named "Pyramid (U)" --
so the row pointed at a folder that did not exist.  The folder now matches
the row, and the project's own README title, its ROM file name
("Pyramid (U) (Sachen).nes") and the parenthetical convention the rest of
the promoted tier already uses (Popeye (JU) (PRG 0/1), Raid on Bungeling
Bay (U) [a2], Pac-Man (Tengen) (U)).

What changed inside the project
  - The Makefile's regen target passes --project "Pyramid (U) (Sachen)", so
    the tracer writes the matching header line.  prg.s and locals.inc were
    updated to that header line and nothing else -- the disassembly is
    byte-identical to before.
  - make regen still reproduces prg.s and locals.inc byte for byte.
  - The project's README's build-verification line now names the new folder.

References updated: the root README.md (inventory prose, the row-33 detail
section, the build-status table, and the notable-observations bullet),
TODO.md (the promoted-projects table and the Pyramid notes) and AGENTS.md
(the recently-promoted list and the unlicensed-titles quirk).

Verified: make builds the promoted tier (39 of 39 passed) and the project
rebuilds byte-identically at its new path.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Rebuild Mermaids of Atlantis (U): bank-aware Pass 1, Pass 2/3 names

The promoted project did not build: a Pass 2 rename had been applied
half-way, leaving eight undefined symbols and two jumps that pointed at
the wrong routine, while the root README already claimed the project was
byte identical.  The _wip copy still built, because it held the un-renamed
Pass 1 source.

The disassembly is now derived from the ROM itself, with the Mesen Code
Data Logger as the oracle for the code/data split:

* _tools/banked_dis.py traces every MMC3 bank separately, each with the CPU
  window it is visible at, seeded from a CDL capture so the code a static
  trace cannot reach is disassembled too.  The CDL is the authority: a
  decode the CPU never fetched is dropped, and so is the fall-through
  behind a call whose target never returns (the game's dispatchers have
  their jump table right behind the call).
* One segment per bank (PRG0..PRG7) with its own .org, so the assembler
  knows the CPU address of every label while the linker still writes the
  bytes to the bank's file offset.  A flat segment cannot do both: a call
  would encode the file offset instead of the CPU address.
* Pass 2 names every label - 494 routines, no Label_XXXX and no raw
  $XXXX branch or jump operand left.  Pass 3 applies 13 semantic zero-page
  aliases and writes the routine headers.
* 8,075 bytes of code (12.3% of the 64 KB PRG), up from 200 bytes.

The banking turned out to be unusual and is documented: the fixed bank is
the fourth 8 KB bank (file $6000-$7FFF), not the last one, and the image
carries the reset stub and the vector table twice.  The live NMI vector
is $808F - the frame handler - while the copy at the end of the image
names $8189, which is a BRK in the first half.  The game's text table
lives at CPU $F1D6, which is the fixed window, and that is what settles
the question.

Also: the leftover _wip/MAPPER8 folder is removed, as it is for every
other promotion.

The project builds byte identical:

    Byte-identical ROM verified.

Add CHANGELOG.md: the pass history of every project

A project goes through four milestones - Pass 1 (the code/data split),
Pass 2 (the labels replaced by names), Pass 3 (the semantic naming) and
Promotion (the move into the top-level mapper folder) - and the history
of those milestones was scattered over the commit log, the project
READMEs and the root README.

CHANGELOG.md gathers it: one section per project with a row for each
milestone, the date, and a sentence saying what the milestone produced.
The numbers are the ones the project README and the root README already
carry - instruction count, code coverage, named labels, semantic
zero-page aliases, named data tables - so a reader can see at a glance
which projects are done and which are not.  Golf (JU), the only project
still in _wip/ with a real disassembly, is listed with its open
milestones, and the other 852 _wip/ projects are covered as a tier.

The requirement is now part of the workflow contract: PROMPTS.md gains a
"Pass 3: Changelog entry" section and a ninth checklist item, and
AGENTS.md points at the file.  A milestone and its changelog row go in
the same commit, so the changelog and the source never disagree.

Balloon Fight (JU): repair the audit trail and complete the routine headers

The per-instruction audit trail was stale by two bytes from
ResetInitializationData ($C085) onward.  5,944 of the 6,007 comments named
the wrong CPU address and PRG offset, because the three-byte .byte "HAL"
signature at $C082-$C084 had been counted as one byte when the trail was
first generated - the routine headers and the linker labels were right all
along, so the source and its own headers disagreed with each other.  The
trail was rebuilt from the ca65 -l listing with
_tools/repair_audit_comments.py, and every rewritten comment was re-checked
against prg.bin.  The comments were also moved into the canonical column-35
field: they had sat two spaces after the mnemonic, with no column discipline
at all, unlike every other promoted project.

All 63 routine headers now carry a ; Clobbers: block, so the headers carry
the full template AGENTS.md describes.  The blocks are derived, not written by
hand.  The new _tools/derive_clobbers.py takes the opcode from the audit
comment's byte list, so the addressing mode is exact and a data directive is
never mistaken for an instruction; it resolves the operand through
locals.inc and symbols.inc to name what is written; it follows the real
control flow, so a jsr to another named entry is a call (the callee's
clobbers count) while a branch or a fall-through is not; and it models
register preservation, so NmiHandler reports *no register* - it saves and
restores A, X and Y around the frame - and FlushPpuCommandPreserved reports
only A, because X and Y come back unchanged.

Two tools changed.  derive_clobbers.py is new.  align_audit_comments.py had
an off-by-one: it tested the indented code length against 31 instead of
against 35, so code texts of 28-31 characters were never padded into the
column.

The change is comments only.  The code text of all 8,538 lines is unchanged,
make still prints "Byte-identical ROM verified.", the 6,007 audit comments
still re-check against prg.bin, all 63 routine headers agree with the
instructions they describe, and every label agrees with reconstructed.lbl.
ReflectObjectYVelocity and UpdateSpecialObjectSystem moved out of locals.inc
and became labels in prg.s at their real addresses.

CHANGELOG.md becomes the repository's running log: a Pending list of the
changes to be put in the next commit, a History of the commits already made,
and the per-project milestone index at the end.  The next commit's message is
written from the Pending entries, so the two cannot drift apart.  PROMPTS.md
and AGENTS.md describe the new shape.  WIP.md drops the _wip/MAPPER8/ note:
the folder held a copy of Mermaids of Atlantis (U) that had already been
promoted.

World Class Track Meet (U): Pass 1, the code/data split

Pass 1 is done.  The split is 8,400 instructions / 18,028 code bytes (55.0 %)
of the 32 KB PRG, with 884 routine entries, 55 data blocks and 102 zero-page
aliases.  The PRG is CNROM (mapper 3) and maps whole at $8000-$FFFF, so the
linker moved the PRG segment from a .nes file offset to $8000 and the build
still compares byte identical.

Four dispatch tables had to be seeded by hand.  The event table at $F796 (5
entries) is read at $F780 and jumped to through `jmp ($001F)`.  The three
push-pointer tables - $BFC4 (16 entries), $BFE4 (2) and $E5F2 (7) - push a
handler address and `rts` into it, and the 6502's `rts` adds one to the
address it pops, so each table stores the entry address minus one; the seeds
are the table values plus one.  The tracer runs with --undocumented: the code
uses undocumented NMOS opcodes as ordinary code (ANC $37 at $BFF8, and the
RRA/RLA/SLO and NOP forms elsewhere).  Seeding the tables takes the coverage
from 27.8 % to 55.0 %.

$C0BE-$C0C5 is forced back to data: the IRQ vector $C0C0 points into the
middle of the `jmp $C047` at $C0BE, and the game never executes CLI, so the
vector is dead.  `make pass1` regenerates prg.s and locals.inc from prg.bin
and reproduces the committed prg.s byte for byte.

The project README records the split, the four dispatch tables, the dead IRQ
vector, the wrong CHR size field in the header, and what is still data.  The
milestone index in CHANGELOG.md gains the project; WIP.md, README.md and
AGENTS.md follow the tier counts and the layout.

nesdis.py gains a --mapping-note option, so the header's "PRG mapped at" line
can describe a board that is not NROM - CNROM's whole 32 KB at $8000-$FFFF is
not "mirrored to the upper half".

Replaces runs of $00 and $FF with .res <run>, <byte>

Golf (JU) and World Class Track Meet (U): Pass 2/3 complete, promoted from _wip/

- World Class Track Meet (U) - Pass 2 complete: all 884 Label_<addr>
  definitions replaced (651 semantic routine names + 233 Sub_<addr>), all 731
  raw $XXXX jsr/jmp call operands resolved to symbolic labels, all branch
  targets given role-based names; routinemap.tsv added; make stays
  byte-identical.
- World Class Track Meet (U) - Pass 3 complete: 24 semantic zero-page
  aliases applied via apply_symbols.py (0 residue), 78 neutral ZpXX slots
  documented with reasons in locals.inc, all hardware-register operands use
  symbols.inc names, project README rewritten with Pass 2/Pass 3 sections and
  data-table inventory; promoted out of _wip/CNROM/.
- World Class Track Meet (U) - project README documents the five event-table
  entries at $F796 and marks the olympics mode as not yet proven.
- Golf (JU) - audit comments converted from pre-canonical (; C000: A9 00)
  to the canonical ; CPU:$C000 PRG:0000  A9 00 form at column 35; 4,156
  comments re-aligned, comment/whitespace only, whole-ROM build stays
  byte-identical.
- Golf (JU) - 339 internal branch-target Label_ labels given role-based names
  via _tools/derive_branch_names.py; 0 raw $XXXX branch/jump operands remain.
- Golf (JU) - 275 zero-page operands substituted with locals.inc aliases via
  apply_symbols.py; 0 residue; promoted out of _wip/NROM/.
- Xevious (U) - runs of $FF padding replaced with .res <count>, $FF in prg.s;
  whole-ROM build stays byte-identical.
- Both projects promoted via git mv; leftover _wip/ folders removed; root
  README.md inventory rows added; WIP.md rows removed.

World Class Track Meet (U): apply zero-page symbol substitutions

Run apply_symbols.py to substitute ZpXX zero-page operands with
semantic locals.inc aliases (SlotState, GameMode, etc.) at proven
sites; 0 residue, whole-ROM build stays byte-identical.

Xevious (U): re-split Pass 1 from the Mesen CDL and decode the data tables

- Xevious (U) - Pass 1 re-split from the Mesen CDL (xevious_mesen.cdl) with
  _tools/cdl_reclass.py: 1,158 bytes data->code, 48 code->data, 42 labels
  emitted and 3 branch targets labelled; code 11,321->12,455 bytes
  (34.5%->38.0%), instructions 5,513->6,002. The 45 recovered entry points
  are named Sub_XXXX, so no Label_XXXX remains; six CDL-silent raw call
  operands are documented as residue.
- Xevious (U) - the 4,448-byte block at $A74B-$B8AA is split into six proven
  tables: VramWritePtrTable (15 pointers), VramWriteData, DataStreamPtrTable
  (16), ObjTilePtrTable (99), ObjTileData and DataStreamData. The $D833
  pointer table is corrected to base $D833 (4 entries; the old ObjCodePtrTable
  at $D834 was one byte late). $F957-$FAF5 is split into ObjSpeedTable,
  ObjSpeedTable2, SpriteLayoutPtrTable (19) and SpriteLayoutData;
  $FEE6-$FF1C into PaletteData and OamAttrTable. $F5D8 is decoded as
  TextTileData (font tile indices: PLAYER, GAME OVER, READY, SOLVALOU, LEFT,
  PAUSE); $F53C becomes AttrAddrTable, $F89E HandlerPtrTable and $EF3B
  SpriteLayoutData2. Project README rewritten with the corrected stats, a
  32-entry table inventory and the Pass 1 residue.
- _tools/cdl_reclass.py - preserve the data label(s) between a data-block
  header and its first .byte row when the block stays data; the $DF78 split
  dropped Data_DF78 and the rebuild failed with an undefined symbol.
- _tools/resolve_raw_branches.py - handle negative relative offsets
  (beq *-$0B); the pattern only matched *+$NN and *$NN.

Docs: refresh the tier counts to 41 promoted / 851 _wip, add the WCTM row

- Docs - tier counts refreshed to the post-promotion state across AGENTS.md,
  root README.md, WIP.md, TODO.md and CHANGELOG.md: 41 promoted projects
  (38 under NROM/, plus CNROM/World Class Track Meet (U), UNROM/Zanac (U) and
  MAPPER8/Mermaids of Atlantis (U)) and 851 _wip/ projects, every one of them
  a Pass 0 skeleton. The stale "39/40 promoted", "853 _wip", "Golf (JU) is
  still in _wip/" and "Golf is the last pre-canonical project" statements are
  corrected.
- Root README.md - the promoted inventory gained the missing World Class Track
  Meet (U) row (row 41, mapper 3, 32 KB PRG / 32 KB CHR), and the "All 38 are
  mapper 0 / 16 KB PRG" sentence is replaced with the actual split (36 of the
  41 rows are mapper 0 / 16 KB; Xevious and Volleyball are 32 KB, World Class
  Track Meet is mapper 3, Zanac mapper 2 and Mermaids mapper 8).
2026-10-21 11:36:32 -04:00
..
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00
2026-10-21 11:36:32 -04:00

Volleyball (U)

Status

Pass 3 complete. The project builds byte-identical to the original ROM and prg.s carries a full disassembly: every byte of the 32 KB PRG image is accounted for as either an instruction or an explicit .byte block, with the canonical audit comment on every line.

Byte-identical ROM verified.
Source prg.s (31,567 lines)
Instructions 11,395 (23,926 code bytes, 73.0 % of the PRG image)
Data blocks 37 (8,842 bytes)
Labels 1,989, all semantic (no Label_XXXX left)
Raw $XXXX call/branch operands 0
Raw $2000-$4017 hardware literals 0
Multi-alias residue (apply_symbols.py --report) 0
Neutral ZpXX zero-page references 135, over 29 bytes, each with a recorded reason in locals.inc

ROM

Property Value
Format iNES
Mapper 0
Board NROM-256
Mirroring Vertical
Four-screen VRAM no
Battery no
PRG 32 KB (2 x 16 KB), mapped at CPU $8000-$FFFF
CHR 8 KB (1 x 8 KB)
Trainer none
Footer none
NMI vector $8053
RESET vector $8000
IRQ vector $FFFF
ROM file Volleyball (U).nes
SHA-256 5c3baa82f28963fc258c238c82b628dedafdc1342d201721ced196437c983c4d

Header notes

  • Byte 6 is $01: mapper bits 0-3 are in the upper nybble, so the mapper is 0 and bit 0 selects vertical mirroring.
  • The IRQ vector is $FFFF, which is the last byte of the PRG image and therefore not a handler at all; the APU frame counter is never IRQ-enabled.

Power-on flow

RESET ($8000)

$8000  Reset
       A = $FF, $DF (NmiInProgress) = $FF, X = $FF, TXS  (stack at $01FF)
       PPUMASK = $00                       ; rendering off
$800B  WaitForVblankStart   LDA PPUSTATUS / BPL *-4   ; wait for bit 7 to set
$8010  WaitForVblankEnd     LDA PPUSTATUS / BPL *-4   ; wait for bit 7 to clear
$8015  JMP InitGameAndEnterMainLoop ($803E)

$8018-$803D is an unreachable block: it reads the PPU palette at $0178, compares it with $1B and spins forever if it matches - a TV-standard probe that no branch in the ROM ever reaches. The only instruction boundary inside it is $801A; $8018-$8019 ($3C $80) does not decode as an instruction. It is kept as .byte data with the note in the source.

Init ($803E)

$803E  InitGameAndEnterMainLoop
       JSR ClearGameRam ($845D)         ; wipe $0001-$00FF and $0300-$04FF
       JSR InitPpuForPowerOn ($8335)    ; APU/DMC off, PPUCTRL = $10
       $EB = $01, $DE = $00, $DF = $00
       JMP MainIdleLoop ($81B5)

Main loop ($81B5)

The main loop does almost nothing:

$81B5  MainIdleLoop
       $DF = 0                ; re-arm the NMI handler
       LDA $00 .. LDA $07     ; refresh eight zero-page bytes
       JMP $81B5

All of the game runs from the NMI handler. The loop only exists to give the CPU something to do between frames and to re-arm $DF.

NMI ($8053)

$8053  NmiHandler
       PHA
       LDA $DF            ; set while an NMI is being serviced
       BNE $81CC          ; a nested NMI is dropped: PLA / RTI
       INC $DF
       LDA $40            ; a VRAM update is pending?
       BNE $81FF          ; -> FlushVramUpdateScript, which ends in DEC $DF / PLA / RTI

The frame itself:

  1. INC $2D - the frame counter every other routine reads.
  2. Rendering is turned off ($19 loses bit 7, PPUMASK = $00).
  3. $84DF uploads the OAM shadow at $03FF, $8424 writes the queued attribute bytes.
  4. State-specific work: the state machine is dispatched further down, but $807A-$8115 runs the per-state extras first (the LDA $2B / CMP #$01..$08 chain, the whistle, the audience animation).
  5. $811E animates the crowd, $8132 updates the indicator board.
  6. $8315 writes the scroll and the nametable bits, LDA PPUSTATUS resets the PPU latch and EOR #$80 on the PPUCTRL shadow re-enables the NMI for the next frame; PPUMASK is written again to turn rendering on.
  7. $82F5 copies the freshly built OAM buffer to the PPU with OAMDMA, $82AC reads the controller of the player whose turn it is.
  8. The four-byte command block at $05C0-$05C3 is filled in.
  9. $85B1 DispatchGameState runs the active state.
  10. $C5EF draws the crowd, the sprite buffers at $0200/$0300 are cleared, PLA / RTI.

The state machine

The game state lives in $2B and the sub-state in $2C.

$85B1  DispatchGameState
       $25/$26 = $85E1              ; the dispatch table
       $28/$29 = $2B * 2            ; the index
       LDA ($25),Y / STA $04        ; the 16-bit entry
       LDA ($25),Y / STA $05
       LDX $2C                      ; the sub-state travels in X
       JMP ($0004)                  ; and off it goes

GameStateDispatchTable at $85E1 holds the eleven state handlers:

State Handler What it does
$00 StateTitleScreenInit clears the state, queues the intro VRAM script, loads the sprite tables, starts the match structures
$01 StateTitleScreen the "Volleys Ball" title screen; waits for START
$02 StateModeSelect the PLAY / SELECT screen: 1PLAYER/2PLAYER, WOMEN/MEN, and the ten nations
$03 StateModeSelectToMatch the fade to black between the menus and the court
$04 StateCourtSetup the teams walk on to the court
$05 StateRally the rally: the players move, the ball is simulated, points are scored
$06 StateNewPoint the break between two points
$07 StateTeamSelection picking the nations
$08 StateServeSetup placing the ball and starting the serve
$09 StateAttractDemo the attract demo, where the computer plays a whole match
$0A StateMatchResults the result of the match

Every handler is a switch on the sub-state in X, written as a chain of DEX / BEQ (or INX / DEX / BEQ, which is the same test). A case ends in one of:

Routine Effect
AdvanceSubState ($8600) INC $2C - the next phase of the same state
AdvanceGameState ($8603) $2C = 0, INC $2B - the next state
SetGameState ($860A) STA $2B, $2C = 0 - a state chosen by the code
DecrementStateTimer ($85F7) counts the 16-bit timer in $02/$03 down and advances the sub-state when it expires

The state flow was confirmed against the running ROM with a Mesen CE debugger: reading $2B/$2C every 50 ms while the attract demo plays gives $00/$06 -> $01/$01 -> $02/$00 -> $03/$01 -> $04/$01 -> $05/..., with $05 (the rally) and $08 (the serve) alternating.

Subsystems

Area Where What it does
VRAM updates $81FF, $8210, $8245 a byte-code interpreter that walks a script at ($41),Y; $AD means "copy N bytes", $AE means "the script is done"
Attribute writes $8424, $8440 the same idea for the attribute table, with the script in $0180
Controllers $82AC, $82C2 strobes $4016, shifts eight bits per player, and derives the newly-pressed mask
OAM $83D8, $82F5, $84DF the sprite list is built in $0200/$0300 and copied with OAMDMA
Drawing $C2A6..$CFAB the court, the players, the flags and the score board
The ball $9EB0..$C1E6 the sub-pixel position, the velocity, the spin and the bounce
The players $97F9..$B96E ten near-identical copies of the same movement routine, one per nation, indexed by $5C/$5D
Sound $F800..$FC7E the APU driver, the effect dispatcher and the music byte-code player; the note tables and programs are in $DC54..$FFF6

Pass 3 data-table inventory

Label Address Size Contents
UnreachedCode_8018 $8018 38 the unreachable TV-standard probe
UnreachedCode_8118 $8118 6 two unreachable JMP $811E tails
UnreachedCode_81CE $81CE 49 an unreachable copy of the VRAM flush routine
UnreachedCode_8253 $8253 22 an unreachable earlier controller read
UnreachedCode_8409 $8409 27 two unreachable VRAM helpers
PlayerSpriteTables $8511 160 five 32-byte sprite tables, one per player slot
GameStateDispatchTable $85E1 22 eleven 16-bit state handler addresses
UnreachedCode_8D52 $8D52 3 an unreachable JMP $8600 tail
UnreachedCode_8DFD $8DFD 12 four unreachable shared jump tails
UnreachedCode_8FFE $8FFE 3 the unreachable tail of the command stream decoder
ScoreDigitAddressTable $9252 16 eight 16-bit PPU addresses of the score digits
TeamNumberDelayTable $941A 12 twelve per-team delay values
BallHitTypeTable $C10F 6 hit-type data for the ball code
UnreachedCode_B5A0 $B5A0 7 an unreachable earlier copy of the ball-reset code
BallHitOffsetTable $B6B6 14 the ball rebound offsets
UnreachedCode_BFF7 $BFF7 7 an unreachable earlier copy of the ball-reset code
PlayerSpeedTable $CAD5 12 six 16-bit player movement speeds
PlayerSpeedTableCopy $CB4F 12 the same table for the other side of the court
NationCodeTable $CD78 64 the sprite code of each of the ten nations
DigitGlyphTable $D57B 80 the ten digit glyphs, 0..9
CrowdTileTable $D642 64 32 (tile, attribute) pairs for the spectators
SpriteTileTable $DAD9 96 48 four-byte OAM entries for the players, the ball and the umpire
BackgroundTilemapData $DB7E 36 nametable data for the court
NationNameTable $DC26 40 USA, URS, CHN, CUB, JPN, BRA, KOR, TUN, YOU, COM
MusicAndSoundData $DC54 6,778 the note tables, the tone tables and the music byte-code streams
MusicPulseTableStart $F6CE 9 the first pulse-channel note entries
MusicPulseTableEnd $F759 7 the last pulse-channel note entries
MusicPulseTable $F6D7 130 the pulse-channel note data
MusicPulseTableB $F760 160 the second half of the pulse-channel note data
NoisePeriodTable $F87F 32 the noise-channel period values
UnreachedCode_F84D $F84D 3 an unreachable JMP $F83F tail
UnreachedCode_F864 $F864 3 an unreachable JMP $F846 tail
CrowdNoisePatternTable $FAAC 24 the crowd-noise pattern
SoundEngineData $FC7F 461 the music player's note tables and byte-code program
SoundEngineDataC $FE4C 7 constants used by the music player
SoundEngineDataB $FE59 414 the second part of the music byte-code program
CpuVectors $FFFA 6 NMI $8053, RESET $8000, IRQ $FFFF

How the split was established

The static tracer finds 73 % of the PRG image on its own, but it cannot see code that is reached only through computed dispatch and it cannot tell inline data from an instruction that happens to decode from the same bytes. The Mesen Code Data Logger is the oracle for both.

  1. Pass 1 - _tools/nesdis.py --undocumented --auto-seed --table 85E1:11. The dispatch table has to be declared: the tracer cannot infer that $85E1 is a table of eleven entry points, and without it only 66 % of the image is traced.
  2. Reclassification - _tools/cdl_reclass.py rewrote the split to match a Code Data Logger capture taken while a random-input bot played the game for about twelve minutes (Mesen CE 2.2.1, the ROM at $8000-$FFFF). The capture saw 17,105 code bytes, 5,876 data bytes and left 9,787 bytes unobserved; the 9,787 are the unexecuted paths and the graphics, music and table data.
  3. Verification - _tools/cdl_check.py (added for this project) compares the finished prg.s against the CDL: every byte the CPU fetched as an opcode has to be covered by an instruction, and every byte the CPU read as data must not start one. Both counts are zero.
$ python3 _tools/cdl_check.py "_wip/NROM/Volleyball (U)/prg.s" vb.cdl 0x8000
CDL: code=17105 data=5876 unknown=9787
prg.s: 11395 instruction starts, 32768 bytes covered
CDL-Code bytes not covered by prg.s: 0
CDL-Data bytes that start an instruction in prg.s: 0

Open work

  • The ten copies of the per-nation player movement routine ($958C..$B96E) and the per-nation ball code ($97F9..$A8F2) are named after their position in the ROM (TeamPlayerMove0..TeamPlayerMove5, BallUpdateTeamA..BallUpdateTeamN). Which nation each copy belongs to has not been pinned down; the copies differ only in a few constants, so the mapping would need a per-copy behavioural trace.
  • BallHitOffsetTable and the speed tables hold values whose exact meaning is still inferred from the code around them.
  • The state names come from the screens the states draw; the naming of the sub-states inside each handler is the mechanically derived <Routine>_OnZero / <Routine>_Loop form.

Files

File Purpose
prg.s the disassembly
routinemap_hand.tsv the hand-written Pass 2 routine names (731 of them)
routinemap.tsv the same map after derive_branch_names.py added the 1,221 derived branch names
volleyball_mesen.cdl the Mesen Code Data Logger capture the split was checked against
locals.inc the semantic zero-page and RAM aliases
symbols.inc NES hardware register names
header.s / chr.s the other ROM segments, as ca65 includes
prg.bin / header.bin / chr.bin the binary splits
rom.nes a space-free copy of the original ROM, for cmp
linker.cfg the HEADER / PRG / CHR memory areas
Makefile build and byte-identity check